Class: XSankey

XSankey(ecs, options, vectors)

new XSankey(ecs, options, vectors)

create sankey objects

Parameters:

Name	Type	Description
`ecs`	ECS
`options`	object	options.chart: the json chart section defining chart grid space, {domain, range, grid, grid-space}
`vectors`	array	the high dimensional vectors. deprecated? XSankey assumes the last dimension as the y scale value as in original 2d sankey chart.

Source:

lib/chart/curve/xsankey.js, line 21

Members

(static) skuuid

For generating sankey element uuid.

Source:

lib/chart/curve/xsankey.js, line 459

barmap

Bars' pivoting (extruding) positions (grid index).

Properties:

Name	Type	Description
`barmap`

Source:

lib/chart/curve/xsankey.js, line 50

extrudingCoord

extruding coordingate index

Properties:

Name	Type	Description
`extrudingCoord`	int	coordinate index

Source:

lib/chart/curve/xsankey.js, line 37

pivotings

Bars' pivoting (extruding) positions (grid index).

Properties:

Name	Type	Description
`pivotings`	array.<array>	major index: vector index; minor index: coord index

Source:

lib/chart/curve/xsankey.js, line 43

vectors

Properties:

Name	Type	Description
`vectors`

Source:

lib/chart/curve/xsankey.js, line 55

Methods

(static) debug1()

Create some sankey bars. Should been kept. works together with update() in branch temp-sankey-debug1

Source:

lib/chart/curve/xsankey.js, line 328

(static) extrudextr(e)

Extrude / de-extrude the selected coordinates.

Note: In x-visual 1.0, all sankey bars can only move back and forth, without moving elsewhere, e.g. from z = 1 to z = 2.

TODO ignore new translate when tweening

Parameters:

Name	Type	Description
`e`	Sankey	the selected entity

Source:

lib/chart/curve/xsankey.js, line 242

(static) sankey(ecs, grid, pivotings
, json, options
) → {object}

Setup sankey chart with data.

Parameters:

Name	Type	Description
`ecs`	ECS
`grid`	CoordsGrid
`pivotings`	object
`json`	object	where json.grid-space json.coordss: array of {label, range}, where range is the discret value serial. json.vectors: array of hi-dimensional vectors, with last dimesion as value.
`options`	object	texture: string, bar texture, e.g. './tex/byr0.png', default is ram texture geom: Obj3Type otpinal, default Cylinder box: geometry parameters, [radiusTop, radiusBottom, height(ignored), radialSegments = 4]

Source:

lib/chart/curve/xsankey.js, line 84

Returns:

{barmap, defs} where
barmap: map of [coord-index => [bar-entity]]
defs: array of entity definition of sankey bars

Type: object

(static) skUId()

Get a uuid.

Source:

lib/chart/curve/xsankey.js, line 463

update(tick, entites)

Parameters:

Name	Type	Description
`tick`	int
`entites`	array.<Entity>

Source:

lib/chart/curve/xsankey.js, line 189

XSankey(ecs, options, jbar, vectors)

new XSankey(ecs, options, jbar, vectors)

create bar chart objects

Parameters:

Name	Type	Description
`ecs`	ECS
`options`	object	options.chart: the json chart section defining chart grid space, {domain, range, grid, grid-space}
`jbar`	object	the json bar section definint bar chart.
`vectors`	array	the high dimensional vectors. assumes the last dimension as the y scale value

Source:

lib/chart/shape/xbar.js, line 22

Members

(static) skuuid

For generating sankey element uuid.

Source:

lib/chart/curve/xsankey.js, line 459

barmap

Bars' pivoting (extruding) positions (grid index).

Properties:

Name	Type	Description
`barmap`

Source:

lib/chart/curve/xsankey.js, line 50

extrudingCoord

extruding coordingate index

Properties:

Name	Type	Description
`extrudingCoord`	int	coordinate index

Source:

lib/chart/curve/xsankey.js, line 37

pivotings

Bars' pivoting (extruding) positions (grid index).

Properties:

Name	Type	Description
`pivotings`	array.<array>	major index: vector index; minor index: coord index

Source:

lib/chart/curve/xsankey.js, line 43

vectors

Properties:

Name	Type	Description
`vectors`

Source:

lib/chart/curve/xsankey.js, line 55

Methods

(static) debug1()

Create some sankey bars. Should been kept. works together with update() in branch temp-sankey-debug1

Source:

lib/chart/curve/xsankey.js, line 328

(static) extrudextr(e)

Extrude / de-extrude the selected coordinates.

Note: In x-visual 1.0, all sankey bars can only move back and forth, without moving elsewhere, e.g. from z = 1 to z = 2.

TODO ignore new translate when tweening

Parameters:

Name	Type	Description
`e`	Sankey	the selected entity

Source:

lib/chart/curve/xsankey.js, line 242

(static) sankey(ecs, grid, pivotings
, json, options
) → {object}

Setup sankey chart with data.

Parameters:

