WidgetDescriptor

Defined in: js-api/src/viewer.ts:38

Provides metadata about the widget (such as name, description, available events and properties) without having to instantiate it. Used for command palettes, AI, etc

Constructors

Constructor

new WidgetDescriptor(dart): WidgetDescriptor

Defined in: js-api/src/viewer.ts:43

Creates a widget descriptors from the Dart instance. Do not call directly.

Parameters

Parameter	Type
dart	any

Returns

WidgetDescriptor

Properties

Property	Type	Defined in
_props?	Property[]	js-api/src/viewer.ts:40
dart	any	js-api/src/viewer.ts:39

Accessors

description

Get Signature

get description(): string

Defined in: js-api/src/viewer.ts:60

Widget description

Returns

string

---

events

Get Signature

get events(): EventType[]

Defined in: js-api/src/viewer.ts:66

Events fired by this widget.

Returns

EventType[]

---

name

Get Signature

get name(): string

Defined in: js-api/src/viewer.ts:54

Widget name. Save as Viewer.type

Returns

string

---

properties

Get Signature

get properties(): Property[]

Defined in: js-api/src/viewer.ts:63

Widget properties

Returns

Property[]

---

synonyms

Get Signature

get synonyms(): string[]

Defined in: js-api/src/viewer.ts:57

Widget synonyms (mostly used for AI)

Returns

string[]

Methods

createIcon()

createIcon(): Element

Defined in: js-api/src/viewer.ts:69

Creates an icon for that widget.

Returns

Element

---

getByName()

static getByName(name): WidgetDescriptor | null

Defined in: js-api/src/viewer.ts:51

Returns the descriptor with the specified name.

Parameters

Parameter	Type
name	string

Returns

WidgetDescriptor | null

---

getDescriptors()

static getDescriptors(): WidgetDescriptor[]

Defined in: js-api/src/viewer.ts:48

Returns all registered widget descriptors.

Returns

WidgetDescriptor[]