--- layout: typedoc title: 'Viewer | @msrvida/sanddance' ---

Class Viewer

Component to view a SandDance data visualization.

Hierarchy

  • Viewer

Index

Constructors

constructor

Properties

colorContexts

colorContexts: ColorContext[]

Color contexts. There is only one color context until data is filtered, after which colors may be re-mapped in another color context.

currentColorContext

currentColorContext: number

Index of current color context. Change this and then call renderSameLayout().

element

element: HTMLElement

insight

insight: Insight

Insight object from current rendering.

options

options: ViewerOptions

Viewer options object.

presenter

presenter: Presenter

Presenter which does the rendering.

specCapabilities

specCapabilities: SpecCapabilities

Behavior specified by the visualization type.

vegaSpec

vegaSpec: Spec

Vega specification.

vegaViewGl

vegaViewGl: ViewGl_Class

Vega View instance.

Static defaultViewerOptions

defaultViewerOptions: ViewerOptions = ...

Default Viewer options.

Methods

activate

  • activate(datum: object): Promise<void>

deActivate

  • deActivate(): Promise<void>

deselect

  • deselect(): Promise<void>

filter

  • filter(search: Search, rebase?: boolean): Promise<void>

finalize

  • finalize(): void

getColumnStats

getInsight

getSelection

getSignalValues

render

renderSameLayout

  • renderSameLayout(newViewerOptions?: Partial<ViewerOptions>): void

reset

  • reset(): Promise<void>

select

  • select(search: Search): Promise<void>