IM-JS

Class: ReferenceMetadata

metadata. ReferenceMetadata

ReferenceMetadata provides additional information about a given Structure or Observation.

The information can be anything, and may include HTML markup. Typical ReferenceMetadata reports may relate to Quality Indicators, such as Collection Methodology, Timeliness, Coverage. It may include footnotes for series, or information about a Dataflow.

ReferenceMetadata may include HTML links to other resources

new ReferenceMetadata()

Methods

getAttributes()

Returns an array of ReferenceMetadataAttributes which contain the metadata text for this report.

Returns:
Type
Array.<metadata.ReferenceMetadataAttribute>

getId()

Returns the unique identifier for this ReferenceMetadata

Returns:
Type
string

getName(lang)

Returns the name of this ReferenceMetadata

Parameters:
Name Type Description
lang

optional. If not provided then it will use the default language as defined by the FusionJS. If no text is available in the default language, then the first text occurrence will be returned
Returns:
Type
string

getSupportedLanguages()

Returns the supported languages for this Reference Metadata.

This will return an array of Strings.

Returns:
Type
Array.<string>