Class ParsedHedColumnSplice

A template for an inline column splice in a HED string.

See

Hierarchy (View Summary)

ParsedHedSubstring
- ParsedHedColumnSplice

Index

Constructors

Properties

originalBounds originalTag

Accessors

Methods

equivalent format toString

Constructors

constructor

new ParsedHedColumnSplice(
columnName: string,
bounds: number[],
): ParsedHedColumnSplice
Constructor.
Parameters
- columnName: string
  The token for this tag.
- bounds: number[]
  The collection of HED schemas.
Returns ParsedHedColumnSplice
Overrides ParsedHedSubstring.constructor
- Defined in src/parser/parsedHedColumnSplice.js:25

Properties

originalBounds

originalBounds: int[]

The bounds of the HED tag in the original HED string.

originalTag

originalTag: string

The original pre-parsed version of the HED tag.

Accessors

normalized

get normalized(): string
Get the normalized version of the object.

Returns string
Overrides ParsedHedSubstring.normalized
- Defined in src/parser/parsedHedColumnSplice.js:35

Methods

equivalent

equivalent(other: ParsedHedColumnSplice): boolean
Determine if this column splice is equivalent to another.
Parameters
- other: ParsedHedColumnSplice
  The other column splice.
Returns boolean
Whether the two column splices are equivalent.
- Defined in src/parser/parsedHedColumnSplice.js:56

format

format(long?: boolean): string
Nicely format this column splice template.
Parameters
- long: boolean = true
  Whether the tags should be in long form.
Returns string
The formatted column splice template.
Overrides ParsedHedSubstring.format
- Defined in src/parser/parsedHedColumnSplice.js:46

toString

toString(): string
Override of Object.prototype.toString.

Returns string
The original form of this HED substring.
Inherited from ParsedHedSubstring.toString
- Defined in src/parser/parsedHedSubstring.js:52