Class: Accordion

dg.Accordion

Accordion control with collapsible/expandable panes. Samples: https://public.datagrok.ai/js/samples/ui/accordion

Hierarchy

• DartWidget

  ↳ Accordion

Constructors

constructor

• new Accordion(dart)

Constructs

Accordion

Parameters

Name	Type
dart	any

Overrides

DartWidget.constructor

Defined in

src/widgets.ts:454

Properties

_properties

• Protected _properties: Property[]

Inherited from

DartWidget._properties

Defined in

src/widgets.ts:178

---

_root

• Protected _root: HTMLElement

Inherited from

DartWidget._root

Defined in

src/widgets.ts:177

---

dart

• dart: any

Inherited from

DartWidget.dart

Defined in

src/widgets.ts:181

---

factory

• factory: null | Func = null

Constructor function. No parameters, returns [Widget].

Inherited from

DartWidget.factory

Defined in

src/widgets.ts:175

---

isDetached

• isDetached: boolean = false

Inherited from

DartWidget.isDetached

Defined in

src/widgets.ts:182

---

props

• props: any

Inherited from

DartWidget.props

Defined in

src/widgets.ts:179

---

subs

• subs: Subscription[]

Inherited from

DartWidget.subs

Defined in

src/widgets.ts:180

---

temp

• temp: any

Contains auxiliary information

Inherited from

DartWidget.temp

Defined in

src/widgets.ts:172

Accessors

autoHideTabHeader

• get autoHideTabHeader(): boolean

Whether tab header should be hidden if there is only one tab

Returns

boolean

Defined in

src/widgets.ts:481

• set autoHideTabHeader(x): void

Parameters

Name	Type
x	boolean

Returns

void

Defined in

src/widgets.ts:482

---

context

• get context(): any

An object this accordion is associated with

Returns

any

Defined in

src/widgets.ts:459

• set context(x): void

Parameters

Name	Type
x	any

Returns

void

Defined in

src/widgets.ts:462

---

header

• get header(): HTMLElement

Header element on top of the accordion

Returns

HTMLElement

Defined in

src/widgets.ts:477

• set header(header): void

Parameters

Name	Type
header	HTMLElement

Returns

void

Defined in

src/widgets.ts:478

---

panes

• get panes(): AccordionPane[]

Returns

AccordionPane[]

Defined in

src/widgets.ts:472

---

root

• get root(): HTMLElement

Widget's visual root.

Returns

HTMLElement

Inherited from

DartWidget.root

Defined in

src/widgets.ts:437

---

type

• get type(): string

Returns

string

Inherited from

DartWidget.type

Defined in

src/widgets.ts:433

Methods

addCountPane

▸ addCountPane(name, getContent, getCount, expanded?, before?, allowDragOut?): AccordionPane

Adds a pane with the count indicator next to the title. getCount() is executed immediately.

Parameters

Name	Type	Default value
name	string	undefined
getContent	() => HTMLElement	undefined
getCount	() => number	undefined
expanded	boolean	false
before	null | AccordionPane	null
allowDragOut	boolean	true

Returns

AccordionPane

Defined in

src/widgets.ts:504

---

addPane

▸ addPane(name, getContent, expanded?, before?, allowDragOut?): AccordionPane

Adds a pane

Parameters

Name	Type	Default value
name	string	undefined
getContent	() => HTMLElement	undefined
expanded	boolean	false
before	null | AccordionPane	null
allowDragOut	boolean	true

Returns

AccordionPane

Defined in

src/widgets.ts:497

---

addProperty

▸ Private addProperty(propertyName, propertyType, defaultValue?, options?): any

Registers an property with the specified type, name, and defaultValue. Registered property gets added to {@see properties}. Returns default value, thus allowing to combine registering a property with the initialization

Parameters

Name	Type	Default value
propertyName	string	undefined
propertyType	"string" | "bigint" | "object" | "map" | "file" | "view" | "element" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
defaultValue	any	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

any

Inherited from

DartWidget.addProperty

Defined in

src/widgets.ts:280

---

addTitle

▸ addTitle(element): void

Adds a title element.

Parameters

Name	Type
element	HTMLElement

Returns

void

Defined in

src/widgets.ts:492

---

apply

▸ apply(properties): Widget<any>

Parameters

Name	Type
properties	object

Returns

Widget<any>

Inherited from

DartWidget.apply

Defined in

src/widgets.ts:230

---

detach

▸ detach(): void

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

Defined in

src/widgets.ts:264

---

end

▸ end(): void

Finalizes accordion construction

Returns

void

Defined in

src/widgets.ts:515

---

getDartProperties

▸ getDartProperties(): any[]

Returns

any[]

Inherited from

DartWidget.getDartProperties

Defined in

src/widgets.ts:246

---

getPane

▸ getPane(name): AccordionPane

Returns a pane with the specified name.

Parameters

Name	Type
name	string

Returns

AccordionPane

Defined in

src/widgets.ts:487

---

getProperties

▸ getProperties(): Property[]

Returns

Property[]

Inherited from

DartWidget.getProperties

Defined in

src/widgets.ts:441

---

onFrameAttached

▸ onFrameAttached(dataFrame): void

Parameters

Name	Type
dataFrame	DataFrame

Returns

void

Inherited from

DartWidget.onFrameAttached

Defined in

src/widgets.ts:252

---

onPropertyChanged

▸ onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Inherited from

DartWidget.onPropertyChanged

Defined in

src/widgets.ts:244

---

removePane

▸ removePane(pane): void

Removed the specified pane.

Parameters

Name	Type
pane	AccordionPane

Returns

void

Defined in

src/widgets.ts:510

---

sourceRowsChanged

▸ sourceRowsChanged(): void

Returns

void

Inherited from

DartWidget.sourceRowsChanged

Defined in

src/widgets.ts:250

---

sub

▸ sub(subscription): void

Registers a subscription to an external event.

Parameters

Name	Type
subscription	Subscription

Returns

void

Inherited from

DartWidget.sub

Defined in

src/widgets.ts:223

---

toDart

▸ toDart(): any

Returns

any

Inherited from

DartWidget.toDart

Defined in

src/widgets.ts:215

---

create

▸ Static create(key?): Accordion

Creates a new instance of Accordion

Parameters

Name	Type	Default value
key	any	null

Returns

Accordion

Defined in

src/widgets.ts:467

---

find

▸ Static find(root): null | Widget<any>

Finds existing widget from its visual root.

Parameters

Name	Type
root	Element

Returns

null | Widget<any>

Inherited from

DartWidget.find

Defined in

src/widgets.ts:211

---

fromRoot

▸ Static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Name	Type
root	HTMLElement

Returns

Widget<any>

Inherited from

DartWidget.fromRoot

Defined in

src/widgets.ts:303

---

getAll

▸ Static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget.getAll

Defined in

src/widgets.ts:206