Show:

ia.TableConfig Class

Extends ia.ComponentConfig
Defined in: ia\config\TableConfig.js:1
Module: ia

Contains the configuration information for a table.

Constructor

ia.TableConfig

(
  • xml
)

Defined in ia\config\TableConfig.js:1

Parameters:

  • xml XML

    The XML data that describes the table.

Methods

_parseButtonXML

(
  • xml
)
protected

Inherited from ia.WidgetConfig: ia\config\WidgetConfig.js:35

Protected method to be used by subclasses when parsing xml.

Parameters:

  • xml XML

    The xml data.

_parseComponentXML

(
  • xml
)
protected

Inherited from ia.ComponentConfig: ia\config\ComponentConfig.js:28

Protected method to be used by subclasses when parsing xml.

Parameters:

  • xml XML

    The xml data.

_parseTableXML

(
  • xml
)
protected

Defined in ia\config\TableConfig.js:28

Protected method to be used by subclasses when parsing xml.

Parameters:

  • xml XML

    The xml data.

getColumn

(
  • id
)
Object

Defined in ia\config\TableConfig.js:90

Returns the column that corresponds to the given id.

The column is an object with the following structure:

{id:"name", formattedId:"name_formatted", label:"Features", type:"categoric" width:0.25}

Parameters:

  • id String

    The id.

Returns:

Object: The column object.

getColumns

() Object

Defined in ia\config\TableConfig.js:103

Returns the table columns.

The array of columns has the following structure:

[{id:"name", formattedId:"name_formatted", label:"Features", width:0.25},
{id:"value", formattedId:"value_formatted", label:"Indicator", width:0.25},
{id:"associate1", formattedId:"associate1_formatted", label:"Associate 1", width:0.25},
{id:"associate2", formattedId:"associate2_formatted" label:"Associate 2", width:0.25}]

Returns:

Object: An array of column objects.

getColumnsForIndicator

(
  • indicator
  • substitution
)
Object

Defined in ia\config\TableConfig.js:118

Returns the table columns for the given indicator.

The array of columns has the following structure:

[{id:"name", formattedId:"name_formatted", label:"Features", width:0.25},
{id:"value", formattedId:"value_formatted", label:"Indicator", width:0.25},
{id:"associate1", formattedId:"associate1_formatted", label:"Associate 1", width:0.25},
{id:"associate2", formattedId:"associate2_formatted" label:"Associate 2", width:0.25}]

Parameters:

Returns:

Object: The array of columns.

getColumnsForIndicators

(
  • indicators
  • substitution
)
Object

Defined in ia\config\TableConfig.js:166

Returns the table columns for an array of indicators.

The array of columns has the following structure:

[{id:"name", formattedId:"name_formatted", label:"Features", width:0.25},
{id:"value", formattedId:"value_formatted", label:"Indicator", width:0.25},
{id:"associate1", formattedId:"associate1_formatted", label:"Associate 1", width:0.25},
{id:"associate2", formattedId:"associate2_formatted" label:"Associate 2", width:0.25}]

Parameters:

Returns:

Object: The array of columns.

getProperties

() Associative Array

Inherited from ia.WidgetConfig: ia\config\WidgetConfig.js:131

Returns the widgets properties.

Returns:

Associative Array: properties[propertyId] = property.

getProperty

(
  • id
)
Number | String

Inherited from ia.WidgetConfig: ia\config\WidgetConfig.js:139

Gets the value for the property with the given id.

Parameters:

  • id String

    The property id.

Returns:

Number | String: The property value.

parseXML

(
  • xml
)

Inherited from ia.WidgetConfig but overwritten in ia\config\TableConfig.js:17

Parses in an XML object containing the configuration xml.

Parameters:

  • xml XML

    The xml data.

setProperty

(
  • id
  • value
  • castValue
)

Inherited from ia.WidgetConfig: ia\config\WidgetConfig.js:153

Sets the value for the property with the given id.

Parameters:

  • id String

    The property id.

  • value Number | String

    The property value.

  • castValue Boolean

    Indicates the value is a string and needs to be cast to the correct data type.

Properties

customColumns

object} Array of columns.

Defined in ia\config\TableConfig.js:82

Custom columns that can be used instead of those defined in the config.

properties

Associative Array

Inherited from ia.WidgetConfig: ia\config\WidgetConfig.js:123

The widgets properties, properties[propertyId] = property.

type

String

Inherited from ia.WidgetConfig: ia\config\WidgetConfig.js:115

The widget node type 'component', 'table', 'button', 'text' or 'image'.

xml

XML

Inherited from ia.WidgetConfig but overwritten in ia\config\WidgetConfig.js:16

The raw xml data describing the object.