PropertyGrid

Defined in: js-api/src/widgets/data-widgets.ts:177

JS wrapper for the widget implemented in Dart.

Extends

• DartWidget

Constructors

Constructor

new PropertyGrid(): PropertyGrid

Defined in: js-api/src/widgets/data-widgets.ts:179

Returns

PropertyGrid

Overrides

DartWidget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	DartWidget._functions	js-api/src/widgets/base.ts:277
_properties	protected	Property[]	[]	-	DartWidget._properties	js-api/src/widgets/base.ts:276
_root	protected	HTMLElement	undefined	-	DartWidget._root	js-api/src/widgets/base.ts:275
dart	public	any	undefined	-	DartWidget.dart	js-api/src/widgets/base.ts:280
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	DartWidget.factory	js-api/src/widgets/base.ts:273
isDetached	public	boolean	false	-	DartWidget.isDetached	js-api/src/widgets/base.ts:281
props	public	any	undefined	-	DartWidget.props	js-api/src/widgets/base.ts:278
subs	public	Subscription[]	undefined	-	DartWidget.subs	js-api/src/widgets/base.ts:279
temp	public	any	undefined	Contains auxiliary information	DartWidget.temp	js-api/src/widgets/base.ts:270

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: js-api/src/widgets/base.ts:451

AI briefing of the underlying Dart widget.

Returns

string | null

Set Signature

set aiDescription(x): void

Defined in: js-api/src/widgets/base.ts:456

A short AI-facing briefing: what this widget is, what its functions do, and how the assistant should approach it (e.g. which getFunctions entries to call first). Shown to the AI assistant as part of the workspace context.

Parameters

Parameter	Type
x	string | null

Returns

void

Inherited from

DartWidget.aiDescription

---

children

Get Signature

get children(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:362

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

DartWidget.children

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:359

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

DartWidget.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/widgets/base.ts:445

Widget's visual root.

Returns

HTMLElement

Inherited from

DartWidget.root

---

type

Get Signature

get type(): string

Defined in: js-api/src/widgets/base.ts:444

Returns

string

Inherited from

DartWidget.type

Methods

apply()

apply(properties): Widget

Defined in: js-api/src/widgets/base.ts:318

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

DartWidget.apply

---

detach()

detach(): void

Defined in: js-api/src/widgets/base.ts:371

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

---

getDartProperties()

getDartProperties(): any[]

Defined in: js-api/src/widgets/base.ts:347

Returns

any[]

Inherited from

DartWidget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: js-api/src/widgets/base.ts:447

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

Returns

Func[]

Inherited from

DartWidget.getFunctions

---

getProperties()

getProperties(): Property[]

Defined in: js-api/src/widgets/base.ts:446

Returns all properties of this widget.

Returns

Property[]

Inherited from

DartWidget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: js-api/src/widgets/base.ts:448

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

Returns

IWidgetStatus

Inherited from

DartWidget.getWidgetStatus

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: js-api/src/widgets/base.ts:462

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>

Inherited from

DartWidget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: js-api/src/widgets/base.ts:353

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

DartWidget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: js-api/src/widgets/base.ts:345

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Inherited from

DartWidget.onPropertyChanged

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: js-api/src/widgets/base.ts:351

Returns

void

Inherited from

DartWidget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: js-api/src/widgets/base.ts:311

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

DartWidget.sub

---

toDart()

toDart(): any

Defined in: js-api/src/widgets/base.ts:303

Returns

any

Inherited from

DartWidget.toDart

---

update()

update(src, props): void

Defined in: js-api/src/widgets/data-widgets.ts:183

Parameters

Parameter	Type
src	any
props	Property[]

Returns

void

---

find()

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

Defined in: js-api/src/widgets/base.ts:299

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

DartWidget.find

---

fromRoot()

static fromRoot(root): Widget

Defined in: js-api/src/widgets/base.ts:421

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

DartWidget.fromRoot

---

getAll()

static getAll(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:294

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget.getAll