--- layout: typedoc title: 'ViewerOptions | @msrvida/sanddance-explorer' ---

Customization options for the Viewer.

Hierarchy

Index

Properties

colors

Custom colors of various parts of the visualization.

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

transitionDurations

transitionDurations: TransitionDurations

Lengths of time for a transition animation.

Optional zAxisOptions

zAxisOptions: ZAxisOptions

Methods

Optional getTextColor

  • Optional handler to get the color of text elements.

    Parameters

    Returns RGBAColor

Optional getTextHighlightAlphaCutoff

  • getTextHighlightAlphaCutoff(): number
  • Optional handler to get the alpha cutoff for highlight color of text elements.

    Returns number

Optional getTextHighlightColor

  • Optional handler to get the highlight color of text elements.

    Parameters

    Returns RGBAColor

Optional onAxisClick

  • Optional handler when axis is clicked.

    Parameters

    Returns void

Optional onBeforeCreateLayers

  • Optional handler to modify the stage prior to deck.gl layer construction.

    Parameters

    Returns void

Optional onColorContextChange

  • onColorContextChange(): void
  • Optional handler when color context changes.

    Returns void

Optional onCubeClick

  • onCubeClick(e: MouseEvent | PointerEvent | TouchEvent, cube: Cube): void
  • Optional handler when cube is clicked.

    Parameters

    • e: MouseEvent | PointerEvent | TouchEvent
    • cube: Cube

    Returns void

Optional onDataFilter

  • onDataFilter(filter: Search, filteredData: object[]): void
  • Optional handler to be invoked when data is filtered.

    Parameters

    • filter: Search
    • filteredData: object[]

    Returns void

Optional onError

  • onError(errors: string[]): void
  • Optional error handler.

    Parameters

    • errors: string[]

    Returns void

Optional onLegendHeaderClick

  • onLegendHeaderClick(e: MouseEvent | PointerEvent | TouchEvent): void
  • Optional handler when legend header is clicked.

    Parameters

    • e: MouseEvent | PointerEvent | TouchEvent

    Returns void

Optional onLegendRowClick

  • onLegendRowClick(e: MouseEvent | PointerEvent | TouchEvent, legendRow: LegendRowWithSearch): void
  • Optional handler when legend row is clicked.

    Parameters

    Returns void

Optional onNewViewStateTarget

  • onNewViewStateTarget(): boolean
  • Optional handler to reset the camera after chart is rendered.

    Returns boolean

Optional onPresent

  • onPresent(): void
  • Optional handler when chart is presented.

    Returns void

Optional onSelectionChanged

  • onSelectionChanged(search: Search, activeIndex?: number, selectedData?: object[]): void
  • 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, deckProps: Partial<DeckProps<ContextProviderValue>>): void
  • Optional handler when data is on stage.

    Parameters

    Returns void

Optional onTextClick

  • Optional click handler for text elements.

    Parameters

    Returns void

Optional onVegaSpec

  • onVegaSpec(vegaSpec: Spec): void
  • Optional handler when Vega spec is created, prior to it being rendered.

    Parameters

    • vegaSpec: Spec

    Returns void