Class Words

The <words> element.

The words element specifies a standard text direction. The enclosure is none if not specified. The language is Italian ("it") if not specified. Left justification is used if not specified.

See

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

Hierarchy

Words

Implements

XMLElement<"words", WordsAttributes, WordsContents>

Constructors

constructor

new Words(opts?): Words
Parameters
- Optional opts: {
  attributes?: Partial<WordsAttributes>;
  contents?: WordsContents;
  }
  - Optional attributes?: Partial<WordsAttributes>
  - Optional contents?: WordsContents
Returns Words
- Defined in generated/elements.ts:26106

Properties

attributes

attributes: WordsAttributes

contents: WordsContents

`Readonly` schema

schema: XMLElementSchema<"words"> = Words.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"words"> = schema.Words

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getDir

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

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

getEnclosure

getEnclosure(): null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
Gets

Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
- Defined in generated/elements.ts:26147

getFontFamily

getFontFamily(): null | string
Gets

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

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:26199

getFontStyle

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

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

getFontWeight

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

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

getHalign

getHalign(): null | "left" | "center" | "right"
Gets

Returns null | "left" | "center" | "right"
- Defined in generated/elements.ts:26228

getId

getId(): null | string
Gets

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

getJustify

getJustify(): null | "left" | "center" | "right"
Gets

Returns null | "left" | "center" | "right"
- Defined in generated/elements.ts:26246

getLetterSpacing

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

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

getLineHeight

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

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

getLineThrough

getLineThrough(): null | number
Gets

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

getOverline

getOverline(): null | number
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getRotation

getRotation(): null | number
Gets

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

getText

getText(): string
Gets

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

getUnderline

getUnderline(): null | number
Gets

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

getValign

getValign(): null | "top" | "middle" | "bottom" | "baseline"
Gets

Returns null | "top" | "middle" | "bottom" | "baseline"
- Defined in generated/elements.ts:26327

getXmlLang

getXmlLang(): null | string
Gets

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

getXmlSpace

getXmlSpace(): null | "default" | "preserve"
Gets

Returns null | "default" | "preserve"
- Defined in generated/elements.ts:26345

setColor

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

setDefaultX

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

setDefaultY

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

setDir

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

setEnclosure

setEnclosure(enclosure): Words
Sets
Parameters
- enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
Returns Words
- Defined in generated/elements.ts:26167

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

setHalign(halign): Words
Sets
Parameters
- halign: null | "left" | "center" | "right"
Returns Words
- Defined in generated/elements.ts:26232

setId

setId(id): Words
Sets
Parameters
- id: null | string
Returns Words
- Defined in generated/elements.ts:26241

setJustify

setJustify(justify): Words
Sets
Parameters
- justify: null | "left" | "center" | "right"
Returns Words
- Defined in generated/elements.ts:26250

setLetterSpacing

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

setLineHeight

setLineHeight(lineHeight): Words
Sets
Parameters
- lineHeight: null | number | "normal"
Returns Words
- Defined in generated/elements.ts:26268

setLineThrough

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

setOverline

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

setRelativeX

setRelativeX(relativeX): Words
Sets
Parameters
- relativeX: null | number
Returns Words
- Defined in generated/elements.ts:26295

setRelativeY

setRelativeY(relativeY): Words
Sets
Parameters
- relativeY: null | number
Returns Words
- Defined in generated/elements.ts:26304

setRotation

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

setText

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

setUnderline

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

setValign

setValign(valign): Words
Sets
Parameters
- valign: null | "top" | "middle" | "bottom" | "baseline"
Returns Words
- Defined in generated/elements.ts:26331

setXmlLang

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

setXmlSpace

setXmlSpace(xmlSpace): Words
Sets
Parameters
- xmlSpace: null | "default" | "preserve"
Returns Words
- Defined in generated/elements.ts:26349

Class Words

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<WordsAttributes>; contents?: WordsContents; }

Optional attributes?: Partial<WordsAttributes>

Optional contents?: WordsContents

Returns Words

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"

getEnclosure

Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

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"

getHalign

Returns null | "left" | "center" | "right"

getId

Returns null | string

getJustify

Returns null | "left" | "center" | "right"

getLetterSpacing

Returns null | number | "normal"

getLineHeight

Returns null | number | "normal"

getLineThrough

Returns null | number

getOverline

Returns null | number

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getRotation

Returns null | number

getText

Returns string

getUnderline

Returns null | number

getValign

Returns null | "top" | "middle" | "bottom" | "baseline"

getXmlLang

Returns null | string

getXmlSpace

Returns null | "default" | "preserve"

setColor

Parameters

color: null | string

Returns Words

setDefaultX

Parameters

defaultX: null | number

Returns Words

setDefaultY

Parameters

defaultY: null | number

`Optional` opts: {
attributes?: Partial<WordsAttributes>;
contents?: WordsContents;
}

`Optional` attributes?: Partial<WordsAttributes>

`Optional` contents?: WordsContents

`Readonly` schema

`Static` `Readonly` schema