JsViewer
Defined in: src/viewer.ts:421
Subclass JsViewer to implement a DataFrame-bound Datagrok viewer in JavaScript. See an example on github: https://github.com/datagrok-ai/labs/tree/master/packages/Leaflet
Extends
Constructors
Constructor
new JsViewer():
JsViewer
Defined in: src/viewer.ts:431
Returns
JsViewer
Constructs
JsViewer
Overrides
Properties
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|---|---|
_functions | protected | Func[] | [] | - | - | Viewer._functions | src/widgets/base.ts:243 |
_properties | protected | Property[] | [] | - | - | Viewer._properties | src/widgets/base.ts:242 |
_root | protected | HTMLElement | undefined | - | - | Viewer._root | src/widgets/base.ts:241 |
dart | public | any | undefined | - | Viewer.dart | - | src/viewer.ts:422 |
factory | public | Func | null | null | Constructor function. No parameters, returns [Widget]. | - | Viewer.factory | src/widgets/base.ts:239 |
formulaFilter | public | string | undefined | undefined | - | - | - | src/viewer.ts:428 |
isDetached | public | boolean | false | - | - | Viewer.isDetached | src/widgets/base.ts:247 |
obs | public | Observable<any>[] | undefined | - | - | - | src/viewer.ts:425 |
props | public | ObjectPropertyBag | undefined | - | Viewer.props | - | src/viewer.ts:426 |
rowSource | public | string | undefined | undefined | - | - | - | src/viewer.ts:427 |
subs | public | Subscription[] | undefined | - | Viewer.subs | - | src/viewer.ts:424 |
tags | public | any | undefined | - | - | Viewer.tags | src/viewer.ts:82 |
temp | public | any | undefined | Contains auxiliary information | - | Viewer.temp | src/widgets/base.ts:236 |
CORE_VIEWER_TYPES | static | string[] | undefined | - | - | Viewer.CORE_VIEWER_TYPES | src/viewer.ts:405 |
Accessors
aiDescription
Get Signature
get aiDescription():
string|null
Defined in: src/viewer.ts:109
AI briefing of the underlying Dart viewer.
Returns
string | null
Set Signature
set aiDescription(
x):void
Defined in: src/viewer.ts:114
A short AI-facing briefing: what this widget is, what its functions do, and how the assistant should approach it (e.g. which getFunctions entries to call first). Shown to the AI assistant as part of the workspace context.
Parameters
| Parameter | Type |
|---|---|
x | string | null |
Returns
void
Inherited from
children
Get Signature
get children():
Widget<any>[]
Defined in: src/widgets/base.ts:328
Parent widget up the DOM tree, or null.
Returns
Widget<any>[]
Inherited from
dataFrame
Get Signature
get dataFrame():
DataFrame
Defined in: src/viewer.ts:242
Returns
Set Signature
set dataFrame(
t):void
Defined in: src/viewer.ts:243
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
Returns
void
Inherited from
descriptor
Get Signature
get descriptor():
WidgetDescriptor
Defined in: src/viewer.ts:100
Descriptor of this widget.
Returns
Inherited from
filter
Get Signature
get filter():
BitSet
Defined in: src/viewer.ts:93
combined filter of the viewer
Returns
Set Signature
set filter(
f):void
Defined in: src/viewer.ts:96
Parameters
| Parameter | Type |
|---|---|
f | BitSet |
Returns
void
Inherited from
helpUrl
Get Signature
get helpUrl():
string
Defined in: src/viewer.ts:246
Help URL
Returns
string
Set Signature
set helpUrl(
s):void
Defined in: src/viewer.ts:247
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Inherited from
meta
Get Signature
get meta():
ViewerMetaHelper
Defined in: src/viewer.ts:215
Returns
Inherited from
onAfterDrawOverlay
Get Signature
get onAfterDrawOverlay():
Observable<EventData<any>>
Defined in: src/viewer.ts:142
Fires after rendering of the overlay canvas (interactive layer).
Returns
Observable<EventData<any>>
Inherited from
onAfterDrawScene
Get Signature
get onAfterDrawScene():
Observable<EventData<any>>
Defined in: src/viewer.ts:138
Fires after rendering of the main canvas.
Returns
Observable<EventData<any>>
Inherited from
onAfterLayout
Get Signature
get onAfterLayout():
Observable<EventData<any>>
Defined in: src/viewer.ts:134
Fires after the viewer completes a layout pass.
Returns
Observable<EventData<any>>
Inherited from
onBeforeDrawOverlay
Get Signature
get onBeforeDrawOverlay():
Observable<EventData<any>>
Defined in: src/viewer.ts:140
Fires before rendering of the overlay canvas (interactive layer).
Returns
Observable<EventData<any>>
Inherited from
onBeforeDrawScene
Get Signature
get onBeforeDrawScene():
Observable<EventData<any>>
Defined in: src/viewer.ts:136
Fires before rendering of the main canvas.
Returns
Observable<EventData<any>>
Inherited from
onContextMenu
Get Signature
get onContextMenu():
Observable<Menu>
Defined in: src/viewer.ts:350
Returns
Observable<Menu>
Inherited from
onDartPropertyChanged
Get Signature
get onDartPropertyChanged():
Observable<null>
Defined in: src/viewer.ts:376
Returns
Observable<null>
Inherited from
onDataEvent
Get Signature
get onDataEvent():
Observable<ViewerEvent>
Defined in: src/viewer.ts:122
Returns
Observable<ViewerEvent>
Inherited from
onDataFrameChanged
Get Signature
get onDataFrameChanged():
Observable<any>
Defined in: src/viewer.ts:130
Fires when the viewer's underlying DataFrame is replaced (table attached).
Returns
Observable<any>
Inherited from
onDataRowClicked
Get Signature
get onDataRowClicked():
Observable<ViewerEvent>
Defined in: src/viewer.ts:126
Returns
Observable<ViewerEvent>
Inherited from
onDataSelected
Get Signature
get onDataSelected():
Observable<ViewerEvent>
Defined in: src/viewer.ts:124
Returns
Observable<ViewerEvent>
Inherited from
onDetached
Get Signature
get onDetached():
Observable<any>
Defined in: src/viewer.ts:391
Occurs when viewer is detached.
Returns
Observable<any>
Inherited from
onPropertyValueChanged
Get Signature
get onPropertyValueChanged():
Observable<EventData<Property>>
Defined in: src/viewer.ts:127
Returns
Observable<EventData<Property>>
Inherited from
onResized
Get Signature
get onResized():
Observable<null>
Defined in: src/viewer.ts:132
Fires when the viewer is resized.
Returns
Observable<null>
Inherited from
onTooltipCreated
Get Signature
get onTooltipCreated():
Observable<ViewerEvent>
Defined in: src/viewer.ts:123
Returns
Observable<ViewerEvent>
Inherited from
onViewerRendered
Get Signature
get onViewerRendered():
Observable<EventData<any>>
Defined in: src/viewer.ts:144
Fires after the viewer is rendered.
Returns
Observable<EventData<any>>
Inherited from
parent
Get Signature
get parent():
Widget<any> |null
Defined in: src/widgets/base.ts:325
Parent widget up the DOM tree, or null.
Returns
Widget<any> | null
Inherited from
root
Get Signature
get root():
HTMLElement
Defined in: src/viewer.ts:465
Visual root.
Returns
HTMLElement
Set Signature
set root(
r):void
Defined in: src/viewer.ts:466
Visual root.
Parameters
| Parameter | Type |
|---|---|
r | HTMLElement |
Returns
void
Overrides
table
Get Signature
get table():
DataFrame
Defined in: src/viewer.ts:227
Returns
Inherited from
tableView
Get Signature
get tableView():
TableView|null
Defined in: src/viewer.ts:237
Returns a view this viewer is associated with, or null
Returns
TableView | null
Inherited from
type
Get Signature
get type():
string
Defined in: src/viewer.ts:223
Returns viewer type (see VIEWER constants)
Returns
string