Class: TabControl

dg.TabControl

Tab control that hosts panes inside. See also TabPane

Constructors

constructor

• new TabControl(dart)

Parameters

Name	Type
dart	any

Defined in

src/widgets.ts:553

Properties

dart

• dart: any

Defined in

src/widgets.ts:552

Accessors

currentPane

• get currentPane(): TabPane

Currently visible pane

Returns

TabPane

Defined in

src/widgets.ts:594

• set currentPane(v): void

Parameters

Name	Type
v	TabPane

Returns

void

Defined in

src/widgets.ts:595

---

header

• get header(): HTMLDivElement

Header shown on top of the control

Returns

HTMLDivElement

Defined in

src/widgets.ts:568

---

onBeforeTabChanged

• get onBeforeTabChanged(): Observable<any>

Occurs before the active pane is changed

Returns

Observable<any>

Defined in

src/widgets.ts:598

---

onTabAdded

• get onTabAdded(): Observable<any>

Returns

Observable<any>

Defined in

src/widgets.ts:603

---

onTabChanged

• get onTabChanged(): Observable<any>

Occurs after the active pane is changed

Returns

Observable<any>

Defined in

src/widgets.ts:601

---

onTabRemoved

• get onTabRemoved(): Observable<any>

Returns

Observable<any>

Defined in

src/widgets.ts:604

---

panes

• get panes(): TabPane[]

Panes currently present in the pane control. Do not change the array, use addPane instead

Returns

TabPane[]

Defined in

src/widgets.ts:574

---

root

• get root(): HTMLDivElement

Visual root

Returns

HTMLDivElement

Defined in

src/widgets.ts:563

Methods

addPane

▸ addPane(name, getContent, icon?, options?): TabPane

Adds a new pane with the specified name

Parameters

Name	Type	Default value
name	string	undefined
getContent	() => HTMLElement	undefined
icon	any	null
options?	Object	undefined
options.allowClose	boolean	undefined

Returns

TabPane

Defined in

src/widgets.ts:584

---

clear

▸ clear(): void

Removes all panes

Returns

void

Defined in

src/widgets.ts:589

---

getPane

▸ getPane(name): TabPane

Gets the pane with the specified name

Parameters

Name	Type
name	string

Returns

TabPane

Defined in

src/widgets.ts:579

---

create

▸ Static create(vertical?): TabControl

Creates a new TabControl

Parameters

Name	Type	Default value
vertical	boolean	false

Returns

TabControl

Defined in

src/widgets.ts:558