HED JavaScript Library
    Preparing search index...

    A tag in a HED schema.

    Hierarchy (View Summary)

    Index
    • Constructor.

      Parameters

      • name: string

        The name of this tag.

      • description: string | undefined

        The description of this tag.

      • parentTag: default | undefined

        This tag's parent tag.

      • booleanAttributes: Set<SchemaAttribute>

        The boolean attributes for this tag.

      • valueAttributes: Map<SchemaAttribute, string[]>

        The value attributes for this tag.

      • unitClasses: SchemaUnitClass[]

        The unit classes for this tag.

      • valueClasses: SchemaValueClass[]

        The value classes for this tag.

      Returns default

    _description: string | undefined

    The description of this schema entry.

    _name: string

    The name of this schema entry.

    _parent: default | undefined

    This tag's parent tag.

    _unitClasses: SchemaUnitClass[]

    This tag's unit classes.

    _valueClasses: SchemaValueClass[]

    This tag's value-classes

    _valueTag: any

    This tag's value-taking child.

    booleanAttributeNames: Set<string>

    The set of boolean attribute names this schema entry has.

    booleanAttributes: Set<SchemaAttribute>

    The set of boolean attributes this schema entry has.

    valueAttributeNames: Map<string, string[]>

    The collection of value attribute names this schema entry has.

    valueAttributes: Map<SchemaAttribute, string[]>

    The collection of value attributes this schema entry has.

    IGNORED_ATTRIBUTES: Set<string> = ...

    The attributes ignored when comparing two declarations of an element: inLibrary names the declaring library and hedId differs between schemas by construction.

    • get description(): string | undefined

      The description of this schema entry.

      Returns string | undefined

    • get valueTag(): any

      This tag's value-taking child tag.

      Returns any

    • set valueTag(newValueTag: SchemaValueTag): void

      Set the tag's value-taking child tag.

      A value tag registers itself here from its constructor. When several schemas of a merge group declare the same tag, the first registered value tag is kept and a later equivalent one is ignored; a different one is an error.

      Parameters

      • newValueTag: SchemaValueTag

        The new value-taking child tag.

      Returns void

      If this tag already has a different value tag.

    • Determine if this schema tag is equivalent to another schema tag.

      Schema tags are equivalent if they have the same name, description, and attributes, equivalent parent tags (so the same ancestor path), and either no value tag or equivalent value tags.

      Parameters

      • other: any

        A schema tag to compare with this one.

      Returns boolean

      Whether the other tag is equivalent to this schema tag.

    • Extend this tag's short name.

      Parameters

      • extension: string

        The extension.

      Returns string

      The extended short string.

    • Retrieve a single value of a value attribute (by name) on this schema entry, throwing an error if more than one value exists.

      Parameters

      • attributeName: string

        The attribute whose value should be returned.

      Returns string | undefined

      The value of the attribute.

      If the attribute has more than one value.

    • Extend this tag's long name.

      Parameters

      • extension: string

        The extension.

      Returns string

      The extended long string.