Class Tag

attributes

expression

• get expression(): Composite | null

  The value parsed as an expression, so that any %{...} meta expressions it contains can be evaluated. Set by the parser; derived lazily for tags built by other means. null when the value contains no meta expressions.

  Returns Composite | null

name

• get name(): string

  The tag full name. When the original tag used the short name, name will return the full name.

  Returns string

  Member

originalName

• get originalName(): string

  The original tag name that was used to construct the tag.

  Returns string

  Member

value

• get value(): string

  The tag value

  Returns string

  Member

clone

• clone(): Tag

  Returns a clone of the tag.

  Returns Tag

  The cloned tag

hasRenderableLabel

• hasRenderableLabel(): boolean

  Check whether this tag's label (if any) should be rendered, as applicable to tags like start_of_verse and start_of_chorus. See https://chordpro.org/chordpro/directives-env_chorus/, https://chordpro.org/chordpro/directives-env_verse/, https://chordpro.org/chordpro/directives-env_bridge/, https://chordpro.org/chordpro/directives-env_tab/

  Returns boolean

hasValue

• hasValue(): boolean

  Checks whether the tag value is a non-empty string.

  Returns boolean

isComment

• isComment(): boolean

  Checks whether the tag is a comment tag ({comment} or {c}).

  Returns boolean

isImage

• isImage(): boolean

  Checks whether the tag is an image tag ({image}).

  Returns boolean

isMetaTag

• isMetaTag(): boolean

  Checks whether the tag is a standard meta tag, a custom meta directive ({x_some_name}) or a non-standard meta tag ({meta: name value})

  Returns boolean

isRenderable

• isRenderable(): boolean

  Checks whether the tag is usually rendered inline. It currently only applies to comment tags.

  Returns boolean

isStandardOrCustomMetaTag

• isStandardOrCustomMetaTag(): boolean

  Checks whether this tag is a standard meta tag or a custom meta directive ({x_some_name})

  Returns boolean

toString

• toString(): string

  Returns a string representation of an object.

  Returns string