Name	Type	Description
`ecs`	ECS
`grid`	CoordsGrid
`pivotings`	object
`json`	object	where json.grid-space json.coordss: array of {label, range}, where range is the discret value serial. json.vectors: array of hi-dimensional vectors, with last dimesion as value.
`options`	object	texture: string, bar texture, e.g. './tex/byr0.png', default is ram texture geom: Obj3Type otpinal, default Cylinder box: geometry parameters, [radiusTop, radiusBottom, height(ignored), radialSegments = 4]

Source:

lib/chart/curve/xsankey.js, line 84

Returns:

{barmap, defs} where
barmap: map of [coord-index => [bar-entity]]
defs: array of entity definition of sankey bars

Type: object

(static) skUId()

Get a uuid.

Source:

lib/chart/curve/xsankey.js, line 463

update(tick, entites)

Parameters:

Name	Type	Description
`tick`	int
`entites`	array.<Entity>

Source:

lib/chart/curve/xsankey.js, line 189

XSankey()

new XSankey()

Subsystem rendering 3d sankey chart

Source:

lib/chart/curve/xsankey.js, line 15

Members

(static) skuuid

For generating sankey element uuid.

Source:

lib/chart/curve/xsankey.js, line 459

barmap

Bars' pivoting (extruding) positions (grid index).

Properties:

Name	Type	Description
`barmap`

Source:

lib/chart/curve/xsankey.js, line 50

extrudingCoord

extruding coordingate index

Properties:

Name	Type	Description
`extrudingCoord`	int	coordinate index

Source:

lib/chart/curve/xsankey.js, line 37

pivotings

Bars' pivoting (extruding) positions (grid index).

Properties:

Name	Type	Description
`pivotings`	array.<array>	major index: vector index; minor index: coord index

Source:

lib/chart/curve/xsankey.js, line 43

vectors

Properties:

Name	Type	Description
`vectors`

Source:

lib/chart/curve/xsankey.js, line 55

Methods

(static) debug1()

Create some sankey bars. Should been kept. works together with update() in branch temp-sankey-debug1

Source:

lib/chart/curve/xsankey.js, line 328

(static) extrudextr(e)

Extrude / de-extrude the selected coordinates.

Note: In x-visual 1.0, all sankey bars can only move back and forth, without moving elsewhere, e.g. from z = 1 to z = 2.

TODO ignore new translate when tweening

Parameters:

Name	Type	Description
`e`	Sankey	the selected entity

Source:

lib/chart/curve/xsankey.js, line 242

(static) sankey(ecs, grid, pivotings
, json, options
) → {object}

Setup sankey chart with data.

Parameters:

Name	Type	Description
`ecs`	ECS
`grid`	CoordsGrid
`pivotings`	object
`json`	object	where json.grid-space json.coordss: array of {label, range}, where range is the discret value serial. json.vectors: array of hi-dimensional vectors, with last dimesion as value.
`options`	object	texture: string, bar texture, e.g. './tex/byr0.png', default is ram texture geom: Obj3Type otpinal, default Cylinder box: geometry parameters, [radiusTop, radiusBottom, height(ignored), radialSegments = 4]

Source:

lib/chart/curve/xsankey.js, line 84

Returns:

{barmap, defs} where
barmap: map of [coord-index => [bar-entity]]
defs: array of entity definition of sankey bars

Type: object

(static) skUId()

Get a uuid.

Source:

lib/chart/curve/xsankey.js, line 463

update(tick, entites)

Parameters:

Name	Type	Description
`tick`	int
`entites`	array.<Entity>

Source:

lib/chart/curve/xsankey.js, line 189

Class: XSankey

new XSankey(ecs, options, vectors)

Parameters:

Members

(static) skuuid

barmap

Properties:

extrudingCoord

Properties:

pivotings

Properties:

vectors

Properties:

Methods

(static) debug1()

(static) extrudextr(e)

Parameters:

(static) sankey(ecs, grid, pivotings, json, options) → {object}

Parameters:

Returns:

(static) skUId()

update(tick, entites)

Parameters:

new XSankey(ecs, options, jbar, vectors)

Parameters:

Members

(static) skuuid

barmap

Properties:

extrudingCoord

Properties:

pivotings

Properties:

vectors

Properties:

Methods

(static) debug1()

(static) extrudextr(e)

Parameters:

(static) sankey(ecs, grid, pivotings, json, options) → {object}

Parameters:

Returns:

(static) skUId()

update(tick, entites)

Parameters:

new XSankey()

Members

(static) skuuid

barmap

Properties:

extrudingCoord

Properties:

pivotings

Properties:

vectors

Properties:

Methods

(static) debug1()

(static) extrudextr(e)

Parameters:

(static) sankey(ecs, grid, pivotings, json, options) → {object}

Parameters:

Returns:

(static) skUId()

update(tick, entites)

Parameters:

(static) sankey(ecs, grid, pivotings
, json, options
) → {object}

(static) sankey(ecs, grid, pivotings
, json, options
) → {object}

(static) sankey(ecs, grid, pivotings
, json, options
) → {object}