TabPane

Defined in: src/widgets/containers.ts:184

Represents a pane of either TabControl or Accordion

Extends

• DartWidget

Constructors

Constructor

new TabPane(dart): TabPane

Defined in: src/widgets/containers.ts:187

Creates TabPane from the Dart handle

Parameters

Parameter	Type
dart	any

Returns

TabPane

Overrides

DartWidget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	DartWidget._functions	src/widgets/base.ts:243
_properties	protected	Property[]	[]	-	DartWidget._properties	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	DartWidget._root	src/widgets/base.ts:241
dart	public	any	undefined	-	DartWidget.dart	src/widgets/base.ts:246
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	DartWidget.factory	src/widgets/base.ts:239
isDetached	public	boolean	false	-	DartWidget.isDetached	src/widgets/base.ts:247
props	public	any	undefined	-	DartWidget.props	src/widgets/base.ts:244
subs	public	Subscription[]	undefined	-	DartWidget.subs	src/widgets/base.ts:245
temp	public	any	undefined	Contains auxiliary information	DartWidget.temp	src/widgets/base.ts:236

Accessors

children

Get Signature

get children(): Widget<any>[]

Defined in: src/widgets/base.ts:320

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

DartWidget.children

---

content

Get Signature

get content(): HTMLDivElement

Defined in: src/widgets/containers.ts:202

Content

Returns

HTMLDivElement

---

expanded

Get Signature

get expanded(): boolean

Defined in: src/widgets/containers.ts:207

Whether the pane is expanded. Applicable to Accordion's panes only.

Returns

boolean

Set Signature

set expanded(v): void

Defined in: src/widgets/containers.ts:208

Parameters

Parameter	Type
v	boolean

Returns

void

---

header

Get Signature

get header(): HTMLDivElement

Defined in: src/widgets/containers.ts:197

A control shown on top of the pane

Returns

HTMLDivElement

---

name

Get Signature

get name(): string

Defined in: src/widgets/containers.ts:211

Tab pane name

Returns

string

Set Signature

set name(name): void

Defined in: src/widgets/containers.ts:212

Parameters

Parameter	Type
name	string

Returns

void

---

parent

Get Signature

get parent(): TabControl

Defined in: src/widgets/containers.ts:192

TabControl this pane belongs to

Returns

TabControl

Overrides

DartWidget.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: src/widgets/base.ts:398

Widget's visual root.

Returns

HTMLElement

Inherited from

DartWidget.root

---

type

Get Signature

get type(): string

Defined in: src/widgets/base.ts:397

Returns

string

Inherited from

DartWidget.type

Methods

apply()

apply(properties): Widget

Defined in: src/widgets/base.ts:284

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

DartWidget.apply

---

detach()

detach(): void

Defined in: src/widgets/base.ts:329

Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.

Returns

void

Inherited from

DartWidget.detach

---

getDartProperties()

getDartProperties(): any[]

Defined in: src/widgets/base.ts:305

Returns

any[]

Inherited from

DartWidget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: src/widgets/base.ts:400

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

DartWidget.getFunctions

---

getProperties()

getProperties(): Property[]

Defined in: src/widgets/base.ts:399

Returns all properties of this widget.

Returns

Property[]

Inherited from

DartWidget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: src/widgets/base.ts:401

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Inherited from

DartWidget.getWidgetStatus

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/widgets/base.ts:403

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Inherited from

DartWidget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: src/widgets/base.ts:311

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

DartWidget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: src/widgets/base.ts:303

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	Property | null	or null, if multiple properties were changed.

Returns

void

Inherited from

DartWidget.onPropertyChanged

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: src/widgets/base.ts:309

Returns

void

Inherited from

DartWidget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: src/widgets/base.ts:277

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

DartWidget.sub

---

toDart()

toDart(): any

Defined in: src/widgets/base.ts:269

Returns

any

Inherited from

DartWidget.toDart

---

find()

static find(root): Widget<any> | null

Defined in: src/widgets/base.ts:265

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

DartWidget.find

---

fromRoot()

static fromRoot(root): Widget

Defined in: src/widgets/base.ts:374

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

DartWidget.fromRoot

---

getAll()

static getAll(): Widget<any>[]

Defined in: src/widgets/base.ts:260

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget.getAll