Interface ViewerOptions

Customization options for the Viewer.

Hierarchy

SpecViewOptions
- ViewerOptions

Properties

Optional collapseFacetAxes

collapseFacetAxes: boolean

colors

colors: ColorSettings

Custom colors of various parts of the visualization.

Optional disableLasso

disableLasso: boolean

Disable lasso selection.

Optional filterRenderingTimerPadding

filterRenderingTimerPadding: number

Optional fontFamily

fontFamily: string

Font family of text elements.

language

language: Language

Language settings for the visualization.

maxLegends

maxLegends: number

Maximum number of rows in a legend.

Optional preserveDrawingBuffer

preserveDrawingBuffer: boolean

Optional flag to preserve the WebGL canvas.

selectionPolygonZ

selectionPolygonZ: number

Z value of selection polygons.

tickSize

tickSize: number

Optional tooltipOptions

tooltipOptions: TooltipOptions

Tooltip options

Optional zAxisOptions

zAxisOptions: ZAxisOptions

Methods

Optional getTextColor

getTextColor(t: VegaTextLayerDatum): RGBAColor

- Defined in sanddance/src/types.ts:117
Optional handler to get the color of text elements.

Parameters
- t: VegaTextLayerDatum
Returns RGBAColor

Optional getTextHighlightColor

getTextHighlightColor(t: VegaTextLayerDatum): RGBAColor

- Defined in sanddance/src/types.ts:122
Optional handler to get the highlight color of text elements.

Parameters
- t: VegaTextLayerDatum
Returns RGBAColor

Optional onAxisClick

onAxisClick(e: MouseEvent | PointerEvent | TouchEvent, search: SearchExpressionGroup<SearchExpression>): void

- Defined in sanddance/src/types.ts:132
Optional handler when axis is clicked.

Parameters
- e: MouseEvent | PointerEvent | TouchEvent
- search: SearchExpressionGroup<SearchExpression>
Returns void

Optional onBeforeCreateLayers

onBeforeCreateLayers(stage: Stage, specCapabilities: SpecCapabilities): void

- Defined in sanddance/src/types.ts:112
Optional handler to modify the stage prior to deck.gl layer construction.

Parameters
- stage: Stage
- specCapabilities: SpecCapabilities
Returns void

Optional onCanvasClick

onCanvasClick(e: MouseEvent | PointerEvent | TouchEvent): void

- Defined in sanddance/src/types.ts:137
Optional handler when empty canvas is clicked.

Parameters
- e: MouseEvent | PointerEvent | TouchEvent
Returns void

Optional onColorContextChange

onColorContextChange(): void

- Defined in sanddance/src/types.ts:87
Optional handler when color context changes.

Returns void

Optional onCubeClick

onCubeClick(e: MouseEvent | PointerEvent | TouchEvent, cube: Cube): void

- Defined in sanddance/src/types.ts:142
Optional handler when cube is clicked.

Parameters
- e: MouseEvent | PointerEvent | TouchEvent
- cube: Cube
Returns void

Optional onDataFilter

onDataFilter(filter: Search, filteredData: object[]): void

- Defined in sanddance/src/types.ts:92
Optional handler to be invoked when data is filtered.

Parameters
- filter: Search
- filteredData: object[]
Returns void

Optional onError

onError(errors: string[]): void

- Defined in sanddance/src/types.ts:82
Optional error handler.

Parameters
- errors: string[]
Returns void

Optional onLegendHeaderClick

onLegendHeaderClick(e: MouseEvent | PointerEvent | TouchEvent): void

- Defined in sanddance/src/types.ts:147
Optional handler when legend header is clicked.

Parameters
- e: MouseEvent | PointerEvent | TouchEvent
Returns void

Optional onLegendRowClick

onLegendRowClick(e: MouseEvent | PointerEvent | TouchEvent, legendRow: LegendRowWithSearch): void

- Defined in sanddance/src/types.ts:152
Optional handler when legend row is clicked.

Parameters
- e: MouseEvent | PointerEvent | TouchEvent
- legendRow: LegendRowWithSearch
Returns void

Optional onNewViewStateTarget

onNewViewStateTarget(): boolean

- Defined in sanddance/src/types.ts:162
Optional handler to reset the camera after chart is rendered.

Returns boolean

Optional onPresent

onPresent(): void

- Defined in sanddance/src/types.ts:107
Optional handler when chart is presented.

Returns void

Optional onSelectionChanged

onSelectionChanged(search: Search, activeIndex?: number, selectedData?: object[]): void

- Defined in sanddance/src/types.ts:97
Optional handler to be invoked when selection has changed.

Parameters
- search: Search
- Optional activeIndex: number
- Optional selectedData: object[]
Returns void

Optional onStage

onStage(stage: Stage): void

- Defined in sanddance/src/types.ts:102
Optional handler when data is on stage.

Parameters
- stage: Stage
Returns void

Optional onTextClick

onTextClick(e: MouseEvent | PointerEvent | TouchEvent, o: VegaTextLayerDatum): void

- Defined in sanddance/src/types.ts:127
Optional click handler for text elements.

Parameters
- e: MouseEvent | PointerEvent | TouchEvent
- o: VegaTextLayerDatum
Returns void

Optional onVegaSpec

onVegaSpec(vegaSpec: Spec): void

- Defined in sanddance/src/types.ts:157
Optional handler when Vega spec is created, prior to it being rendered.

Parameters
- vegaSpec: Spec
Returns void

Generated using TypeDoc

Hierarchy

Index

Properties

Methods

Properties

Optional collapseFacetAxes

colors

Optional disableLasso

Optional filterRenderingTimerPadding

Optional fontFamily

language

maxLegends

Optional preserveDrawingBuffer

selectionPolygonZ

tickSize

Optional tooltipOptions

Optional zAxisOptions

Methods

Optional getTextColor

Parameters

t: VegaTextLayerDatum

Returns RGBAColor

Optional getTextHighlightColor

Parameters

t: VegaTextLayerDatum

Returns RGBAColor

Optional onAxisClick

Parameters

e: MouseEvent | PointerEvent | TouchEvent

search: SearchExpressionGroup<SearchExpression>

Returns void

Optional onBeforeCreateLayers

Parameters

stage: Stage

specCapabilities: SpecCapabilities

Returns void

Optional onCanvasClick

Parameters

e: MouseEvent | PointerEvent | TouchEvent

Returns void

Optional onColorContextChange

Returns void

Optional onCubeClick

Parameters

e: MouseEvent | PointerEvent | TouchEvent

cube: Cube

Returns void

Optional onDataFilter

Parameters

filter: Search

filteredData: object[]

Returns void

Optional onError

Parameters

errors: string[]

Returns void

Optional onLegendHeaderClick

Parameters

e: MouseEvent | PointerEvent | TouchEvent

Returns void

Optional onLegendRowClick

Parameters

e: MouseEvent | PointerEvent | TouchEvent

legendRow: LegendRowWithSearch

Returns void

Optional onNewViewStateTarget

Returns boolean

Optional onPresent

Returns void

Optional onSelectionChanged

Parameters

search: Search

Optional activeIndex: number

Optional selectedData: object[]

Returns void

Optional onStage

Parameters

stage: Stage

Returns void

Optional onTextClick