Class: Viewer<TSettings>

dg.Viewer

Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers

Use Viewer to control the viewers. To develop a custom viewer, {@see JsViewer}.

Example

let view = grok.shell.addTableView(grok.data.demo.demog());
view.scatterPlot({
    x: 'height',
    y: 'weight',
    size: 'age',
    color: 'race',
  });

Type parameters

Name	Type
`TSettings`	`any`

Hierarchy

Widget<TSettings>
↳ Viewer
↳↳ FormViewer
↳↳ Grid
↳↳ JsViewer
↳↳ FilterGroup
↳↳ LineChartViewer
↳↳ ScatterPlotViewer

Constructors

constructor

• new Viewer<TSettings>(dart, root?)

Constructs

Viewer

Type parameters

Name	Type
`TSettings`	`any`

Parameters

Name	Type
`dart`	`any`
`root?`	`HTMLElement`

Overrides

Widget.constructor

Defined in

src/viewer.ts:73

Properties

_meta

• Private _meta: undefined | ViewerMetaHelper

Defined in

src/viewer.ts:69

_properties

• Protected _properties: Property[]

Inherited from

Widget._properties

Defined in

src/widgets.ts:178

_root

• Protected _root: HTMLElement

Inherited from

Widget._root

Defined in

src/widgets.ts:177

dart

• dart: any

Inherited from

Widget.dart

Defined in

src/widgets.ts:181

factory

• factory: null | Func = null

Constructor function. No parameters, returns [Widget].

Inherited from

Widget.factory

Defined in

src/widgets.ts:175

filter

• filter: BitSet

Defined in

src/viewer.ts:70

isDetached

• isDetached: boolean = false

Inherited from

Widget.isDetached

Defined in

src/widgets.ts:182

props

• props: TSettings & ObjectPropertyBag

Inherited from

Widget.props

Defined in

src/widgets.ts:179

subs

• subs: Subscription[]

Inherited from

Widget.subs

Defined in

src/widgets.ts:180

temp

• temp: any

Contains auxiliary information

Inherited from

Widget.temp

Defined in

src/widgets.ts:172

Accessors

dataFrame

• get dataFrame(): DataFrame

Returns

DataFrame

Defined in

src/viewer.ts:175

• set dataFrame(t): void

Parameters

Name	Type
`t`	`DataFrame`

Returns

void

Defined in

src/viewer.ts:179

helpUrl

• get helpUrl(): string

Returns

string

Defined in

src/viewer.ts:183

• set helpUrl(s): void

Parameters

Name	Type
`s`	`string`

Returns

void

Defined in

src/viewer.ts:187

onContextMenu

• get onContextMenu(): Observable<Menu>

Returns

Observable<Menu>

Defined in

src/viewer.ts:284

onDartPropertyChanged

• get onDartPropertyChanged(): Observable<null>

Returns

Observable<null>

Defined in

src/viewer.ts:310

onDataEvent

• get onDataEvent(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Defined in

src/viewer.ts:78

onDataHovered

• get onDataHovered(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Defined in

src/viewer.ts:79

onDataRowClicked

• get onDataRowClicked(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Defined in

src/viewer.ts:82

onDataSelected

• get onDataSelected(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Defined in

src/viewer.ts:80

root

• get root(): HTMLElement

Visual root.

Returns

HTMLElement

Overrides

Widget.root

Defined in

src/viewer.ts:144

table

• get table(): DataFrame

Returns

DataFrame

Defined in

src/viewer.ts:160

tableView

• get tableView(): null | TableView

Returns a view this viewer is associated with, or null

Returns

null | TableView

Defined in

src/viewer.ts:170

type

• get type(): string

Returns viewer type (see VIEWER constants)

Returns

string

Overrides

Widget.type

Defined in

src/viewer.ts:156

view

• get view(): null | View

Returns a view this viewer is associated with, or null

Returns

null | View

Defined in

src/viewer.ts:165

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

Widget.addProperty

Defined in

src/widgets.ts:280

apply

▸ apply(properties): Widget<any>

Parameters

Name	Type
`properties`	`object`

close

▸ close(): void

Closes and detaches the viewer.

Returns

void

Defined in

src/viewer.ts:138

copyViewersLook

▸ copyViewersLook(other): void

Parameters

Name	Type
`other`	`Viewer`<`any`>

Returns

void

Defined in

src/viewer.ts:324

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

Widget.detach

Defined in

src/widgets.ts:264

getDartProperties

▸ getDartProperties(): any[]

Returns

any[]

Inherited from

Widget.getDartProperties

Defined in

src/widgets.ts:246

getInfo

▸ getInfo(): Object

Returns

Object

Defined in

src/viewer.ts:129

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.