Class: Accordion
dg.Accordion
Accordion control with collapsible/expandable panes. Samples: https://public.datagrok.ai/js/samples/ui/accordion
Hierarchy
↳
Accordion
Constructors
constructor
• new Accordion(dart)
Constructs
Accordion
Parameters
| Name | Type |
|---|---|
dart | any |
Overrides
Defined in
Properties
_properties
• Protected _properties: Property[]
Inherited from
Defined in
_root
• Protected _root: HTMLElement
Inherited from
Defined in
dart
• dart: any
Inherited from
Defined in
factory
• factory: null | Func = null
Constructor function. No parameters, returns [Widget].
Inherited from
Defined in
isDetached
• isDetached: boolean = false
Inherited from
Defined in
props
• props: any
Inherited from
Defined in
subs
• subs: Subscription[]
Inherited from
Defined in
temp
• temp: any
Contains auxiliary information
Inherited from
Defined in
Accessors
autoHideTabHeader
• get autoHideTabHeader(): boolean
Whether tab header should be hidden if there is only one tab
Returns
boolean
Defined in
• set autoHideTabHeader(x): void
Parameters
| Name | Type |
|---|---|
x | boolean |
Returns
void
Defined in
context
• get context(): any
An object this accordion is associated with
Returns
any
Defined in
• set context(x): void
Parameters
| Name | Type |
|---|---|
x | any |
Returns
void
Defined in
header
• get header(): HTMLElement
Header element on top of the accordion
Returns
HTMLElement
Defined in
• set header(header): void
Parameters
| Name | Type |
|---|---|
header | HTMLElement |
Returns
void
Defined in
panes
• get panes(): AccordionPane[]
Returns
Defined in
root
• get root(): HTMLElement
Widget's visual root.
Returns
HTMLElement
Inherited from
DartWidget.root
Defined in
type
• get type(): string
Returns
string
Inherited from
DartWidget.type
Defined in
Methods
addCountPane
▸ addCountPane(name, getContent, getCount, expanded?, before?): 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 |
Returns
Defined in
addPane
▸ addPane(name, getContent, expanded?, before?): AccordionPane
Adds a pane
Parameters
| Name | Type | Default value |
|---|---|---|
name | string | undefined |
getContent | () => HTMLElement | undefined |
expanded | boolean | false |
before | null | AccordionPane | null |
Returns
Defined in
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" | "view" | "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
Defined in
addTitle
▸ addTitle(element): void
Adds a title element.
Parameters
| Name | Type |
|---|---|
element | HTMLElement |
Returns
void
Defined in
apply
▸ apply(properties): Widget<any>
Parameters
| Name | Type |
|---|---|
properties | object |
Returns
Widget<any>
Inherited from
Defined in
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
Defined in
end
▸ end(): void
Finalizes accordion construction
Returns
void
Defined in
getDartProperties
▸ getDartProperties(): any[]
Returns
any[]
Inherited from
Defined in
getPane
▸ getPane(name): AccordionPane
Returns a pane with the specified name.
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Defined in
getProperties
▸ getProperties(): Property[]
Returns
Property[]
Inherited from
Defined in
onFrameAttached
▸ onFrameAttached(dataFrame): void
Parameters
| Name | Type |
|---|---|
dataFrame | DataFrame |
Returns
void
Inherited from
Defined in
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
Defined in
removePane
▸ removePane(pane): void
Removed the specified pane.
Parameters
| Name | Type |
|---|---|
pane | AccordionPane |
Returns
void
Defined in
sub
▸ sub(subscription): void
Registers a subscription to an external event.
Parameters
| Name | Type |
|---|---|
subscription | Subscription |
Returns
void
Inherited from
Defined in
toDart
▸ toDart(): any
Returns
any
Inherited from
Defined in
create
▸ Static create(key?): Accordion
Creates a new instance of Accordion
Parameters
| Name | Type | Default value |
|---|---|---|
key | any | null |
Returns
Defined in
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
Defined in
fromRoot
▸ Static fromRoot(root): Widget<any>
Creates a new widget from the root element.
Parameters
| Name | Type |
|---|---|
root | HTMLElement |
Returns
Widget<any>
Inherited from
Defined in
getAll
▸ Static getAll(): Widget<any>[]
Returns all currently active widgets.
Returns
Widget<any>[]