AbsConcept

AbsConcept

new AbsConcept(optionsopt)

Source:

Represents an ABS concept associated with a AbsDataset. An AbsConcept contains an array one of more AbsCodes.

Parameters:
Name Type Attributes Description
options Object <optional>

Object with the following properties:

Properties
Name Type Attributes Description
name String <optional>

The concept's human-readable name, eg. "Region Type".
id Array.<String> <optional>

The concept's id (the name given to it by the ABS), eg. "REGIONTYPE".
codes Array.<Object> <optional>

ABS code objects describing a tree of codes under this concept, eg. [{code: '01_02', description: 'Negative/Nil Income', parentCode: 'TOT', parentDescription: 'Total'}, ...].
filter Array.<String> <optional>

The initial concepts and codes to activate.
allowMultiple Boolean <optional>

Does this concept only allow multiple active children (eg. all except Region type)?
activeItemsChangedCallback function <optional>

A function called when activeItems changes.

Extends

Members

allowMultiple :Boolean

Source:

Flag to say if this if this concept only allows more than one active child. (Defaults to false.)

Type:
  • Boolean

color :String

Source:
Inherited From:

String describing the color of this node, if applicable. This property is observable.

Type:
  • String

id :String

Source:
Overrides:

Gets or sets the name of the concept item. This property is observable.

Type:
  • String

isActive :Boolean

Source:
Inherited From:

Gets or sets a value indicating whether this concept is currently active. Only used if the concept's isSelectable is true.

Type:
  • Boolean

isOpen :Boolean

Source:
Overrides:

Gets or sets a value indicating whether this concept item is currently open. When an item is open, its child items (if any) are visible. This property is observable.

Type:
  • Boolean

isSelectable :Boolean

Source:
Overrides:

Flag to say if this if this node is selectable. This property is observable.

Type:
  • Boolean

isVisible :Boolean

Source:
Inherited From:

Gets or sets a value indicating whether this concept is visible. Defaults to true.

Type:
  • Boolean

items :Array.<AbsConcept>

Source:
Overrides:

Gets the list of absCodes contained in this group. This property is observable.

Type:

name :String

Source:
Inherited From:

Gets or sets the name of the concept item. This property is observable.

Type:
  • String

Methods

toFilter() → {Array.<String>}

Source:

Finds all the active children and recodes them as a 'filter', eg. ['REGION.SA2', 'MEASURE.A02']

Returns:

The active children as a filter.

Type
Array.<String>

toggleActive()

Source:
Inherited From:

Toggles the Concept#isActive property.

toggleOpen()

Source:
Overrides:

Toggles the AbsConcept#isOpen property. If this item's list of children is open, calling this method will close it. If the list is closed, calling this method will open it.