ScatterPlotViewer
2D scatter plot
Extends
Constructors
new ScatterPlotViewer()
new ScatterPlotViewer(
dart
):ScatterPlotViewer
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 | IScatterPlotSettings & 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
canvas
get
canvas():HTMLCanvasElement
Returns
HTMLCanvasElement
Source
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
onAfterDrawScene
get
onAfterDrawScene():Observable
<null
>
Returns
Observable
<null
>
Source
onBeforeDrawScene
get
onBeforeDrawScene():Observable
<null
>
Returns
Observable
<null
>
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
onPointClicked
get
onPointClicked():Observable
<EventData
<RowDataArgs
>>
Returns
Observable
<EventData
<RowDataArgs
>>
Source
onPointDoubleClicked
get
onPointDoubleClicked():Observable
<EventData
<RowDataArgs
>>
Returns
Observable
<EventData
<RowDataArgs
>>
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
onViewportChanged
get
onViewportChanged():Observable
<Rect
>
Returns
Observable
<Rect
>
Source
onZoomed
get
onZoomed():Observable
<Rect
>
Returns
Observable
<Rect
>
Source
overlay
get
overlay():HTMLCanvasElement
Returns
HTMLCanvasElement
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
viewBox
get
viewBox():Rect
Returns
Source
viewport
get
viewport():Rect
set
viewport(viewport
):void
Parameters
Parameter | Type |
---|---|
viewport | Rect |
Returns
Source
xAxisBox
get
xAxisBox():Rect
Returns
Source
yAxisBox
get
yAxisBox():Rect
Returns
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
getMarkerSize()
getMarkerSize(
rowIdx
):number
Parameters
Parameter | Type |
---|---|
rowIdx | number |
Returns
number
Source
getMarkerType()
getMarkerType(
rowIdx
):string
Parameters
Parameter | Type |
---|---|
rowIdx | number |
Returns
string
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
getRowTooltip()
getRowTooltip(
rowIdx
):HTMLDivElement
Parameters
Parameter | Type |
---|---|
rowIdx | number |
Returns
HTMLDivElement
Source
hitTest()
hitTest(
x
,y
):number
Row hit test using canvas coords
Parameters
Parameter | Type |
---|---|
x | number |
y | number |
Returns
number
Source
initDartObject()
initDartObject(
dart
):void
Parameters
Parameter | Type |
---|---|
dart | any |
Returns
void
Inherited from
Source
invalidateCanvas()
invalidateCanvas():
void
Rerender plot
Returns
void
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
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
Source
pointToScreen()
pointToScreen(
index
):Point
Parameters
Parameter | Type |
---|---|
index | number |
Returns
Source
removeFromView()
removeFromView():
any
Returns
any
Inherited from
Source
render()
render(
g
):void
Parameters
Parameter | Type |
---|---|
g | CanvasRenderingContext2D |
Returns
void
Source
screenToWorld()
screenToWorld(
x
,y
):Point
Parameters
Parameter | Type |
---|---|
x | number |
y | number |
Returns
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
Inherited from
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
worldToScreen()
worldToScreen(
x
,y
):Point
Convert coords
Parameters
Parameter | Type |
---|---|
x | number |
y | number |
Returns
Source
zoom()
zoom(
x1
,y1
,x2
,y2
):void
Zoom using world coords
Parameters
Parameter | Type |
---|---|
x1 | number |
y1 | number |
x2 | number |
y2 | number |
Returns
void
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
>