Legend

Column legend for viewers

Extends

• DartWidget

Constructors

new Legend()

new Legend(dart): Legend

Parameters

Parameter	Type
dart	any

Returns

Legend

Overrides

DartWidget . constructor

Source

src/widgets.ts:1913

Properties

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

Accessors

children

get children(): Widget<any>[]

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Source

src/widgets.ts:293

---

column

get column(): Column<any, any>

Column for the legend

set column(column): void

Parameters

Parameter	Type
column	Column<any, any>

Returns

Column<any, any>

Source

src/widgets.ts:1922

---

isTooltipMode

get isTooltipMode(): boolean

Whether the legend is in tooltip (collapsed) mode.

Returns

boolean

Source

src/widgets.ts:1948

---

onViewerLegendChanged

set onViewerLegendChanged(handler): void

Parameters

Parameter	Type
handler	Function

Source

src/widgets.ts:1933

---

parent

get parent(): null | Widget<any>

Parent widget up the DOM tree, or null.

Returns

null | Widget<any>

Source

src/widgets.ts:290

---

position

get position(): "auto" | "left" | "top" | "bottom" | "right"

Position (left / right / top / bottom)

set position(pos): void

Parameters

Parameter	Type
pos	"auto" | "left" | "top" | "bottom" | "right"

Returns

"auto" | "left" | "top" | "bottom" | "right"

Source

src/widgets.ts:1930

---

root

get root(): HTMLElement

Widget's visual root.

Returns

HTMLElement

Source

src/widgets.ts:482

---

selectedCategories

get selectedCategories(): null | number[]

Mapped indices of filtered (selected) categories.

Returns

null | number[]

Source

src/widgets.ts:1938

---

selectedExtraCategories

get selectedExtraCategories(): null | number[]

Mapped indices of extra (selected) categories.

Returns

null | number[]

Source

src/widgets.ts:1943

---

showNulls

get showNulls(): boolean

Whether to show empty categories

set showNulls(show): void

Parameters

Parameter	Type
show	boolean

Returns

boolean

Source

src/widgets.ts:1926

---

type

get type(): string

Returns

string

Source

src/widgets.ts:481

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

Inherited from

DartWidget . addProperty

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>

Inherited from

DartWidget . apply

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

Inherited from

DartWidget . detach

Source

src/widgets.ts:302

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

DartWidget . getDartProperties

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[]

Inherited from

DartWidget . getFunctions

Source

src/widgets.ts:484

---

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Inherited from

DartWidget . getProperties

Source

src/widgets.ts:483

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

DartWidget . onFrameAttached

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

Inherited from

DartWidget . onPropertyChanged

Source

src/widgets.ts:276

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

DartWidget . sourceRowsChanged

Source

src/widgets.ts:282

---

sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription

Returns

void

Inherited from

DartWidget . sub

Source

src/widgets.ts:250

---

toDart()

toDart(): any

Returns

any

Inherited from

DartWidget . toDart

Source

src/widgets.ts:242

---

create()

static create(column): Legend

Parameters

Parameter	Type
column	Column<any, any>

Returns

Legend

Source

src/widgets.ts:1917

---

find()

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

null | Widget<any>

Inherited from

DartWidget . find

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>

Inherited from

DartWidget . fromRoot

Source

src/widgets.ts:341

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget . getAll

Source

src/widgets.ts:233