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

Index

Type aliases

DataExportType

DataExportType: DataFileType | "html"

DataFileType

DataFileType: "json" | "csv" | "tsv" | "topojson"

Variables

Const Explorer

Explorer: typeof Explorer_Class = ...

Const capabilities

capabilities: { webgl: boolean; webgl2: boolean } = ...

Type declaration

  • webgl: boolean
  • webgl2: boolean

Const themePalettes

themePalettes: {} = {}

Type declaration

  • [theme: string]: Partial<FluentUITypes.IPalette>

Const version

version: string = 'DEBUG'

Functions

getColorSettingsFromThemePalette

  • getColorSettingsFromThemePalette(themePalette: Partial<FluentUITypes.IPalette>): Partial<ColorSettings>

getEmbedHTML

  • getEmbedHTML(data: object[], displayName: string, snapshots?: Snapshot[]): string

use

  • Specify the dependency libraries to use for rendering.

    Parameters

    • fluentUI: FluentUIComponents

      FluentUI React library.

    • react: typeof React

      React library.

    • reactDOM: typeof ReactDOM
    • vega: VegaBase

      Vega library.

    • deck: DeckBase

      @deck.gl/core library.

    • layers: DeckLayerBase

      @deck.gl/layers library.

    • luma: LumaBase

      @luma.gl/core library.

    Returns void