---
layout: api
---

# sanddance .types

## Interfaces

### SearchExpression

```typescript
interface SearchExpression {
    clause?: SearchExpressionClause;
    name: string;
    operator: SearchExpressionOperators;
    value?: boolean | Date | number | string;
}
```

**Properties**

| Name     | Type                                                | Optional |
| -------- | --------------------------------------------------- | -------- |
| clause   | [SearchExpressionClause][TypeAliasDeclaration-0]    | true     |
| name     | string                                              | false    |
| operator | [SearchExpressionOperators][TypeAliasDeclaration-1] | false    |
| value    | boolean &#124; Date &#124; number &#124; string     | true     |

----------

### SearchExpressionGroup

```typescript
interface SearchExpressionGroup<T extends SearchExpression = SearchExpression> {
    clause?: SearchExpressionClause;
    expressions: T[];
}
```

**Type parameters**

| Name | Constraint                                 | Default                                    |
| ---- | ------------------------------------------ | ------------------------------------------ |
| T    | [SearchExpression][InterfaceDeclaration-1] | [SearchExpression][InterfaceDeclaration-1] |

**Properties**

| Name        | Type                                             | Optional |
| ----------- | ------------------------------------------------ | -------- |
| clause      | [SearchExpressionClause][TypeAliasDeclaration-0] | true     |
| expressions | T[]                                              | false    |

----------

### Column

Column information.

```typescript
interface Column {
    name: string;
    type: TypeInference;
    quantitative?: boolean;
    isColorData?: boolean;
    stats?: ColumnStats;
}
```

**Properties**

| Name         | Type                                  | Optional | Description                                                  |
| ------------ | ------------------------------------- | -------- | ------------------------------------------------------------ |
| name         | string                                | false    | Name of the column.                                          |
| type         | TypeInference                         | false    | Type of data in the column.                                  |
| quantitative | boolean                               | true     | Optional flag to specify if the column data is quantitative. |
| isColorData  | boolean                               | true     | Optional flag to specify if the column data is CSS colors.   |
| stats        | [ColumnStats][InterfaceDeclaration-4] | true     | Optional stats object with metadata of column data content.  |

----------

### ColumnStats

Metadata about a column.

```typescript
interface ColumnStats {
    distinctValueCount: number;
    max?: number;
    mean?: number;
    min?: number;
    isSequential?: boolean;
    hasNegative?: boolean;
    hasColorData?: boolean;
}
```

**Properties**

| Name               | Type    | Optional | Description                                                            |
| ------------------ | ------- | -------- | ---------------------------------------------------------------------- |
| distinctValueCount | number  | false    | Number of unique values in this column.                                |
| max                | number  | true     | Maximum value of data in this column, if column is numeric.            |
| mean               | number  | true     | Mean value of data in this column, if column is numeric.               |
| min                | number  | true     | Minimum value of data in this column, if column is numeric.            |
| isSequential       | boolean | true     | Optional flag to specify if the column data is sequential.             |
| hasNegative        | boolean | true     | Optional flag to specify if the column data contains negative numbers. |
| hasColorData       | boolean | true     | Optional flag to specify if the column data contains color data.       |

----------

### ColumnTypeMap

```typescript
interface ColumnTypeMap {
    [columnName: string]: TypeInference;
}
```
#### Index

```typescript
[columnName: string]: TypeInference;
```

* *Parameter* `columnName` - string
* *Type* TypeInference


----------

### FacetMargins

```typescript
interface FacetMargins {
    column: number;
    row: number;
    title: number;
}
```

**Properties**

| Name   | Type   | Optional |
| ------ | ------ | -------- |
| column | number | false    |
| row    | number | false    |
| title  | number | false    |

----------

### Facets

Column to use for faceting into small multiples.

```typescript
interface Facets {
    columns: number;
    rows: number;
}
```

**Properties**

| Name    | Type   | Optional | Description                          |
| ------- | ------ | -------- | ------------------------------------ |
| columns | number | false    | Number of columns in the facet grid. |
| rows    | number | false    | Number of rows in the facet grid.    |

----------

### Insight

Options to designate a SandDance visualization.

```typescript
interface Insight {
    chart: Chart;
    size: Size;
    columns: InsightColumns;
    view?: View;
    filter?: Search;
    facets?: Facets;
    colorBin?: ColorBin;
    scheme?: string;
    signalValues?: SignalValues;
    hideAxes?: boolean;
    hideLegend?: boolean;
    directColor?: boolean;
}
```

**Properties**

| Name         | Type                                      | Optional | Description                                                                                                     |
| ------------ | ----------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| chart        | [Chart][TypeAliasDeclaration-5]           | false    |                                                                                                                 |
| size         | [Size][InterfaceDeclaration-9]            | false    |                                                                                                                 |
| columns      | [InsightColumns][InterfaceDeclaration-10] | false    |                                                                                                                 |
| view         | [View][TypeAliasDeclaration-7]            | true     |                                                                                                                 |
| filter       | [Search][TypeAliasDeclaration-3]          | true     |                                                                                                                 |
| facets       | [Facets][InterfaceDeclaration-7]          | true     |                                                                                                                 |
| colorBin     | [ColorBin][TypeAliasDeclaration-6]        | true     | Type of color binning to use on color scale. Only applicable when the column in the color role is quantitative. |
| scheme       | string                                    | true     | Name of the color scheme. See https://vega.github.io/vega/docs/schemes/                                         |
| signalValues | [SignalValues][InterfaceDeclaration-11]   | true     | Vega signal values for this insight.                                                                            |
| hideAxes     | boolean                                   | true     | Optional flag to hide axes.                                                                                     |
| hideLegend   | boolean                                   | true     | Optional flag to hide legend.                                                                                   |
| directColor  | boolean                                   | true     | Optional flag to use CSS colors directly from data.                                                             |

----------

### InsightColumns

```typescript
interface InsightColumns {
    uid?: string;
    x?: string;
    y?: string;
    z?: string;
    group?: string;
    size?: string;
    color?: string;
    sort?: string;
    facet?: string;
}
```

**Properties**

| Name  | Type   | Optional |
| ----- | ------ | -------- |
| uid   | string | true     |
| x     | string | true     |
| y     | string | true     |
| z     | string | true     |
| group | string | true     |
| size  | string | true     |
| color | string | true     |
| sort  | string | true     |
| facet | string | true     |

----------

### SpecRoleCapabilities

```typescript
interface SpecRoleCapabilities {
    role: InsightColumnRoles;
    excludeCategoric?: boolean;
    allowNone?: boolean;
    binnable?: boolean;
    axisSelection?: AxisSelectionType;
    signals?: string[];
}
```

**Properties**

| Name             | Type                                         | Optional | Description                             |
| ---------------- | -------------------------------------------- | -------- | --------------------------------------- |
| role             | [InsightColumnRoles][TypeAliasDeclaration-8] | false    |                                         |
| excludeCategoric | boolean                                      | true     |                                         |
| allowNone        | boolean                                      | true     |                                         |
| binnable         | boolean                                      | true     |                                         |
| axisSelection    | [AxisSelectionType][TypeAliasDeclaration-4]  | true     |                                         |
| signals          | string[]                                     | true     | Signals associated with this spec role. |

----------

### SpecCapabilities

Interaction behavior on a visualization type.

```typescript
interface SpecCapabilities {
    roles: SpecRoleCapabilities[];
    signals?: string[];
}
```

**Properties**

| Name    | Type                                              | Optional | Description                             |
| ------- | ------------------------------------------------- | -------- | --------------------------------------- |
| roles   | [SpecRoleCapabilities][InterfaceDeclaration-12][] | false    | Roles to map columns.                   |
| signals | string[]                                          | true     | Signals associated with this spec type. |

----------

### SpecColorSettings

Custom colors of various parts of the visualization.

```typescript
interface SpecColorSettings {
    defaultCube?: Color;
    axisLine?: Color;
    axisText?: Color;
    cellFillerLine?: Color;
}
```

**Properties**

| Name           | Type  | Optional | Description                                         |
| -------------- | ----- | -------- | --------------------------------------------------- |
| defaultCube    | Color | true     | Color of cubes when there is no coloring specified. |
| axisLine       | Color | true     | Color of axes lines.                                |
| axisText       | Color | true     | Color of axes text.                                 |
| cellFillerLine | Color | true     | Color of inactive facets lines.                     |

----------

### SpecLanguage

Language settings.

```typescript
interface SpecLanguage {
    count: string;
    treeMapMethod: string;
    scatterPointSize: string;
    XBinSize: string;
    YBinSize: string;
    XGridSize: string;
    YGridSize: string;
    InnerPaddingSize: string;
    OuterPaddingSize: string;
    colorBinCount: string;
    colorReverse: string;
    facetColumns: string;
    facetRows: string;
    markOpacitySignal: string;
    textScaleSignal: string;
    xAxisTextAngleSignal: string;
    yAxisTextAngleSignal: string;
    zScaleProportion: string;
}
```

**Properties**

| Name                 | Type   | Optional | Description                              |
| -------------------- | ------ | -------- | ---------------------------------------- |
| count                | string | false    | Label for a count axis.                  |
| treeMapMethod        | string | false    | Label for treemap method dropdown.       |
| scatterPointSize     | string | false    | Label for scatterPlot point size slider. |
| XBinSize             | string | false    | Label for bar x axis bin size slider.    |
| YBinSize             | string | false    | Label for bar y axis bin size slider.    |
| XGridSize            | string | false    | Label for bar x grid size slider.        |
| YGridSize            | string | false    | Label for bar y grid size slider.        |
| InnerPaddingSize     | string | false    | Label for bar inner padding size slider. |
| OuterPaddingSize     | string | false    | Label for bar outer padding size slider. |
| colorBinCount        | string | false    | Label for the color bin count slider.    |
| colorReverse         | string | false    | Label for the color reverse checkbox.    |
| facetColumns         | string | false    | Label for facet columns slider.          |
| facetRows            | string | false    | Label for facet rows slider.             |
| markOpacitySignal    | string | false    | Label for mark opacity slider.           |
| textScaleSignal      | string | false    | Label for text scale slider.             |
| xAxisTextAngleSignal | string | false    | Label for x axis text angle slider.      |
| yAxisTextAngleSignal | string | false    | Label for y axis text angle slider.      |
| zScaleProportion     | string | false    | Label for z scale proportion slider.     |

----------

### SignalValues

```typescript
interface SignalValues {
    [key: string]: any;
}
```
#### Index

```typescript
[key: string]: any;
```

* *Parameter* `key` - string
* *Type* any


----------

### Size

Rectangle size.

```typescript
interface Size {
    height: number;
    width: number;
}
```

**Properties**

| Name   | Type   | Optional |
| ------ | ------ | -------- |
| height | number | false    |
| width  | number | false    |

----------

### SpecColumns

Specified columns for a SandDance visualization.

```typescript
interface SpecColumns {
    uid: Column;
    x?: Column;
    y?: Column;
    z?: Column;
    size?: Column;
    group?: Column;
    color?: Column;
    sort?: Column;
    facet?: Column;
}
```

**Properties**

| Name  | Type                             | Optional | Description                                                               |
| ----- | -------------------------------- | -------- | ------------------------------------------------------------------------- |
| uid   | [Column][InterfaceDeclaration-3] | false    | Column with a unique id for each row.                                     |
| x     | [Column][InterfaceDeclaration-3] | true     | Column to use as x-axis in a visualization.                               |
| y     | [Column][InterfaceDeclaration-3] | true     | Column to use as y-axis in a visualization, optional for bar chart.       |
| z     | [Column][InterfaceDeclaration-3] | true     | Column to use as z-axis in a visualization.                               |
| size  | [Column][InterfaceDeclaration-3] | true     | Column to use as size in a visualization.                                 |
| group | [Column][InterfaceDeclaration-3] | true     | Column to use for grouping in a visualization.                            |
| color | [Column][InterfaceDeclaration-3] | true     | Column to use for coloring a visualization.                               |
| sort  | [Column][InterfaceDeclaration-3] | true     | Column to use for sorting a visualization, not applicable to scatterplot. |
| facet | [Column][InterfaceDeclaration-3] | true     | Column to use for faceting a visualization.                               |

----------

### SpecViewOptions

```typescript
interface SpecViewOptions {
    colors: SpecColorSettings;
    language: SpecLanguage;
    maxLegends: number;
    facetMargins: FacetMargins;
    tickSize: number;
}
```

**Properties**

| Name         | Type                                         | Optional | Description                                          |
| ------------ | -------------------------------------------- | -------- | ---------------------------------------------------- |
| colors       | [SpecColorSettings][InterfaceDeclaration-14] | false    | Custom colors of various parts of the visualization. |
| language     | [SpecLanguage][InterfaceDeclaration-15]      | false    | Language settings for the visualization.             |
| maxLegends   | number                                       | false    | Maximum number of rows in a legend.                  |
| facetMargins | [FacetMargins][InterfaceDeclaration-6]       | false    |                                                      |
| tickSize     | number                                       | false    |                                                      |

