@msrvida/sanddance

Visually explore, understand, and present your data.

Demo - API Reference

Installation

You will need to consider how to load the libraries that sanddance depends on, based on your build & deployment scenario.

Installation via script tags

Load dependencies via <script> tags in your HTML:

<script src="https://unpkg.com/vega@^5.11/build/vega.js" charset="utf-8"></script>
<script src="https://unpkg.com/deck.gl@~6.4/deckgl.min.js"></script>
<script src="https://unpkg.com/@msrvida/sanddance@^3/dist/umd/sanddance.js"></script>

A global variable named SandDance will be available to you. In your JavaScript, call the use function to pass the dependency libraries:

SandDance.use(vega, deck, deck, luma);

Installation via Node.js

Add these to the dependencies section of your package.json, then run npm install:

"@deck.gl/core": "^8.3.7",
"@deck.gl/layers": "^8.3.7",
"@msrvida/sanddance": "^3",
"@luma.gl/core": "^8.3.1",
"vega": "^5.17.0"

Import these in your JavaScript, then call the use() function to pass the dependency libraries to SandDance.VegaDeckGl:

import * as deck from '@deck.gl/core';
import * as layers from '@deck.gl/layers';
import * as luma from '@luma.gl/core';
import * as vega from 'vega';
import * as SandDance from '@msrvida/sanddance';

SandDance.use(vega, deck, layers, luma);

Versions

3.1.0 Changes

• Fix for animation easing
• Text character set accepts all unicode

Breaking changes in v3

• deck.gl dependency from 6.4 to 8.1
• new searchExpression namespace
  • types.Search moved here
  • util.ensureSearchExpressionGroup moved here
• new specs namespace
  • types.Insight moved here
• ViewerOptions colors are now string type
• VegaDeckGl.View moved to types.View

Breaking changes in v2

• vega dependency from 4.x to 5.x

For more information

Please visit the SandDance website.