Legend
Column legend for viewers
Extends
Constructors
new Legend()
new Legend(
dart
):Legend
Parameters
Parameter | Type |
---|---|
dart | any |
Returns
Overrides
Source
Properties
Property | Modifier | Type | Default value | Description | Inherited from |
---|---|---|---|---|---|
_properties | protected | Property [] | undefined | - | 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
column
get
column():Column
<any
>
Column for the legend
set
column(column
):void
Parameters
Parameter | Type |
---|---|
column | Column <any > |
Returns
Column
<any
>
Source
filterBy
get
filterBy():any
Returns
any
Source
onViewerLegendChanged
set
onViewerLegendChanged(handler
):void
Parameters
Parameter | Type |
---|---|
handler | Function |
Source
position
get
position():"left"
|"top"
|"bottom"
|"right"
Position (left / right / top / bottom)
set
position(pos
):void
Parameters
Parameter | Type |
---|---|
pos | "left" | "top" | "bottom" | "right" |
Returns
"left"
| "top"
| "bottom"
| "right"
Source
root
get
root():HTMLElement
Widget's visual root.
Returns
HTMLElement
Source
showNulls
get
showNulls():boolean
Whether to show empty categories
set
showNulls(show
):void
Parameters
Parameter | Type |
---|---|
show | boolean |
Returns
boolean
Source
type
get
type():string
Returns
string
Source
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" | "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 & PropertyOptions | null |
Returns
any
Inherited from
See
Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization
Source
apply()
apply(
properties
):Widget
<any
>
Parameters
Parameter | Type | Description |
---|---|---|
properties | object |
Returns
Widget
<any
>
Inherited from
Source
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
Source
getDartProperties()
getDartProperties():
any
[]
Returns
any
[]
Inherited from
DartWidget
. getDartProperties
Source
getProperties()
getProperties():
Property
[]
Returns
Property
[]
Inherited from
Source
onFrameAttached()
onFrameAttached(
dataFrame
):void
Parameters
Parameter | Type |
---|---|
dataFrame | DataFrame |
Returns
void
Inherited from
Source
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
sourceRowsChanged()
sourceRowsChanged():
void
Returns
void
Inherited from
DartWidget
. sourceRowsChanged
Source
sub()
sub(
subscription
):void
Registers a subscription to an external event.
Parameters
Parameter | Type | Description |
---|---|---|
subscription | Subscription |
Returns
void
Inherited from
Source
toDart()
toDart():
any
Returns
any
Inherited from
Source
create()
static
create(column
):Legend
Parameters
Parameter | Type |
---|---|
column | Column <any > |
Returns
Source
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
Source
fromRoot()
static
fromRoot(root
):Widget
<any
>
Creates a new widget from the root element.
Parameters
Parameter | Type |
---|---|
root | HTMLElement |
Returns
Widget
<any
>
Inherited from
Source
getAll()
static
getAll():Widget
<any
>[]
Returns all currently active widgets.
Returns
Widget
<any
>[]