----------

### SpecContext

```typescript
interface SpecContext {
    specColumns: SpecColumns;
    insight: Insight;
    specViewOptions: SpecViewOptions;
}
```

**Properties**

| Name            | Type                                       | Optional |
| --------------- | ------------------------------------------ | -------- |
| specColumns     | [SpecColumns][InterfaceDeclaration-16]     | false    |
| insight         | [Insight][InterfaceDeclaration-8]          | false    |
| specViewOptions | [SpecViewOptions][InterfaceDeclaration-17] | false    |

----------

### OrdinalMap

Map of ordinals per unique Id.

```typescript
interface OrdinalMap {
    [uid: string]: number;
}
```
#### Index

```typescript
[uid: string]: number;
```

* *Parameter* `uid` - string
* *Type* number


----------

### RenderResult

Result of an attempt to render.

```typescript
interface RenderResult {
    specResult: SpecResult;
    ordinalMap: OrdinalMap;
}
```

**Properties**

| Name       | Type                                  | Optional | Description                                 |
| ---------- | ------------------------------------- | -------- | ------------------------------------------- |
| specResult | SpecResult | false    | Specification result object.                |
| ordinalMap | [OrdinalMap][InterfaceDeclaration-19] | false    | Map of cube ordinals assigned by unique id. |

----------

### TransitionDurations

Lengths of time for a transition animation.

```typescript
interface TransitionDurations extends TransitionDurations {
    scope: number;
}
```

**Extends**

[TransitionDurations][InterfaceDeclaration-23]

**Properties**

| Name  | Type   | Optional | Description                                         |
| ----- | ------ | -------- | --------------------------------------------------- |
| scope | number | false    | Transition time when a filter is applied / removed. |

----------

### ViewerOptions

Customization options for the Viewer.

```typescript
interface ViewerOptions extends SpecViewOptions {
    colors: ColorSettings;
    fontFamily?: string;
    language: Language;
    tooltipOptions?: TooltipOptions;
    lightSettings?: { [view extends View]: LightSettings };
    transitionDurations: TransitionDurations;
    onError?: (errors: string[]) => void;
    onColorContextChange?: () => void;
    onDataFilter?: (filter: Search, filteredData: object[]) => void;
    onSelectionChanged?: (search: Search, activeIndex?: number, selectedData?: object[]) => void;
    onStage?: (stage: Stage, deckProps: DeckProps) => void;
    onPresent?: () => void;
    onBeforeCreateLayers?: (stage: Stage, specCapabilities: SpecCapabilities) => void;
    getTextColor?: (t: TextLayerDatum) => Color;
    getTextHighlightColor?: (t: TextLayerDatum) => Color;
    onTextClick?: (e: MouseEvent | PointerEvent | TouchEvent, o: TextLayerDatum) => void;
    onAxisClick?: (e: TouchEvent | MouseEvent | PointerEvent, serch: SearchExpressionGroup<SearchExpression>) => void;
    onLegendHeaderClick?: (e: TouchEvent | MouseEvent | PointerEvent) => void;
    onLegendRowClick?: (e: TouchEvent | MouseEvent | PointerEvent, legendRow: LegendRowWithSearch) => void;
    onVegaSpec?: (vegaSpec: Spec) => void;
    selectionPolygonZ: number;
}
```

**Extends**

[SpecViewOptions][InterfaceDeclaration-17]

**Properties**

