Facet

Facet

new Facet()

Facets are the main abstraction over the data.

A Dataset is a collection of (similar) items, with each item having a certain set of properties, ie. Facets. The Facet class defines the property: It can be a continuous value, a set of labels or tags, or it can be result of some transformation or equation.

Source:

Extends

Members

(static) accessor :string

The accessor for this facet. For nested properties use dot notation: For a dataset [ {name: {first: "Santa", last: "Claus"}}, ...] you can use name.first and name.last to get Santa and Claus, respectively.

Type:
  • string
Source:

(static) active :boolean

Show facet bar (on Analyze page)

Type:
  • boolean
Source:

(static) categorialTransform :CategorialTransform

A categorial transformation to apply to the data

Type:
Source:

(static) continuousTransform :ContinuousTransform

A continuous transformation to apply to the data

Type:
Source:

(static) description :string

Description of this facet, for displaying purposes

Type:
  • string
Source:

(static, readonly) displayType :string

The actual type of the facet after transformation. Do not check directly, but use displayConstant, displayContinuous, displayCategorial, displayDatetime

Type:
  • string
Source:

(static, readonly) maxval :number|datetime

For continuous or datetime Facets, the maximum value.

Type:
  • number | datetime
Source:

(static) maxvalAsText :string

For continuous or datetime Facets, the maximum value as text. Parsed value available in the maxval property

Type:
  • string
Source:

(static, readonly) minval :number|datetime

For continuous or datetime Facets, the minimum value.

Type:
  • number | datetime
Source:

(static) minvalAsText :string

For continuous or datetime Facets, the minimum value as text. Parsed value available in the minval property

Type:
  • string
Source:

(static, readonly) misval :Array.<Object>

Array of missing data indicators

Type:
  • Array.<Object>
Source:

(static) misvalAsText :string

Missing or invalid data indicator; for multiple values, use a comma separated, quoted list Numbers, strings, booleans, and the special value null are allowed. Use single or double quotes for strings "missing". The parsed values are available in the misval property.

Type:
  • string
Source:

(static) name :string

Short name for this facet, for displaying purposes

Type:
  • string
Source:

(static) show :boolean

Show in facet lists (used for interactive searching on Facets page)

Type:
  • boolean
Source:

(static) timeTransform :TimeTransform

A time (or duration) transformation to apply to the data

Type:
Source:

(static) type :string

Type of this facet:

  • constant A constant value of "1" for all data items
  • continuous The facet takes on real numbers
  • categorial The facet is a string, or an array of strings (for labels and tags)
  • timeorduration The facet is a datetime (using momentjs) Check for facet type using isConstant, isContinuous, isCategorial, or isTimeOrDuration properties.
Type:
  • string
Source:

(static) units :string

For continuous facets, its units for displaying purposes

Type:
  • string
Source:

Methods

(abstract, static) setCategories()

setCategories finds finds all values on an ordinal (categorial) axis. Updates the categorialTransform property of the facet

Source:

(abstract, static) setExceedances()

Calculate value where exceedance probability is one in 10,20,30,40,50, and the same for -exceedance -50, -60, -70, -80, -90, -99, -99.9, -99.99, ... percent Approximate from data: 1 in 10 is larger than value at index trunc(0.1 * len(data))

Source:

(abstract, static) setMinMax()

setMinMax finds the range of a continuous facet,

Source:

(abstract, static) setPercentiles()

Calculate 100 percentiles (ie. 1,2,3,4 etc.) Use the recommended method from NIST See also the discussion on Wikipedia

Source: