---
layout: typedoc
title: 'ViewerOptions | @msrvida/sanddance-explorer'
---
Properties
Optional fontFamily
fontFamily: string
maxLegends
maxLegends: number
Optional preserveDrawingBuffer
preserveDrawingBuffer: boolean
selectionPolygonZ
selectionPolygonZ: number
tickSize
tickSize: number
Optional tooltipOptions
transitionDurations
Methods
Optional getTextColor
-
Parameters
Optional getTextHighlightAlphaCutoff
- getTextHighlightAlphaCutoff(): number
-
Returns number
Optional getTextHighlightColor
-
Parameters
Optional onAxisClick
-
Parameters
-
e: MouseEvent | PointerEvent | TouchEvent
-
Returns void
Optional onBeforeCreateLayers
-
Parameters
Returns void
Optional onColorContextChange
- onColorContextChange(): void
-
Returns void
Optional onCubeClick
- onCubeClick(e: MouseEvent | PointerEvent | TouchEvent, cube: Cube): void
-
Parameters
-
e: MouseEvent | PointerEvent | TouchEvent
-
Returns void
Optional onDataFilter
- onDataFilter(filter: Search, filteredData: object[]): void
-
Parameters
Returns void
Optional onError
- onError(errors: string[]): void
-
Parameters
Returns void
Optional onLegendHeaderClick
- onLegendHeaderClick(e: MouseEvent | PointerEvent | TouchEvent): void
-
Parameters
-
e: MouseEvent | PointerEvent | TouchEvent
Returns void
Optional onLegendRowClick
- onLegendRowClick(e: MouseEvent | PointerEvent | TouchEvent, legendRow: LegendRowWithSearch): void
-
Parameters
-
e: MouseEvent | PointerEvent | TouchEvent
-
Returns void
Optional onNewViewStateTarget
- onNewViewStateTarget(): boolean
-
Returns boolean
Optional onPresent
-
Returns void
Optional onSelectionChanged
- onSelectionChanged(search: Search, activeIndex?: number, selectedData?: object[]): void
-
Parameters
-
-
Optional activeIndex: number
-
Optional selectedData: object[]
Returns void
Optional onStage
- onStage(stage: Stage, deckProps: Partial<DeckProps<ContextProviderValue>>): void
-
Parameters
-
-
deckProps: Partial<DeckProps<ContextProviderValue>>
Returns void
Optional onTextClick
-
Parameters
-
e: MouseEvent | PointerEvent | TouchEvent
-
Returns void
Optional onVegaSpec
- onVegaSpec(vegaSpec: Spec): void
-
Parameters
Returns void
Customization options for the Viewer.