VariableConcept

VariableConcept

new VariableConcept(name, optionsopt)

Source:

Represents a variable concept associated with a DisplayVariablesConcept.

Parameters:
Name Type Attributes Description
name String

The display name of this variable.
options Object <optional>

Options:

Properties
Name Type Attributes Description
parent Concept <optional>

The parent of this variable; if not parent.allowMultiple, parent.toggleActiveItem(variable) is called when toggling on.
active Boolean <optional>

Whether the variable should start active.
color String <optional>

The string description of the color of this variable, if any.
id String <optional>

The id of this variable; defaults to the name (via the parent class Concept).
visible Boolean <optional>

Whether this variable is visible in the NowViewing tab (defaults to True).

Extends

Members

color :String

Source:
Overrides:

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

Type:
  • String

id :String

Source:
Overrides:

Gets or sets the id of the concept item. By default this is the same as the name. It is allowed to be different eg. for csv files with tersely-named columns.

Type:
  • String

isActive :Boolean

Source:
Overrides:

Gets or sets a value indicating whether this variable is currently active. This property is observable.

Type:
  • Boolean

isOpen :Boolean

Source:
Inherited From:

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. Only used if the concept's hasChildren can return true.

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:
Inherited From:

Gets or sets the items contained in this concept. This property is observable. Only used if the concept's hasChildren can return true.

Type:

name :String

Source:
Inherited From:

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

Type:
  • String

parent :Array.<VariableConcept>

Source:

Gets or sets the parent for a node. This property is observable.

Type:

Methods

toggleActive()

Source:
Overrides:

Toggles the VariableConcept#isActive property, by using the parent's toggleActiveItem (if defined), or else manually.

toggleOpen()

Source:
Inherited From:

Toggles the Concept#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.