IM-JS

Class: DataSetCode

data. DataSetCode

A DataSetCode is a Id value pair, and is used to define a particular facet of an @see Observation.

A DataSetCode directly relates to a @see Code, the only difference being that a DataSetCode is used in the context of a @see DataSet and whereas a @see Code is used in the context of a @see Topic and contains selection state

new DataSetCode()

Methods

getActualObs()

Returns the number of observations that would be returned from selecting this code in a data query

Returns:
Type
number

getActualObs()

Returns the number of observations that would be returned from selecting this code in a data query

Returns:
Type
number

getEndPeriod()

If this code is defining a date, this method will return the start of the period in the format YYYY-MM-DDTHH:mm:ss

Returns:
Type
string
Example
2002-12-31T23:59:59

getId()

Returns the identifier for this code, this will match the id of the corresponding @see @{link Code} for example 'AR'

Returns:
Type
string

getMetadata(callback)

Returns the fully resolved array of @see metadata.ReferenceMetadata

Parameters:
Name Type Description
callback function

getMetadataDefs()

Returns an array of @see metadata.ReferenceMetadataLink, or an empty array if there are none

getName()

Returns the human readable name for this code, for example 'Argentina'

Returns:
Type
string

getParentComponent()

Returns the @see DataSetComponent that owns this code

Returns:
Type
DataSetComponent

getStartPeriod()

If this code is defining a date, this method will return the start of the period in the format YYYY-MM-DDTHH:mm:ss

Returns:
Type
string
Example
2010-01-01T00:00:00

hasMetadata()

Returns true if there are @see metadata.ReferenceMetadataLink attached to this object

See:
  • ReferenceMetadataLink.js
Returns:
Type
boolean

isDate()

Returns true if this code is defining a date, in which case the getStartPeriod and getEndPeriod methods will return a value

Returns:
Type
boolean