Class Viewer
Hierarchy
- Viewer
Index
Constructors
Properties
Methods
Constructors
constructor
-
Instantiate a new Viewer.
Parameters
-
element: HTMLElement
Parent HTMLElement to present within.
-
Optional options: Partial<ViewerOptions>
Optional viewer options object.
Returns Viewer
-
Properties
colorContexts
Color contexts. There is only one color context until data is filtered, after which colors may be re-mapped in another color context.
currentColorContext
Index of current color context. Change this and then call renderSameLayout().
element
insight
Insight object for chart layout.
options
Viewer options object.
presenter
Presenter which does the rendering.
setup
Setup object for visual rendering of Insight.
specCapabilities
Behavior specified by the visualization type.
vegaSpec
Vega specification.
vegaViewGl
Vega View instance.
Static defaultViewerOptions
Default Viewer options.
Methods
activate
-
Set one data row to the active state.
Parameters
-
datum: object
Returns Promise<void>
-
assignTransitionStagger
-
Parameters
-
transition: Transition
Returns void
-
deActivate
-
Deactivate item.
Returns Promise<void>
deselect
-
Removes any selection.
Returns Promise<void>
filter
-
Filter the data and animate.
Parameters
-
search: Search
Filter expression, see https://vega.github.io/vega/docs/expressions/
-
rebase: boolean = false
Optional flag to apply to entire dataset. A false value will apply the filter upon any existing filter.
Returns Promise<void>
-
finalize
-
Returns void
getCamera
-
Gets the current camera.
Parameters
-
transitionFinal: boolean = false
Optional flag to get camera destination when transition completes.
Returns Camera
-
getColumnStats
-
Gets column stats from current data (filtered or all).
Parameters
-
column: Column
Column to get stats for.
Returns ColumnStats
-
getInsight
-
Gets the current insight with signal values.
Returns Insight
getSelection
-
Gets the current selection.
Returns SelectionState
getSignalValues
-
Gets current signal values.
Returns SignalValues
render
-
Render data into a visualization.
Parameters
-
insightSetup: InsightSetup
InsightSetup object to create a visualization rendering.
-
data: object[]
Array of data objects.
-
renderOptions: RenderOptions = {}
Optional RenderOptions object.
Returns Promise<RenderResult>
-
renderSameLayout
-
Render the same layout with new options.
Parameters
-
Optional newViewerOptions: Partial<ViewerOptions>
New options object.
Returns void
-
reset
-
Remove any filtration and animate.
Returns Promise<void>
select
-
Select cubes by a filter expression.
Parameters
-
search: Search
Filter expression, see https://vega.github.io/vega/docs/expressions/
Returns Promise<void>
-
setCamera
-
Sets the current camera.
Parameters
-
camera: Camera
Camera to set.
Returns void
-
Generated using TypeDoc
Component to view a SandDance data visualization.