Class: Widget<TSettings>
dg.Widget
Base class for controls that have a visual root and a set of properties.
Type parameters
| Name | Type |
|---|---|
TSettings | any |
Hierarchy
Constructors
constructor
• new Widget<TSettings>(widgetRoot)
Constructs
Widget and initializes its root.
Type parameters
| Name | Type |
|---|---|
TSettings | any |
Parameters
| Name | Type |
|---|---|
widgetRoot | HTMLElement |
Defined in
Properties
_properties
• Protected _properties: Property[]
Defined in
_root
• Protected _root: HTMLElement
Defined in
dart
• dart: any
Defined in
factory
• factory: null | Func = null
Constructor function. No parameters, returns [Widget].
Defined in
isDetached
• isDetached: boolean = false
Defined in
props
• props: TSettings & ObjectPropertyBag
Defined in
subs
• subs: Subscription[]
Defined in
temp
• temp: any
Contains auxiliary information
Defined in
Accessors
root
• get root(): HTMLElement
Widget's visual root.
Returns
HTMLElement
Defined in
• set root(r): void
Parameters
| Name | Type |
|---|---|
r | HTMLElement |
Returns
void
Defined in
type
• get type(): string
Returns
string
Defined in
Methods
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
Defined in
apply
▸ apply(properties): Widget<any>
Parameters
| Name | Type |
|---|---|
properties | object |
Returns
Widget<any>
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
Defined in
getDartProperties
▸ getDartProperties(): any[]
Returns
any[]
Defined in
getProperties
▸ getProperties(): Property[]
Returns
Property[]
Defined in
onFrameAttached
▸ onFrameAttached(dataFrame): void
Parameters
| Name | Type |
|---|---|
dataFrame | DataFrame |
Returns
void
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
Defined in
sourceRowsChanged
▸ sourceRowsChanged(): void
Returns
void
Defined in
sub
▸ sub(subscription): void
Registers a subscription to an external event.
Parameters
| Name | Type |
|---|---|
subscription | Subscription |
Returns
void
Defined in
toDart
▸ toDart(): any
Returns
any
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>
Defined in
fromRoot
▸ Static fromRoot(root): Widget<any>
Creates a new widget from the root element.
Parameters
| Name | Type |
|---|---|
root | HTMLElement |
Returns
Widget<any>
Defined in
getAll
▸ Static getAll(): Widget<any>[]
Returns all currently active widgets.
Returns
Widget<any>[]