BarChartViewer
Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers
See
Use Viewer to control the viewers. To develop a custom viewer, JsViewer.
Example
let view = grok.shell.addTableView(grok.data.demo.demog());
view.scatterPlot({
x: 'height',
y: 'weight',
size: 'age',
color: 'race',
});
Extends
Constructors
new BarChartViewer()
new BarChartViewer(
dart
):BarChartViewer
Parameters
Parameter | Type |
---|---|
dart | any |
Returns
Overrides
Source
Properties
Property | Modifier | Type | Default value | Description | Inherited from |
---|---|---|---|---|---|
_properties | protected | Property [] | undefined | - | Viewer ._properties |
_root | protected | HTMLElement | undefined | - | Viewer ._root |
dart | public | any | undefined | - | Viewer .dart |
factory | public | null | Func | null | Constructor function. No parameters, returns [Widget]. | Viewer .factory |
filter | public | BitSet | ... | - | Viewer .filter |
isDetached | public | boolean | false | - | Viewer .isDetached |
props | public | IBarChartSettings & ObjectPropertyBag | undefined | - | Viewer .props |
subs | public | Subscription [] | undefined | - | Viewer .subs |
tags | public | any | undefined | - | Viewer .tags |
temp | public | any | undefined | Contains auxiliary information | 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
onCategoryClicked
get
onCategoryClicked():Observable
<EventData
<CategoryDataArgs
>>
Returns
Observable
<EventData
<CategoryDataArgs
>>
Source
onCategoryHovered
get
onCategoryHovered():Observable
<EventData
<CategoryDataArgs
>>
Returns
Observable
<EventData
<CategoryDataArgs
>>
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
onResetView
get
onResetView():Observable
<null
>
Returns
Observable
<null
>
Source
onTooltipCreated
get
onTooltipCreated():Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Source
root
get
root():HTMLElement
Visual root.
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
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
close()
close():
void
Closes and detaches the viewer.
Returns
void
Inherited from
Source
copyViewersLook()
copyViewersLook(
other
):void
Parameters
Parameter | Type |
---|---|
other | Viewer <any > |
Returns
void
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
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
[]
Inherited from
Source
initDartObject()
initDartObject(
dart
):void
Parameters
Parameter | Type |
---|---|
dart | any |
Returns
void
Inherited from
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 |