JsViewer
Subclass JsViewer to implement a DataFrame-bound Datagrok viewer in JavaScript. See an example on github: https://github.com/datagrok-ai/public/tree/master/packages/Leaflet
Extends
Constructors
new JsViewer()
new JsViewer():
JsViewer
Returns
Overrides
Constructs
JsViewer
Source
Properties
Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
---|---|---|---|---|---|---|
_properties | protected | Property [] | undefined | - | Viewer ._properties | Viewer ._properties |
_root | protected | HTMLElement | undefined | - | Viewer ._root | Viewer ._root |
dart | public | any | undefined | - | Viewer .dart | Viewer .dart |
factory | public | null | Func | null | Constructor function. No parameters, returns [Widget]. | Viewer .factory | Viewer .factory |
filter | public | BitSet | ... | - | Viewer .filter | Viewer .filter |
formulaFilter | public | undefined | string | undefined | - | - | - |
isDetached | public | boolean | false | - | Viewer .isDetached | Viewer .isDetached |
obs | public | Observable <any >[] | undefined | - | - | - |
props | public | ObjectPropertyBag | undefined | - | Viewer .props | Viewer .props |
rowSource | public | undefined | string | undefined | - | - | - |
subs | public | Subscription [] | undefined | - | Viewer .subs | Viewer .subs |
tags | public | any | undefined | - | Viewer .tags | Viewer .tags |
temp | public | any | undefined | Contains auxiliary information | Viewer .temp | Viewer .temp |
Accessors
dataFrame
get
dataFrame():DataFrame
set
dataFrame(t
):void
Parameters
Parameter | Type |
---|---|
t | DataFrame |
Returns
Source
helpUrl
get
helpUrl():string
Help URL
set
helpUrl(s
):void
Parameters
Parameter | Type |
---|---|
s | string |
Returns
string
Source
meta
get
meta():ViewerMetaHelper
Returns
Source
onContextMenu
get
onContextMenu():Observable
<Menu
>
Returns
Observable
<Menu
>
Source
onDartPropertyChanged
get
onDartPropertyChanged():Observable
<null
>
Returns
Observable
<null
>
Source
onDataEvent
get
onDataEvent():Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Source
onDataRowClicked
get
onDataRowClicked():Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Source
onDataSelected
get
onDataSelected():Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Source
onPropertyValueChanged
get
onPropertyValueChanged():Observable
<EventData
<Property
>>
Returns
Observable
<EventData
<Property
>>
Source
onTooltipCreated
get
onTooltipCreated():Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Source
root
get
root():HTMLElement
Visual root.
set
root(r
):void
Parameters
Parameter | Type |
---|---|
r | HTMLElement |
Returns
HTMLElement
Source
table
get
table():DataFrame
Returns
Source
tableView
get
tableView():null
|TableView
Returns a view this viewer is associated with, or null
Returns
null
| TableView
Source
type
get
type():string
Returns viewer type (see VIEWER constants)
Returns
string
Source
view
get
view():null
|View
Returns a view this viewer is associated with, or null
Returns
null
| View
Source
Methods
_obs()
protected
_obs(observable
):Observable
<any
>
Parameters
Parameter | Type |
---|---|
observable | Observable <any > |
Returns
Observable
<any
>
Source
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
addRowSourceAndFormula()
addRowSourceAndFormula():
void
Returns
void
Source
apply()
apply(
properties
):Widget
<any
>
Parameters
Parameter | Type | Description |
---|---|---|
properties | object |
Returns
Widget
<any
>
Inherited from
Source
bool()
protected
bool(propertyName
,defaultValue
,options
):boolean
Registers a boolean property with the specified name and defaultValue
Parameters
Parameter | Type | Default value |
---|---|---|
propertyName | string | undefined |
defaultValue | null | boolean | null |
options | null | object & PropertyOptions | null |
Returns
boolean
Source
close()
close():
void
Closes and detaches the viewer.
Returns
void
Inherited from
Source
column()
protected
column(dataPropertyName
,options
):string
Returns the column bound to the specified data property. Note that "ColumnName" suffix (this determines whether this is a data property) should be omitted.
Parameters
Parameter | Type | Default value |
---|---|---|
dataPropertyName | string | undefined |
options | null | object & PropertyOptions | null |
Returns
string
Source
columnList()
protected
columnList(propertyName
,defaultValue
,options
):string
[]
Parameters
Parameter | Type | Default value |
---|---|---|
propertyName | string | undefined |
defaultValue | null | string [] | null |
options | null | object & PropertyOptions | null |
Returns
string
[]
Source
copyViewersLook()
copyViewersLook(
other
):void
Parameters
Parameter | Type |
---|---|
other | Viewer <any > |
Returns
void
Inherited from
Source
dateTime()
protected
dateTime(propertyName
,defaultValue
,options
):Dayjs
Registers a datetime property with the specified name and defaultValue
Parameters
Parameter | Type | Default value |
---|---|---|
propertyName | string | undefined |
defaultValue | null | Dayjs | null |
options | null | object & PropertyOptions | null |
Returns
Dayjs
Source
detach()
detach():
void
Gets called when this viewer is detached.
Returns
void
Overrides
Source
float()
protected
float(propertyName
,defaultValue
,options
):number
Registers a floating point property with the specified name and defaultValue
Parameters
Parameter | Type | Default value |
---|---|---|
propertyName | string | undefined |
defaultValue | null | number | null |
options | null | object & PropertyOptions | null |
Returns
number
Source
getDartProperties()
getDartProperties():
any
[]
Returns
any
[]
Inherited from
Source
getInfo()
getInfo():
object
Returns
object
Inherited from
Source
getOptions()
getOptions(
includeDefaults
):object
Gets the serialized viewer options. [includeDefaults] flag specifies whether the properties with the default values should be returned. Not including default properties makes it more clean and efficient for serialization purposes.
See also setOptions Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot
Parameters
Parameter | Type | Default value |
---|---|---|
includeDefaults | boolean | false |
Returns
object
Member | Type |
---|---|
id | string |
look | object |
type | string |
Inherited from
Source
getProperties()
getProperties():
Property
[]
Returns
Property
[]
Overrides
Source
getProperty()
getProperty(
name
):undefined
|Property
Gets property by name (case-sensitive).
Parameters
Parameter | Type | Description |
---|---|---|
name | string |
Returns
undefined
| Property
Source
initDartObject()
initDartObject(
dart
):void
Parameters
Parameter | Type |
---|---|
dart | any |
Returns
void
Inherited from
Source
int()
protected
int(propertyName
,defaultValue
,options
):number
Registers an integer property with the specified name and defaultValue
Parameters
Parameter | Type | Default value |
---|---|---|
propertyName | string | undefined |
defaultValue | null | number | null |
options | null | object & PropertyOptions | null |
Returns
number
Source
onEvent()
onEvent(
eventId
):Observable
<any
>
Observes platform events with the specified eventId.
Parameters
Parameter | Type | Default value |
---|---|---|
eventId | null | string | null |
Returns
Observable
<any
>
Inherited from
Source
onFrameAttached()
onFrameAttached(
dataFrame
):void
Parameters
Parameter | Type |
---|---|
dataFrame | DataFrame |
Returns
void
Overrides
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
Source
onSourceRowsChanged()
onSourceRowsChanged():
void
Returns
void
Source
onTableAttached()
onTableAttached():
void
Gets called when a table is attached to the viewer.
Returns
void
Source
registerCleanup()
protected
registerCleanup(cleanup
):void
cleanup() will get called when the viewer is disposed
Parameters
Parameter | Type |
---|---|
cleanup | Function |
Returns
void
Source
removeFromView()
removeFromView():
any
Returns
any
Inherited from
Source
setOptions()
setOptions(
map
):void
Sets viewer options. See also getOptions Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot
Parameters
Parameter | Type | Description |
---|---|---|
map | object | |
map.type ? | string | - |
Returns
void
Inherited from
Source
sourceRowsChanged()
sourceRowsChanged():
void
Returns
void
Overrides
Source
string()
protected
string(propertyName
,defaultValue
,options
):string
Registers a string property with the specified name and defaultValue
Parameters
Parameter | Type | Default value |
---|---|---|
propertyName | string | undefined |
defaultValue | null | string | null |
options | null | object & PropertyOptions | null |
Returns
string
Source
stringList()
protected
stringList(propertyName
,defaultValue
,options
):string
[]
Registers a string list property with the specified name and defaultValue
Parameters
Parameter | Type | Default value |
---|---|---|
propertyName | string | undefined |
defaultValue | null | string [] | null |
options | null | object & PropertyOptions | null |
Returns
string
[]
Source
sub()
sub(
subscription
):void
Registers a subscription to an external event.
Parameters
Parameter | Type | Description |
---|---|---|
subscription | Subscription |
Returns
void
Inherited from
Source
toCompactLook()
toCompactLook():
void
Returns
void
Inherited from
Source
toDart()
toDart():
any
Returns
any
Inherited from
Source
barChart()
static
barChart(t
,options
?):Viewer
<IBarChartSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IBarChartSettings > |
Returns
Inherited from
Source
boxPlot()
static
boxPlot(t
,options
?):Viewer
<IBoxPlotSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IBoxPlotSettings > |
Returns
Inherited from
Source
calendar()
static
calendar(t
,options
?):Viewer
<ICalendarSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <ICalendarSettings > |
Returns
Inherited from
Source
correlationPlot()
static
correlationPlot(t
,options
?):Viewer
<ICorrelationPlotSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <ICorrelationPlotSettings > |
Returns
Viewer
<ICorrelationPlotSettings
>
Inherited from
Source
densityPlot()
static
densityPlot(t
,options
?):Viewer
<IDensityPlotSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IDensityPlotSettings > |
Returns
Inherited from
Source
filters()
static
filters(t
,options
?):Viewer
<IFiltersSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IFiltersSettings > |
Returns
Inherited from
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
form()
static
form(t
,options
?):Viewer
<IFormSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IFormSettings > |
Returns
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
fromType()
static
fromType(viewerType
,table
,options
):Viewer
<any
>
Creates a new viewer of the specified type.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
viewerType | string | undefined | |
table | DataFrame | undefined | |
options | null | object | null |
Returns
Viewer
<any
>
Inherited from
Source
getAll()
static
getAll():Widget
<any
>[]
Returns all currently active widgets.
Returns
Widget
<any
>[]
Inherited from
Source
getViewerTypes()
static
getViewerTypes():string
[]
Returns
string
[]
Inherited from
Source
grid()
static
grid(t
,options
?):Grid
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IGridSettings > |
Returns
Inherited from
Source
heatMap()
static
heatMap(t
,options
?):Viewer
<IGridSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IGridSettings > |
Returns
Inherited from
Source
histogram()
static
histogram(t
,options
?):Viewer
<IHistogramSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IHistogramSettings > |
Returns
Inherited from
Source
lineChart()
static
lineChart(t
,options
?):Viewer
<ILineChartSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <ILineChartSettings > |
Returns
Inherited from
Source
markup()
static
markup(t
,options
?):Viewer
<IMarkupViewerSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IMarkupViewerSettings > |
Returns
Viewer
<IMarkupViewerSettings
>
Inherited from
Source
matrixPlot()
static
matrixPlot(t
,options
?):Viewer
<IMatrixPlotSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IMatrixPlotSettings > |
Returns
Inherited from
Source
network()
static
network(t
,options
?):Viewer
<INetworkDiagramSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <INetworkDiagramSettings > |
Returns
Viewer
<INetworkDiagramSettings
>
Inherited from
Source
pcPlot()
static
pcPlot(t
,options
?):Viewer
<IPcPlotSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IPcPlotSettings > |
Returns
Inherited from
Source
pieChart()
static
pieChart(t
,options
?):Viewer
<IPieChartSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IPieChartSettings > |
Returns
Inherited from
Source
scatterPlot()
static
scatterPlot(t
,options
?):ScatterPlotViewer
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IScatterPlotSettings > |
Returns
Inherited from
Source
scatterPlot3d()
static
scatterPlot3d(t
,options
?):Viewer
<IScatterPlot3dSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IScatterPlot3dSettings > |
Returns
Viewer
<IScatterPlot3dSettings
>
Inherited from
Source
statistics()
static
statistics(t
,options
?):Viewer
<IStatsViewerSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <IStatsViewerSettings > |
Returns
Inherited from
Source
tile()
static
tile(t
,options
?):Viewer
<ITileViewerSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <ITileViewerSettings > |
Returns
Inherited from
Source
treeMap()
static
treeMap(t
,options
?):Viewer
<ITreeMapSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <ITreeMapSettings > |
Returns
Inherited from
Source
trellisPlot()
static
trellisPlot(t
,options
?):Viewer
<ITrellisPlotSettings
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | Partial <ITrellisPlotSettings > |
Returns
Inherited from
Source
wordCloud()
static
wordCloud(t
,options
?):Viewer
<any
>
Parameters
Parameter | Type |
---|---|
t | DataFrame |
options ? | any |
Returns
Viewer
<any
>