Class Rehearsal

The <rehearsal> element.

The rehearsal element specifies letters, numbers, and section names that are notated in the score for reference during rehearsal. The enclosure is square 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/rehearsal/

Hierarchy

Rehearsal

Implements

XMLElement<"rehearsal", RehearsalAttributes, RehearsalContents>

Constructors

constructor

new Rehearsal(opts?): Rehearsal
Parameters
- Optional opts: {
  attributes?: Partial<RehearsalAttributes>;
  contents?: RehearsalContents;
  }
  - Optional attributes?: Partial<RehearsalAttributes>
  - Optional contents?: RehearsalContents
Returns Rehearsal
- Defined in generated/elements.ts:25470

Properties

attributes

attributes: RehearsalAttributes

contents: RehearsalContents

`Readonly` schema

schema: XMLElementSchema<"rehearsal"> = Rehearsal.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"rehearsal"> = schema.Rehearsal

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getDir

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

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

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHalign

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

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

getId

getId(): null | string
Gets

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

getJustify

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

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

getLetterSpacing

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

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

getLineHeight

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

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

getLineThrough

getLineThrough(): null | number
Gets

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

getOverline

getOverline(): null | number
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getRotation

getRotation(): null | number
Gets

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

getText

getText(): string
Gets

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

getUnderline

getUnderline(): null | number
Gets

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

getValign

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

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

getXmlLang

getXmlLang(): null | string
Gets

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

getXmlSpace

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

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

setColor

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

setDefaultX

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

setDefaultY

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

setDir

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

setEnclosure

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

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

setId

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

setJustify

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

setLetterSpacing

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

setLineHeight

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

setLineThrough

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

setOverline

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

setRelativeX

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

setRelativeY

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

setRotation

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

setText

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

setUnderline

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

setValign

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

setXmlLang

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

setXmlSpace

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

Class Rehearsal

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<RehearsalAttributes>; contents?: RehearsalContents; }

Optional attributes?: Partial<RehearsalAttributes>

Optional contents?: RehearsalContents

Returns Rehearsal

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 Rehearsal

setDefaultX

Parameters

defaultX: null | number

Returns Rehearsal

setDefaultY

Parameters

defaultY: null | number

`Optional` opts: {
attributes?: Partial<RehearsalAttributes>;
contents?: RehearsalContents;
}

`Optional` attributes?: Partial<RehearsalAttributes>

`Optional` contents?: RehearsalContents

`Readonly` schema

`Static` `Readonly` schema