Widget<TSettings>

Defined in: src/widgets/base.ts:231

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

Extended by

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

Type Parameters

Type Parameter	Default type
TSettings	any

Constructors

Constructor

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

Defined in: src/widgets/base.ts:250

Parameters

Parameter	Type
widgetRoot	HTMLElement

Returns

Widget<TSettings>

Constructs

Widget and initializes its root.

Properties

Property	Modifier	Type	Default value	Description	Defined in
_functions	protected	Func[]	[]	-	src/widgets/base.ts:243
_properties	protected	Property[]	[]	-	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	src/widgets/base.ts:241
dart	public	any	undefined	-	src/widgets/base.ts:246
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	src/widgets/base.ts:239
isDetached	public	boolean	false	-	src/widgets/base.ts:247
props	public	TSettings & ObjectPropertyBag	undefined	-	src/widgets/base.ts:244
subs	public	Subscription[]	undefined	-	src/widgets/base.ts:245
temp	public	any	undefined	Contains auxiliary information	src/widgets/base.ts:236

Accessors

children

Get Signature

get children(): Widget<any>[]

Defined in: src/widgets/base.ts:320

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: src/widgets/base.ts:317

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

---

root

Get Signature

get root(): HTMLElement

Defined in: src/widgets/base.ts:324

Widget's visual root.

Returns

HTMLElement

Set Signature

set root(r): void

Defined in: src/widgets/base.ts:325

Parameters

Parameter	Type
r	HTMLElement

Returns

void

---

type

Get Signature

get type(): string

Defined in: src/widgets/base.ts:233

Returns

string

Methods

apply()

apply(properties): Widget

Defined in: src/widgets/base.ts:284

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

---

detach()

detach(): void

Defined in: src/widgets/base.ts:329

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

---

getDartProperties()

getDartProperties(): any[]

Defined in: src/widgets/base.ts:305

Returns

any[]

---

getFunctions()

getFunctions(): Func[]

Defined in: src/widgets/base.ts:299

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

Returns

Func[]

---

getProperties()

getProperties(): Property[]

Defined in: src/widgets/base.ts:295

Returns all properties of this widget.

Returns

Property[]

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: src/widgets/base.ts:371

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/widgets/base.ts:368

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: src/widgets/base.ts:311

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: src/widgets/base.ts:303

Gets called when viewer's property is changed.

Parameters

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

Returns

void

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: src/widgets/base.ts:309

Returns

void

---

sub()

sub(subscription): void

Defined in: src/widgets/base.ts:277

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

---

toDart()

toDart(): any

Defined in: src/widgets/base.ts:269

Returns

any

---

find()

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

Defined in: src/widgets/base.ts:265

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

---

fromRoot()

static fromRoot(root): Widget

Defined in: src/widgets/base.ts:374

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

---

getAll()

static getAll(): Widget<any>[]

Defined in: src/widgets/base.ts:260

Returns all currently active widgets.

Returns

Widget<any>[]