Class Text

The <text> element.

The text-element-data type represents a syllable or portion of a syllable for lyric text underlay. A hyphen in the string content should only be used for an actual hyphenated word. Language names for text elements come from ISO 639, with optional country subcodes from ISO 3166.

See

https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/text/

Hierarchy

Text

Implements

XMLElement<"text", TextAttributes, TextContents>

Constructors

constructor

new Text(opts?): Text
Parameters
- Optional opts: {
  attributes?: Partial<TextAttributes>;
  contents?: TextContents;
  }
  - Optional attributes?: Partial<TextAttributes>
  - Optional contents?: TextContents
Returns Text
- Defined in generated/elements.ts:23743

Properties

attributes

attributes: TextAttributes

contents: TextContents

`Readonly` schema

schema: XMLElementSchema<"text"> = Text.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"text"> = schema.Text

Methods

getColor

getColor(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:23748

getDefaultX

getDefaultX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:23757

getDefaultY

getDefaultY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:23766

getDir

getDir(): null | "ltr" | "rtl" | "lro" | "rlo"
Gets

Returns null | "ltr" | "rtl" | "lro" | "rlo"
- Defined in generated/elements.ts:23775

getFontFamily

getFontFamily(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:23784

getFontSize

getFontSize(): null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
Gets

Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
- Defined in generated/elements.ts:23793

getFontStyle

getFontStyle(): null | "normal" | "italic"
Gets

Returns null | "normal" | "italic"
- Defined in generated/elements.ts:23804

getFontWeight

getFontWeight(): null | "normal" | "bold"
Gets

Returns null | "normal" | "bold"
- Defined in generated/elements.ts:23813

getLetterSpacing

getLetterSpacing(): null | number | "normal"
Gets

Returns null | number | "normal"
- Defined in generated/elements.ts:23822

getLineThrough

getLineThrough(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:23831

getOverline

getOverline(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:23840

getRotation

getRotation(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:23849

getText

getText(): string
Gets

Returns string
- Defined in generated/elements.ts:23876

getUnderline

getUnderline(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:23858

getXmlLang

getXmlLang(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:23867

setColor

setColor(color): Text
Sets
Parameters
- color: null | string
Returns Text
- Defined in generated/elements.ts:23752

setDefaultX

setDefaultX(defaultX): Text
Sets
Parameters
- defaultX: null | number
Returns Text
- Defined in generated/elements.ts:23761

setDefaultY

setDefaultY(defaultY): Text
Sets
Parameters
- defaultY: null | number
Returns Text
- Defined in generated/elements.ts:23770

setDir

setDir(dir): Text
Sets
Parameters
- dir: null | "ltr" | "rtl" | "lro" | "rlo"
Returns Text
- Defined in generated/elements.ts:23779

setFontFamily

setFontFamily(fontFamily): Text
Sets
Parameters
- fontFamily: null | string
Returns Text
- Defined in generated/elements.ts:23788

setFontSize

setFontSize(fontSize): Text
Sets
Parameters
- fontSize: null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
Returns Text
- Defined in generated/elements.ts:23797

setFontStyle

setFontStyle(fontStyle): Text
Sets
Parameters
- fontStyle: null | "normal" | "italic"
Returns Text
- Defined in generated/elements.ts:23808

setFontWeight

setFontWeight(fontWeight): Text
Sets
Parameters
- fontWeight: null | "normal" | "bold"
Returns Text
- Defined in generated/elements.ts:23817

setLetterSpacing

setLetterSpacing(letterSpacing): Text
Sets
Parameters
- letterSpacing: null | number | "normal"
Returns Text
- Defined in generated/elements.ts:23826

setLineThrough

setLineThrough(lineThrough): Text
Sets
Parameters
- lineThrough: null | number
Returns Text
- Defined in generated/elements.ts:23835

setOverline

setOverline(overline): Text
Sets
Parameters
- overline: null | number
Returns Text
- Defined in generated/elements.ts:23844

setRotation

setRotation(rotation): Text
Sets
Parameters
- rotation: null | number
Returns Text
- Defined in generated/elements.ts:23853

setText

setText(text): Text
Sets
Parameters
- text: string
Returns Text
- Defined in generated/elements.ts:23880

setUnderline

setUnderline(underline): Text
Sets
Parameters
- underline: null | number
Returns Text
- Defined in generated/elements.ts:23862

setXmlLang

setXmlLang(xmlLang): Text
Sets
Parameters
- xmlLang: null | string
Returns Text
- Defined in generated/elements.ts:23871

Class Text

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<TextAttributes>; contents?: TextContents; }

Optional attributes?: Partial<TextAttributes>

Optional contents?: TextContents

Returns Text

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getDir

Returns null | "ltr" | "rtl" | "lro" | "rlo"

getFontFamily

Returns null | string

getFontSize

Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

getFontStyle

Returns null | "normal" | "italic"

getFontWeight

Returns null | "normal" | "bold"

getLetterSpacing

Returns null | number | "normal"

getLineThrough

Returns null | number

getOverline

Returns null | number

getRotation

Returns null | number

getText

Returns string

getUnderline

Returns null | number

getXmlLang

Returns null | string

setColor

Parameters

color: null | string

Returns Text

setDefaultX

Parameters

defaultX: null | number

Returns Text

setDefaultY

Parameters

defaultY: null | number

Returns Text

setDir

Parameters

dir: null | "ltr" | "rtl" | "lro" | "rlo"

Returns Text

setFontFamily

Parameters

fontFamily: null | string

Returns Text

setFontSize

Parameters

fontSize: null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

Returns Text

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Text

setFontWeight

`Optional` opts: {
attributes?: Partial<TextAttributes>;
contents?: TextContents;
}

`Optional` attributes?: Partial<TextAttributes>

`Optional` contents?: TextContents

`Readonly` schema

`Static` `Readonly` schema