Class: FormViewer
dg.FormViewer
DataFrame-bound viewer that contains Form
Hierarchy
↳
FormViewer
Constructors
constructor
• new FormViewer(dart
)
Parameters
Name | Type |
---|---|
dart | any |
Overrides
Defined in
Properties
_properties
• Protected
_properties: Property
[]
Inherited from
Defined in
_root
• Protected
_root: HTMLElement
Inherited from
Defined in
dart
• dart: any
Inherited from
Defined in
factory
• factory: null
| Func
= null
Constructor function. No parameters, returns [Widget].
Inherited from
Defined in
filter
• filter: BitSet
Inherited from
Defined in
isDetached
• isDetached: boolean
= false
Inherited from
Defined in
props
• props: IFormLookSettings
& ObjectPropertyBag
Inherited from
Defined in
subs
• subs: Subscription
[]
Inherited from
Defined in
tags
• tags: any
Inherited from
Defined in
temp
• temp: any
Contains auxiliary information
Inherited from
Defined in
Accessors
dataFrame
• get
dataFrame(): DataFrame
Returns
Inherited from
Viewer.dataFrame
Defined in
• set
dataFrame(t
): void
Parameters
Name | Type |
---|---|
t | DataFrame |
Returns
void
Inherited from
Viewer.dataFrame
Defined in
designMode
• get
designMode(): boolean
Returns
boolean
Defined in
• set
designMode(x
): void
Parameters
Name | Type |
---|---|
x | boolean |
Returns
void
Defined in
editable
• get
editable(): boolean
Returns
boolean
Defined in
• set
editable(x
): void
Parameters
Name | Type |
---|---|
x | boolean |
Returns
void
Defined in
form
• get
form(): Form
Returns
Defined in
helpUrl
• get
helpUrl(): string
Returns
string
Inherited from
Viewer.helpUrl
Defined in
• set
helpUrl(s
): void
Parameters
Name | Type |
---|---|
s | string |
Returns
void
Inherited from
Viewer.helpUrl
Defined in
meta
• get
meta(): ViewerMetaHelper
Returns
Inherited from
Viewer.meta
Defined in
onContextMenu
• get
onContextMenu(): Observable
<Menu
>
Returns
Observable
<Menu
>
Inherited from
Viewer.onContextMenu
Defined in
onDartPropertyChanged
• get
onDartPropertyChanged(): Observable
<null
>
Returns
Observable
<null
>
Inherited from
Viewer.onDartPropertyChanged
Defined in
onDataEvent
• get
onDataEvent(): Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Inherited from
Viewer.onDataEvent
Defined in
onDataHovered
• get
onDataHovered(): Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Inherited from
Viewer.onDataHovered
Defined in
onDataRowClicked
• get
onDataRowClicked(): Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Inherited from
Viewer.onDataRowClicked
Defined in
onDataSelected
• get
onDataSelected(): Observable
<ViewerEvent
>
Returns
Observable
<ViewerEvent
>
Inherited from
Viewer.onDataSelected
Defined in
root
• get
root(): HTMLElement
Visual root.
Returns
HTMLElement
Inherited from
Viewer.root
Defined in
table
• get
table(): DataFrame
Returns
Inherited from
Viewer.table
Defined in
tableView
• get
tableView(): null
| TableView
Returns a view this viewer is associated with, or null
Returns
null
| TableView
Inherited from
Viewer.tableView
Defined in
type
• get
type(): string
Returns viewer type (see VIEWER constants)
Returns
string
Inherited from
Viewer.type
Defined in
view
• get
view(): null
| View
Returns a view this viewer is associated with, or null
Returns
null
| View
Inherited from
Viewer.view
Defined in
Methods
addProperty
▸ Private
addProperty(propertyName
, propertyType
, defaultValue?
, options?
): any
Registers an property with the specified type, name, and defaultValue. Registered property gets added to {@see properties}. Returns default value, thus allowing to combine registering a property with the initialization
Parameters
Name | Type | Default value |
---|---|---|
propertyName | string | undefined |
propertyType | "string" | "bigint" | "object" | "map" | "file" | "view" | "element" | "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" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook" | undefined |
defaultValue | any | null |
options | null | { [key: string] : any ; } & PropertyOptions | null |
Returns
any
Inherited from
Defined in
apply
▸ apply(properties
): Widget
<any
>
Parameters
Name | Type |
---|---|
properties | object |
Returns
Widget
<any
>
Inherited from
Defined in
close
▸ close(): void
Closes and detaches the viewer.
Returns
void
Inherited from
Defined in
copyViewersLook
▸ copyViewersLook(other
): void
Parameters
Name | Type |
---|---|
other | Viewer <any > |
Returns
void
Inherited from
Defined in
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
Defined in
getDartProperties
▸ getDartProperties(): any
[]
Returns
any
[]
Inherited from
Defined in
getInfo
▸ getInfo(): Object
Returns
Object
Inherited from
Defined in
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
Name | Type | Default value |
---|---|---|
includeDefaults | boolean | false |
Returns
Object
Name | Type |
---|---|
id | string |
look | { [key: string] : any ; } |
type | string |
Inherited from
Defined in
getProperties
▸ getProperties(): Property
[]
Returns
Property
[]
Inherited from
Defined in
initDartObject
▸ initDartObject(dart
): void
Parameters
Name | Type |
---|---|
dart | any |
Returns
void
Inherited from
Defined in
onEvent
▸ onEvent(eventId?
): Observable
<any
>
Observes platform events with the specified eventId.
Parameters
Name | Type | Default value |
---|---|---|
eventId | null | string | null |
Returns
Observable
<any
>
Inherited from
Defined in
onFrameAttached
▸ onFrameAttached(dataFrame
): void
Parameters
Name | Type |
---|---|
dataFrame | DataFrame |
Returns
void
Inherited from
Defined in
onPropertyChanged
▸ onPropertyChanged(property
): void
Gets called when viewer's property is changed.
Parameters
Name | Type | Description |
---|---|---|
property | null | Property | or null, if multiple properties were changed. |
Returns
void
Inherited from
Defined in
removeFromView
▸ removeFromView(): any
Returns
any
Inherited from
Defined in
setOptions
▸ setOptions(map
): void
Sets viewer options. See also getOptions Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot
Parameters
Name | Type |
---|---|
map | Object |
map.type? | string |
Returns
void
Inherited from
Defined in
sourceRowsChanged
▸ sourceRowsChanged(): void
Returns
void
Inherited from
Defined in
sub
▸ sub(subscription
): void
Registers a subscription to an external event.
Parameters
Name | Type |
---|---|
subscription | Subscription |
Returns
void
Inherited from
Defined in
toCompactLook
▸ toCompactLook(): void
Returns
void
Inherited from
Defined in
toDart
▸ toDart(): any
Returns
any
Inherited from
Defined in
barChart
▸ Static
barChart(t
, options?
): Viewer
<IBarChartLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
boxPlot
▸ Static
boxPlot(t
, options?
): Viewer
<IBoxPlotLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
calendar
▸ Static
calendar(t
, options?
): Viewer
<ICalendarLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
correlationPlot
▸ Static
correlationPlot(t
, options?
): Viewer
<ICorrelationPlotLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<ICorrelationPlotLookSettings
>
Inherited from
Defined in
createDefault
▸ Static
createDefault(df
, options?
): FormViewer
Creates a new default form for the specified columns.
Parameters
Name | Type |
---|---|
df | DataFrame |
options? | Object |
options.columns? | string [] |
Returns
Defined in
densityPlot
▸ Static
densityPlot(t
, options?
): Viewer
<IDensityPlotLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<IDensityPlotLookSettings
>
Inherited from
Defined in
filters
▸ Static
filters(t
, options?
): Viewer
<IFiltersLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
find
▸ Static
find(root
): null
| Widget
<any
>
Finds existing widget from its visual root.
Parameters
Name | Type |
---|---|
root | Element |
Returns
null
| Widget
<any
>
Inherited from
Defined in
form
▸ Static
form(t
, options?
): Viewer
<IFormLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
fromRoot
▸ Static
fromRoot(root
): Widget
<any
>
Creates a new widget from the root element.
Parameters
Name | Type |
---|---|
root | HTMLElement |
Returns
Widget
<any
>
Inherited from
Defined in
fromType
▸ Static
fromType(viewerType
, table
, options?
): Viewer
<any
>
Creates a new viewer of the specified type.
Parameters
Name | Type | Default value |
---|---|---|
viewerType | string | undefined |
table | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<any
>
Inherited from
Defined in
getAll
▸ Static
getAll(): Widget
<any
>[]
Returns all currently active widgets.
Returns
Widget
<any
>[]
Inherited from
Defined in
getViewerTypes
▸ Static
getViewerTypes(): string
[]
Returns
string
[]
Inherited from
Defined in
grid
▸ Static
grid(t
, options?
): Grid
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
heatMap
▸ Static
heatMap(t
, options?
): Viewer
<IGridLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
histogram
▸ Static
histogram(t
, options?
): Viewer
<IHistogramLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<IHistogramLookSettings
>
Inherited from
Defined in
lineChart
▸ Static
lineChart(t
, options?
): Viewer
<ILineChartLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<ILineChartLookSettings
>
Inherited from
Defined in
markup
▸ Static
markup(t
, options?
): Viewer
<IMarkupViewerLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<IMarkupViewerLookSettings
>
Inherited from
Defined in
matrixPlot
▸ Static
matrixPlot(t
, options?
): Viewer
<IMatrixPlotLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<IMatrixPlotLookSettings
>
Inherited from
Defined in
network
▸ Static
network(t
, options?
): Viewer
<INetworkDiagramLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<INetworkDiagramLookSettings
>
Inherited from
Defined in
pcPlot
▸ Static
pcPlot(t
, options?
): Viewer
<IPcPlotLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
pieChart
▸ Static
pieChart(t
, options?
): Viewer
<IPieChartLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
scatterPlot
▸ Static
scatterPlot(t
, options?
): ScatterPlotViewer
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
scatterPlot3d
▸ Static
scatterPlot3d(t
, options?
): Viewer
<IScatterPlot3dLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<IScatterPlot3dLookSettings
>
Inherited from
Defined in
statistics
▸ Static
statistics(t
, options?
): Viewer
<IStatsViewerLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<IStatsViewerLookSettings
>
Inherited from
Defined in
tile
▸ Static
tile(t
, options?
): Viewer
<ITileViewerLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<ITileViewerLookSettings
>
Inherited from
Defined in
treeMap
▸ Static
treeMap(t
, options?
): Viewer
<ITreeMapLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Inherited from
Defined in
trellisPlot
▸ Static
trellisPlot(t
, options?
): Viewer
<ITrellisPlotLookSettings
>
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<ITrellisPlotLookSettings
>
Inherited from
Defined in
wordCloud
▸ Static
wordCloud(t
, options?
): Viewer
<any
>
Deprecated
Parameters
Name | Type | Default value |
---|---|---|
t | DataFrame | undefined |
options | null | object | null |
Returns
Viewer
<any
>