@seracio/dthree

dthree

dthree is a small helper inspired by d3 selection module for data join. It splits a selection (populated by an Iterable) into 3 distinct arrays : enter, updateandexit`. Unlike its d3 counterpart, it doesn't bind the data to the DOM and solely return the arrays. We use it when doing datavis in WebGL.

Install

yarn add @seracio/dthree

Usage

import dthree from '@seracio/dthree';

// create a new selection
const mySelection = dthree.selectAll('myNamespace');

// bind data
mySelection.data([0,1,2,3]);
assert.deepEqual(mySelection.enter(), [0,1,2,3]);
assert.deepEqual(mySelection.update(), []);
assert.deepEqual(mySelection.exit(), []);

// re-bind data
mySelection.data([0,1,2]);
assert.deepEqual(mySelection.enter(), []);
assert.deepEqual(mySelection.update(), [0,1,2]);
assert.deepEqual(mySelection.exit(), [3]);`
 
// use a getKey function to bind data (we use index by default)
mySelection.data([0,1,2], (value, index) => `${value}_${index}`);

API

dthree

• dthree.selectAll(namespace: string): Selection

Create or get a selection

Selection

• selection.data(data: Iterable, getKey: ?(value, index) => string): Selection

Update data, if getKey is not provided, we'll use the array indexes as key

• selection.enter(): Array

Returns the newly created data

• selection.update(): Array

Returns the newly updated data

• selection.exit(): Array

Returns the newly removed data

• selection.all(): Array

Returns the enter + update data

License

MIT License

Copyright (c) 2017 serac.io

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.