| Name                  | Type                                                                                                          | Optional | Description                                                                 |
| --------------------- | ------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------- |
| colors                | [ColorSettings][InterfaceDeclaration-25]                                                                      | false    | Custom colors of various parts of the visualization.                        |
| fontFamily            | string                                                                                                        | true     | Font family of text elements.                                               |
| language              | [Language][InterfaceDeclaration-27]                                                                           | false    | Language settings for the visualization.                                    |
| tooltipOptions        | [TooltipOptions][InterfaceDeclaration-29]                                                                     | true     | Tooltip options                                                             |
| lightSettings         | { [view extends [View][TypeAliasDeclaration-7]]: LightSettings }                                              | true     | Optional map of light settings for the visualization, per camera view type. |
| transitionDurations   | [TransitionDurations][InterfaceDeclaration-22]                                                                | false    | Lengths of time for a transition animation.                                 |
| onError               | (errors: string[]) => void                                                                                    | true     | Optional error handler.                                                     |
| onColorContextChange  | () => void                                                                                                    | true     | Optional handler when color context changes.                                |
| onDataFilter          | (filter: Search, filteredData: object[]) => void                                                              | true     | Optional handler to be invoked when data is filtered.                       |
| onSelectionChanged    | (search: Search, activeIndex?: number, selectedData?: object[]) => void                                       | true     | Optional handler to be invoked when selection has changed.                  |
| onStage               | (stage: Stage, deckProps: DeckProps) => void                                                                  | true     | Optional handler when data is on stage.                                     |
| onPresent             | () => void                                                                                                    | true     | Optional handler when chart is presented.                                   |
| onBeforeCreateLayers  | (stage: Stage, specCapabilities: SpecCapabilities) => void                                                    | true     | Optional handler to modify the stage prior to deck.gl layer construction.   |
| getTextColor          | (t: TextLayerDatum) => Color                                                                                  | true     | Optional handler to get the color of text elements.                         |
| getTextHighlightColor | (t: TextLayerDatum) => Color                                                                                  | true     | Optional handler to get the highlight color of text elements.               |
| onTextClick           | (e: MouseEvent &#124; PointerEvent &#124; TouchEvent, o: TextLayerDatum) => void                              | true     | Optional click handler for text elements.                                   |
| onAxisClick           | (e: TouchEvent &#124; MouseEvent &#124; PointerEvent, serch: SearchExpressionGroup<SearchExpression>) => void | true     | Optional handler when axis is clicked.                                      |
| onLegendHeaderClick   | (e: TouchEvent &#124; MouseEvent &#124; PointerEvent) => void                                                 | true     | Optional handler when legend header is clicked.                             |
| onLegendRowClick      | (e: TouchEvent &#124; MouseEvent &#124; PointerEvent, legendRow: LegendRowWithSearch) => void                 | true     | Optional handler when legend row is clicked.                                |
| onVegaSpec            | (vegaSpec: Spec) => void                                                                                      | true     | Optional handler when Vega spec is created, prior to it being rendered.     |
| selectionPolygonZ     | number                                                                                                        | false    | Z value of selection polygons.                                              |

----------

### RenderOptions

```typescript
interface RenderOptions {
    columns?: Column[];
    columnTypes?: ColumnTypeMap;
    ordinalMap?: OrdinalMap;
    initialColorContext?: ColorContext;
    discardColorContextUpdates?: () => boolean;
}
```

**Properties**

| Name                       | Type                                    | Optional |
| -------------------------- | --------------------------------------- | -------- |
| columns                    | [Column][InterfaceDeclaration-3][]      | true     |
| columnTypes                | [ColumnTypeMap][InterfaceDeclaration-5] | true     |
| ordinalMap                 | [OrdinalMap][InterfaceDeclaration-19]   | true     |
| initialColorContext        | [ColorContext][InterfaceDeclaration-41] | true     |
| discardColorContextUpdates | () => boolean                           | true     |

----------

### ColorSettings

Custom colors of various parts of the visualization.

```typescript
interface ColorSettings extends SpecColorSettings {
    activeCube?: Color;
    hoveredCube?: Color;
    selectedCube?: Color;
    axisSelectHighlight?: Color;
    unselectedColorMethod?: ColorMethod;
}
```

**Extends**

[SpecColorSettings][InterfaceDeclaration-14]

**Properties**

| Name                  | Type                                   | Optional | Description                              |
| --------------------- | -------------------------------------- | -------- | ---------------------------------------- |
| activeCube            | Color                                  | true     | Color of the individually selected cube. |
| hoveredCube           | Color                                  | true     | Color of the cube when mouse hovered.    |
| selectedCube          | Color                                  | true     | Color of selected cubes.                 |
| axisSelectHighlight   | Color                                  | true     | Color of axis hover hotspots.            |
| unselectedColorMethod | [ColorMethod][InterfaceDeclaration-26] | true     | Method of coloring unselected cubes.     |

----------

### Headers

Labels in the sections of the chart panel.

```typescript
interface Headers {
    chart: string;
    legend: string;
    selection: string;
    details: string;
}
```

**Properties**

| Name      | Type   | Optional | Description                  |
| --------- | ------ | -------- | ---------------------------- |
| chart     | string | false    | Label above chart controls.  |
| legend    | string | false    | Label above legend.          |
| selection | string | false    | Label above selection area.  |
| details   | string | false    | Label above details section. |

----------

### Language

Language settings.

```typescript
interface Language extends SpecLanguage {
    headers: Headers;
    bing: string;
    newColorMap: string;
    oldColorMap: string;
    deselect: string;
    exclude: string;
    isolate: string;
    legendOther: string;
    nextDetail: string;
    previousDetail: string;
    reset: string;
    selectionCount: (count: number) => string;
}
```

**Extends**

[SpecLanguage][InterfaceDeclaration-15]

**Properties**

| Name           | Type                               | Optional | Description                                   |
| -------------- | ---------------------------------- | -------- | --------------------------------------------- |
| headers        | [Headers][InterfaceDeclaration-28] | false    | Labels in the sections of the chart panel.    |
| bing           | string                             | false    | Text to use for "search with Bing".           |
| newColorMap    | string                             | false    | Button text to re-map color.                  |
| oldColorMap    | string                             | false    | Button text to keep same color.               |
| deselect       | string                             | false    | Button text to deselect.                      |
| exclude        | string                             | false    | Button text to filter out selected items.     |
| isolate        | string                             | false    | Button text to keep only selected items.      |
| legendOther    | string                             | false    | Text for aggregated legend rows past maximum. |
| nextDetail     | string                             | false    | Button text for next item.                    |
| previousDetail | string                             | false    | Button text for previous item.                |
| reset          | string                             | false    | Button text to remove all filters.            |
| selectionCount | (count: number) => string          | false    | Label preceding number of items in selection. |

----------

### ColorScheme

Custom Vega color scheme.

```typescript
interface ColorScheme {
    scheme: string;
    colors: string[];
}
```

**Properties**

| Name   | Type     | Optional | Description               |
| ------ | -------- | -------- | ------------------------- |
| scheme | string   | false    | Name of the color scheme. |
| colors | string[] | false    | Array of CSS colors.      |

----------

### ColorMappedItem

```typescript
interface ColorMappedItem {
    color?: Color;
    unSelected?: boolean;
}
```

**Properties**

| Name       | Type    | Optional |
| ---------- | ------- | -------- |
| color      | Color   | true     |
| unSelected | boolean | true     |

----------

### ColorMap

Map of ordinal to color.

```typescript
interface ColorMap {
    [ordinal: number]: ColorMappedItem;
}
```
#### Index

```typescript
[ordinal: number]: ColorMappedItem;
```

* *Parameter* `ordinal` - number
* *Type* [ColorMappedItem][InterfaceDeclaration-43]


----------

### ColorContext

ColorMap plus an HTMLElement legend containing color.

```typescript
interface ColorContext {
    colorMap: ColorMap;
    legendElement: HTMLElement;
    legend: Legend;
}
```

**Properties**

| Name          | Type                                | Optional |
| ------------- | ----------------------------------- | -------- |
| colorMap      | [ColorMap][InterfaceDeclaration-42] | false    |
| legendElement | HTMLElement                         | false    |
| legend        | [Legend][InterfaceDeclaration-32]   | false    |

----------

### ColorMethod

```typescript
interface ColorMethod {
    (color: Color): Color;
}
```
#### Call

```typescript
(color: Color): Color;
```

**Parameters**

| Name  | Type  |
| ----- | ----- |
| color | Color |

**Return type**

Color


----------

### LegendRowWithSearch

```typescript
interface LegendRowWithSearch extends LegendRow {
    search: SearchExpressionGroup<SearchExpression>;
}
```

**Extends**

[LegendRow][InterfaceDeclaration-33]

**Properties**

| Name   | Type                                                                                        | Optional |
| ------ | ------------------------------------------------------------------------------------------- | -------- |
| search | [SearchExpressionGroup][InterfaceDeclaration-2]<[SearchExpression][InterfaceDeclaration-1]> | false    |

----------

### SelectionState

```typescript
interface SelectionState {
    search?: Search;
    selectedData?: object[];
    active?: object;
}
```

**Properties**

| Name         | Type                             | Optional |
| ------------ | -------------------------------- | -------- |
| search       | [Search][TypeAliasDeclaration-3] | true     |
| selectedData | object[]                         | true     |
| active       | object                           | true     |

----------

### TooltipOptions

```typescript
interface TooltipOptions {
    exclude?: (columnName: string) => boolean;
    displayValue?: (value: any) => string;
}
```

**Properties**

| Name         | Type                            | Optional |
| ------------ | ------------------------------- | -------- |
| exclude      | (columnName: string) => boolean | true     |
| displayValue | (value: any) => string          | true     |

## Types

### SearchExpressionClause

```typescript
type SearchExpressionClause = "&&" | "||";
```

**Type**

"&&" | "||"

----------

### SearchExpressionStringSearchOperators

```typescript
type SearchExpressionStringSearchOperators = "starts" | "!starts" | "contains" | "!contains";
```

**Type**

"starts" | "!starts" | "contains" | "!contains"

----------

### SearchExpressionOperators

```typescript
type SearchExpressionOperators = "==" | "!=" | "<" | "<=" | ">" | ">=" | "isnullorEmpty" | "!isnullorEmpty" | SearchExpressionStringSearchOperators;
```

**Type**

"==" | "!=" | "<" | "<=" | ">" | ">=" | "isnullorEmpty" | "!isnullorEmpty" | [SearchExpressionStringSearchOperators][TypeAliasDeclaration-2]

----------

### Search

```typescript
type Search = SearchExpression | SearchExpressionGroup<SearchExpression> | SearchExpressionGroup<SearchExpression>[];
```

**Type**

[SearchExpression][InterfaceDeclaration-1] | [SearchExpressionGroup][InterfaceDeclaration-2]<[SearchExpression][InterfaceDeclaration-1]> | [SearchExpressionGroup][InterfaceDeclaration-2]<[SearchExpression][InterfaceDeclaration-1]>[]

----------

### AxisSelectionType

Type of selection scope on an axis.

```typescript
type AxisSelectionType = "exact" | "range";
```

**Type**

"exact" | "range"

----------

### Chart

Types of SandDance visualizations.

```typescript
type Chart = "barchart" | "barchartH" | "barchartV" | "density" | "grid" | "scatterplot" | "stacks" | "treemap";
```

**Type**

"barchart" | "barchartH" | "barchartV" | "density" | "grid" | "scatterplot" | "stacks" | "treemap"

----------

### ColorBin

```typescript
type ColorBin = "continuous" | "quantize" | "quantile";
```

**Type**

"continuous" | "quantize" | "quantile"

----------

### InsightColumnRoles

```typescript
type InsightColumnRoles = "uid" | "x" | "y" | "z" | "group" | "size" | "color" | "facet" | "sort";
```

**Type**

"uid" | "x" | "y" | "z" | "group" | "size" | "color" | "facet" | "sort"

[NamespaceImport-2]: types.html#types
[InterfaceDeclaration-1]: types.html#searchexpression
[TypeAliasDeclaration-0]: types.html#searchexpressionclause
[TypeAliasDeclaration-1]: types.html#searchexpressionoperators
[InterfaceDeclaration-2]: types.html#searchexpressiongroup
[InterfaceDeclaration-1]: types.html#searchexpression
[InterfaceDeclaration-1]: types.html#searchexpression
[TypeAliasDeclaration-0]: types.html#searchexpressionclause
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-4]: types.html#columnstats
[InterfaceDeclaration-4]: types.html#columnstats
[InterfaceDeclaration-5]: types.html#columntypemap
[InterfaceDeclaration-6]: types.html#facetmargins
[InterfaceDeclaration-7]: types.html#facets
[InterfaceDeclaration-8]: types.html#insight
[TypeAliasDeclaration-5]: types.html#chart
[InterfaceDeclaration-9]: types.html#size
[InterfaceDeclaration-10]: types.html#insightcolumns
[TypeAliasDeclaration-7]: vegadeckgl/types.html#view
[TypeAliasDeclaration-3]: types.html#search
[InterfaceDeclaration-7]: types.html#facets
[TypeAliasDeclaration-6]: types.html#colorbin
[InterfaceDeclaration-11]: types.html#signalvalues
[InterfaceDeclaration-10]: types.html#insightcolumns
[InterfaceDeclaration-12]: types.html#specrolecapabilities
[TypeAliasDeclaration-8]: types.html#insightcolumnroles
[TypeAliasDeclaration-4]: types.html#axisselectiontype
[InterfaceDeclaration-13]: types.html#speccapabilities
[InterfaceDeclaration-12]: types.html#specrolecapabilities
[InterfaceDeclaration-14]: types.html#speccolorsettings
[InterfaceDeclaration-15]: types.html#speclanguage
[InterfaceDeclaration-11]: types.html#signalvalues
[InterfaceDeclaration-9]: types.html#size
[InterfaceDeclaration-16]: types.html#speccolumns
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-17]: types.html#specviewoptions
[InterfaceDeclaration-14]: types.html#speccolorsettings
[InterfaceDeclaration-15]: types.html#speclanguage
[InterfaceDeclaration-6]: types.html#facetmargins
[InterfaceDeclaration-18]: types.html#speccontext
[InterfaceDeclaration-16]: types.html#speccolumns
[InterfaceDeclaration-8]: types.html#insight
[InterfaceDeclaration-17]: types.html#specviewoptions
[InterfaceDeclaration-19]: types.html#ordinalmap
[InterfaceDeclaration-20]: types.html#renderresult
[InterfaceDeclaration-19]: types.html#ordinalmap
[InterfaceDeclaration-22]: types.html#transitiondurations
[InterfaceDeclaration-23]: vegadeckgl/types.html#transitiondurations
[InterfaceDeclaration-24]: types.html#vieweroptions
[InterfaceDeclaration-17]: types.html#specviewoptions
[InterfaceDeclaration-25]: types.html#colorsettings
[InterfaceDeclaration-27]: types.html#language
[InterfaceDeclaration-29]: types.html#tooltipoptions
[TypeAliasDeclaration-7]: vegadeckgl/types.html#view
[InterfaceDeclaration-22]: types.html#transitiondurations
[InterfaceDeclaration-40]: types.html#renderoptions
[InterfaceDeclaration-3]: types.html#column
[InterfaceDeclaration-5]: types.html#columntypemap
[InterfaceDeclaration-19]: types.html#ordinalmap
[InterfaceDeclaration-41]: types.html#colorcontext
[InterfaceDeclaration-25]: types.html#colorsettings
[InterfaceDeclaration-14]: types.html#speccolorsettings
[InterfaceDeclaration-26]: types.html#colormethod
[InterfaceDeclaration-28]: types.html#headers
[InterfaceDeclaration-27]: types.html#language
[InterfaceDeclaration-15]: types.html#speclanguage
[InterfaceDeclaration-28]: types.html#headers
[InterfaceDeclaration-0]: types.html#colorscheme
[InterfaceDeclaration-43]: types.html#colormappeditem
[InterfaceDeclaration-42]: types.html#colormap
[InterfaceDeclaration-43]: types.html#colormappeditem
[InterfaceDeclaration-41]: types.html#colorcontext
[InterfaceDeclaration-42]: types.html#colormap
[InterfaceDeclaration-32]: vegadeckgl/types.html#legend
[InterfaceDeclaration-26]: types.html#colormethod
[InterfaceDeclaration-39]: types.html#legendrowwithsearch
[InterfaceDeclaration-33]: vegadeckgl/types.html#legendrow
[InterfaceDeclaration-1]: types.html#searchexpression
[InterfaceDeclaration-2]: types.html#searchexpressiongroup
[InterfaceDeclaration-44]: types.html#selectionstate
[TypeAliasDeclaration-3]: types.html#search
[InterfaceDeclaration-29]: types.html#tooltipoptions
[TypeAliasDeclaration-0]: types.html#searchexpressionclause
[TypeAliasDeclaration-2]: types.html#searchexpressionstringsearchoperators
[TypeAliasDeclaration-1]: types.html#searchexpressionoperators
[TypeAliasDeclaration-2]: types.html#searchexpressionstringsearchoperators
[TypeAliasDeclaration-3]: types.html#search
[InterfaceDeclaration-1]: types.html#searchexpression
[InterfaceDeclaration-1]: types.html#searchexpression
[InterfaceDeclaration-2]: types.html#searchexpressiongroup
[InterfaceDeclaration-1]: types.html#searchexpression
[InterfaceDeclaration-2]: types.html#searchexpressiongroup
[TypeAliasDeclaration-4]: types.html#axisselectiontype
[TypeAliasDeclaration-5]: types.html#chart
[TypeAliasDeclaration-6]: types.html#colorbin
[TypeAliasDeclaration-8]: types.html#insightcolumnroles