client/util-crossfilter - Documentation

Utility functions for crossfilter datasets We roughly follow the crossfilter design of dimensions and groups, but we add extra steps to allow transformations on the data.

a datum is turned into a raw value, ie. string or number etc. by rawValueFn
it is then cast to the correct type value using baseValFn
a further transfrom can be applied with valueFn
a value is grouped using groupFn; this value must be either a number or a string.

Source:

util/crossfilter.js, line 1

See:

rawValueFn, baseValueFn, valueFn, groupFn

Methods

(inner) baseValueFn(facet) → {vaseValueCB}

Base value for given facet, ie. cast to correct type or object.

Source:

util/crossfilter.js, line 209

Parameters:

Name	Type	Description
`facet`	`Facet`

Returns:

Type:: vaseValueCB

Base value function for this facet

(inner) groupFn(partition) → {cb}

Create a function that returns the group value for a partition

Source:

util/crossfilter.js, line 464

Parameters:

Name	Type	Description
`partition`	`Partition`

Returns:

Type:: cb

Group function for this partition, taking a Data

(inner) rawValueFn(facet) → {rawValueCB}

Raw value for given facet

Source:

util/crossfilter.js, line 142

Parameters:

Name	Type	Description
`facet`	`Facet`

Returns:

Type:: rawValueCB

Raw value function for this facet

(inner) reduceFn(facet) → {cb}

/** Returns a function for further reducing the crossfilter group to a single value, depending on sum/count/average settings of the Aggregate class.

Source:

util/crossfilter.js, line 39

Parameters:

Name	Type	Description
`facet`	`Aggregate`	The Aggregate class for which to create the reduction function

Returns:

Type:: cb

The required reduction function

(inner) valueFn(facet) → {valueCB}

Create a function that returns the transformed value for this facet

Source:

util/crossfilter.js, line 336

Parameters:

Name	Type	Description
`facet`	`Facet`

Returns:

Type:: valueCB

Value function for this facet

Type Definitions

baseValueCB(d) → {Object}

Returns the base value for a datum

Source:

util/crossfilter.js, line 129

Parameters:

Name	Type	Description
`d`	`Object`	Raw data record

Returns:

Type:: Object

base value

groupCB(d) → {Object}

Returns the grouped value for a transformed value

Source:

util/crossfilter.js, line 451

Parameters:

Name	Type	Description
`d`	`Object`	Transformed value

Returns:

Type:: Object

Group

reduceCB(d) → {number}

Reduce a SubgroupValue to a single number

Source:

util/crossfilter.js, line 23

Parameters:

Name	Type	Description
`d`	`SubgroupValue`	SubgroupValue

Returns:

Type:: number

Reduced value

subgroupAverage(d) → {number}

Source:

util/crossfilter.js, line 73

Parameters:

Name	Type	Description
`d`	`SubgroupValue`

Returns:

Type:: number

d.sum/d.count

subgroupCount(d) → {number}

Source:

util/crossfilter.js, line 57

Parameters:

Name	Type	Description
`d`	`SubgroupValue`

Returns:

Type:: number

count

subgroupStddev(d) → {number}

Source:

util/crossfilter.js, line 90

Parameters:

Name	Type	Description
`d`	`SubgroupValue`

Returns:

Type:: number

stddev(d)

subgroupSum(d) → {number}

Source:

util/crossfilter.js, line 41

Parameters:

Name	Type	Description
`d`	`SubgroupValue`

Returns:

Type:: number

sum

SubgroupValue

Properties:

Name	Type	Description
`count`	`number`	The count of the number of elements in this subgroup
`sum`	`number`	The sum of all elements in this subgroup

Source:

util/crossfilter.js, line 17

Type:

Object

valueCB(d) → {Object}

Returns the transformed value from a base value

Source:

util/crossfilter.js, line 323

Parameters:

Name	Type	Description
`d`	`Object`	Base value

Returns:

Type:: Object

Transformed value