Class: LineChartViewer

dg.LineChartViewer

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',
  });

Hierarchy

Viewer<ILineChartLookSettings>
↳ LineChartViewer

Constructors

constructor

• new LineChartViewer(dart)

Parameters

Name	Type
`dart`	`any`

Overrides

Viewer.constructor

Defined in

src/viewer.ts:504

Properties

_properties

• Protected _properties: Property[]

Inherited from

Viewer._properties

Defined in

src/widgets.ts:178

_root

• Protected _root: HTMLElement

Inherited from

Viewer._root

Defined in

src/widgets.ts:177

dart

• dart: any

Inherited from

Viewer.dart

Defined in

src/widgets.ts:181

factory

• factory: null | Func = null

Constructor function. No parameters, returns [Widget].

Inherited from

Viewer.factory

Defined in

src/widgets.ts:175

filter

• filter: BitSet

Inherited from

Viewer.filter

Defined in

src/viewer.ts:70

isDetached

• isDetached: boolean = false

subs

• subs: Subscription[]

Inherited from

Viewer.subs

Defined in

src/widgets.ts:180

temp

• temp: any

Contains auxiliary information

Inherited from

Viewer.temp

Defined in

src/widgets.ts:172

Accessors

activeFrame

• get activeFrame(): DataFrame

Returns

DataFrame

Defined in

src/viewer.ts:508

dataFrame

• get dataFrame(): DataFrame

Returns

DataFrame

Inherited from

Viewer.dataFrame

Defined in

src/viewer.ts:175

• set dataFrame(t): void

Parameters

Name	Type
`t`	`DataFrame`

Returns

void

Inherited from

Viewer.dataFrame

Defined in

src/viewer.ts:179

helpUrl

• get helpUrl(): string

Returns

string

Inherited from

Viewer.helpUrl

Defined in

src/viewer.ts:183

• set helpUrl(s): void

Parameters

Name	Type
`s`	`string`

Returns

void

Inherited from

Viewer.helpUrl

Defined in

src/viewer.ts:187

onContextMenu

• get onContextMenu(): Observable<Menu>

Returns

Observable<Menu>

Inherited from

Viewer.onContextMenu

Defined in

src/viewer.ts:284

onDartPropertyChanged

• get onDartPropertyChanged(): Observable<null>

Returns

Observable<null>

Inherited from

Viewer.onDartPropertyChanged

Defined in

src/viewer.ts:310

onDataEvent

• get onDataEvent(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataEvent

Defined in

src/viewer.ts:78

onDataHovered

• get onDataHovered(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataHovered

Defined in

src/viewer.ts:79

onDataRowClicked

• get onDataRowClicked(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataRowClicked

Defined in

src/viewer.ts:82

onDataSelected

• get onDataSelected(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataSelected

Defined in

src/viewer.ts:80

root

• get root(): HTMLElement

Visual root.

Returns

HTMLElement

Inherited from

Viewer.root

Defined in

src/viewer.ts:144

table

• get table(): DataFrame

Returns

DataFrame

Inherited from

Viewer.table

Defined in

src/viewer.ts:160

tableView

• get tableView(): null | TableView

Returns a view this viewer is associated with, or null

Returns

null | TableView

Inherited from

Viewer.tableView

Defined in

src/viewer.ts:170

type

• get type(): string

Returns viewer type (see VIEWER constants)

Returns

string

Inherited from

Viewer.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

Inherited from

Viewer.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

Viewer.addProperty

Defined in

src/widgets.ts:280

apply

▸ apply(properties): Widget<any>

Parameters

Name	Type
`properties`	`object`

Returns

Widget<any>

Inherited from

Viewer.apply

Defined in

src/widgets.ts:230

close

▸ close(): void

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close

Defined in

src/viewer.ts:138

copyViewersLook

▸ copyViewersLook(other): void

Parameters

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

Returns

void

Inherited from

Viewer.copyViewersLook

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

Viewer.detach

Defined in

src/widgets.ts:264

getDartProperties

▸ getDartProperties(): any[]

Returns

any[]

Inherited from

Viewer.getDartProperties

Defined in

src/widgets.ts:246

getInfo

▸ getInfo(): Object

Returns

Object

Inherited from

Viewer.getInfo

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.