Widget<TSettings>

Base class for controls that have a visual root and a set of properties.

Extended by

• ColumnGrid
• FuncCallEditor
• Filter
• DartWidget
• DropDown
• ViewBase
• Viewer
• SketcherBase
• Sketcher

Type parameters

Type parameter	Value
TSettings	any

Constructors

new Widget()

new Widget<TSettings>(widgetRoot): Widget<TSettings>

Parameters

Parameter	Type
widgetRoot	HTMLElement

Returns

Widget<TSettings>

Constructs

Widget and initializes its root.

Source

src/widgets.ts:223

Properties

Property	Modifier	Type	Default value	Description
_functions	protected	Func[]	[]	-
_properties	protected	Property[]	[]	-
_root	protected	HTMLElement	undefined	-
dart	public	any	undefined	-
factory	public	null | Func	null	Constructor function. No parameters, returns [Widget].
isDetached	public	boolean	false	-
props	public	TSettings & ObjectPropertyBag	undefined	-
subs	public	Subscription[]	undefined	-
temp	public	any	undefined	Contains auxiliary information

Accessors

children

get children(): Widget<any>[]

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Source

src/widgets.ts:293

---

parent

get parent(): null | Widget<any>

Parent widget up the DOM tree, or null.

Returns

null | Widget<any>

Source

src/widgets.ts:290

---

root

get root(): HTMLElement

Widget's visual root.

set root(r): void

Parameters

Parameter	Type
r	HTMLElement

Returns

HTMLElement

Source

src/widgets.ts:297

---

type

get type(): string

Returns

string

Source

src/widgets.ts:206

Methods

addProperty()

private addProperty(propertyName, propertyType, defaultValue, options): any

Registers an property with the specified type, name, and defaultValue.

Parameters

Parameter	Type	Default value	Description
propertyName	string	undefined
propertyType	"string" | "bigint" | "object" | "map" | "file" | "view" | "blob" | "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" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
defaultValue	any	null
options	null | object & IProperty	null

Returns

any

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

Source

src/widgets.ts:318

---

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
properties	object

Returns

Widget<any>

Source

src/widgets.ts:257

---

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

Source

src/widgets.ts:302

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Source

src/widgets.ts:278

---

getFunctions()

getFunctions(): Func[]

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

Returns

Func[]

Source

src/widgets.ts:272

---

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Source

src/widgets.ts:268

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Source

src/widgets.ts:284

---

onPropertyChanged()

onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Source

src/widgets.ts:276

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Source

src/widgets.ts:282

---

sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription

Returns

void

Source

src/widgets.ts:250

---

toDart()

toDart(): any

Returns

any

Source

src/widgets.ts:242

---

find()

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

null | Widget<any>

Source

src/widgets.ts:238

---

fromRoot()

static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget<any>

Source

src/widgets.ts:341

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Source

src/widgets.ts:233