SandDance

sanddance-explorer

Functions

getEmbedHTML

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

Parameters

Name Type
data object[]
displayName string
snapshots Snapshot[]

Return type

string


use

Specify the dependency libraries to use for rendering.

function use(fabric: FabricComponents, vega: VegaBase, deck: DeckBase, layers: DeckLayerBase, luma: LumaBase): void;

Parameters

Name Type Description
fabric FabricComponents Office UI Fabric React library.
vega VegaBase  
deck DeckBase  
layers DeckLayerBase  
luma LumaBase  

Return type

void


getColorSettingsFromThemePalette

function getColorSettingsFromThemePalette(themePalette: Partial<IPalette>): Partial<ColorSettings>;

Parameters

Name Type
themePalette Partial

Return type

Partial<ColorSettings>

Interfaces

ColorSettings

interface ColorSettings extends ColorSettings {
    clickableText?: Color;
    clickableTextHighlight?: Color;
}

Extends

ColorSettings

Properties

Name Type Optional
clickableText Color true
clickableTextHighlight Color true

DataContent

interface DataContent {
    data: object[];
    columns: Column[];
    snapshots?: Snapshot[];
}

Properties

Name Type Optional
data object[] false
columns Column[] false
snapshots Snapshot[] true

DataFile

interface DataFile {
    displayName?: string;
    dataUrl?: string;
    snapshotsUrl?: string;
    rawText?: string;
    snapshots?: Snapshot[];
    type: DataFileType;
}

Properties

Name Type Optional
displayName string true
dataUrl string true
snapshotsUrl string true
rawText string true
snapshots Snapshot[] true
type DataFileType false

SettingsGroup

interface SettingsGroup {
    groupLabel: string;
    children: ReactNode;
}

Properties

Name Type Optional
groupLabel string false
children ReactNode false

Snapshot

interface Snapshot {
    title?: string;
    description?: string;
    insight?: Insight;
    image?: string;
    bgColor?: string;
}

Properties

Name Type Optional
title string true
description string true
insight Insight true
image string true
bgColor string true

ViewerOptions

interface ViewerOptions extends ViewerOptions {
    colors: ColorSettings;
}

Extends

ViewerOptions

Properties

Name Type Optional Description
colors ColorSettings false Custom colors of various parts of the visualization.

Prefs

interface Prefs {
    [chart: string]: SpecTypePrefs;
}

Index

[chart: string]: SpecTypePrefs;
  • Parameter chart - string
  • Type SpecTypePrefs

Options

interface Options {
    chartPrefs?: Prefs;
    tooltipExclusions?: string[];
}

Properties

Name Type Optional
chartPrefs Prefs true
tooltipExclusions string[] true

Props

interface Props {
    compactUI?: boolean;
    hideSidebarControls?: boolean;
    logoClickUrl?: string;
    logoClickTarget?: string;
    bingSearchDisabled?: boolean;
    searchORDisabled?: boolean;
    theme?: string;
    viewerOptions?: Partial<ViewerOptions>;
    initialView?: View;
    mounted?: (explorer: Explorer<>) => any;
    datasetElement?: Element<>;
    dataExportHandler?: DataExportHandler;
    topBarButtonProps?: ICommandBarItemProps[];
    snapshotProps?: SnapshotProps;
    onSnapshotClick?: (snapshot: Snapshot, selectedSnaphotIndex: number) => void | boolean;
    onView?: () => void;
    onError?: (e: any) => void;
    onSignalChanged?: () => void;
    onTooltipExclusionsChanged?: (tooltipExclusions: string[]) => void;
    additionalSettings?: SettingsGroup[];
    systemInfoChildren?: ReactNode;
}

Properties

Name Type Optional
compactUI boolean true
hideSidebarControls boolean true
logoClickUrl string true
logoClickTarget string true
bingSearchDisabled boolean true
searchORDisabled boolean true
theme string true
viewerOptions Partial true
initialView View true
mounted (explorer: Explorer<>) => any true
datasetElement Element<> true
dataExportHandler DataExportHandler true
topBarButtonProps ICommandBarItemProps[] true
snapshotProps SnapshotProps true
onSnapshotClick (snapshot: Snapshot, selectedSnaphotIndex: number) => void | boolean true
onView () => void true
onError (e: any) => void true
onSignalChanged () => void true
onTooltipExclusionsChanged (tooltipExclusions: string[]) => void true
additionalSettings SettingsGroup[] true
systemInfoChildren ReactNode true

State

interface State extends Insight {
    calculating: () => void;
    errors: string[];
    autoCompleteDistinctValues: AutoCompleteDistinctValues;
    search: InputSearchExpressionGroup<>[];
    filteredData: object[];
    sidebarClosed: boolean;
    sidebarPinned: boolean;
    dataFile: DataFile;
    dataContent: DataContent;
    specCapabilities: SpecCapabilities;
    sideTabId: SideTabId;
    dataScopeId: DataScopeId;
    selectedItemIndex: { [key: number]: number; };
    snapshots: Snapshot[];
    selectedSnapshotIndex: number;
    tooltipExclusions: string[];
    positionedColumnMapProps: PositionedColumnMapProps;
    note: string;
}

Extends

Insight

Properties

Name Type Optional
calculating () => void false
errors string[] false
autoCompleteDistinctValues AutoCompleteDistinctValues false
search InputSearchExpressionGroup<>[] false
filteredData object[] false
sidebarClosed boolean false
sidebarPinned boolean false
dataFile DataFile false
dataContent DataContent false
specCapabilities SpecCapabilities false
sideTabId SideTabId false
dataScopeId DataScopeId false
selectedItemIndex { [key: number]: number; } false
snapshots Snapshot[] false
selectedSnapshotIndex number false
tooltipExclusions string[] false
positionedColumnMapProps PositionedColumnMapProps false
note string false

Types

DataExportType

type DataExportType = DataFileType | "html";

Type

DataFileType “html”

DataFileType

type DataFileType = "json" | "csv" | "tsv" | "topojson";

Type

“json” “csv” “tsv” “topojson”

Enums

SideTabId

enum SideTabId {
     ChartType = 0,
     Data = 1,
     Search = 2,
     Color = 3,
     Snapshots = 4,
     Settings = 5,
     Pin = 6,
     Collapse = 7
}

Members

Name Value
ChartType 0
Data 1
Search 2
Color 3
Snapshots 4
Settings 5
Pin 6
Collapse 7

Classes

Explorer

Variables

capabilities

const capabilities: { webgl: boolean; webgl2: boolean; };

Type

{ webgl: boolean; webgl2: boolean; }


themePalettes

const themePalettes: { [theme: string]: Partial<IPalette>; };

Type

{ [theme: string]: Partial; }


version

const version: string;

Type

string