Class PrincipalVoice

The <principal-voice> element.

The principal-voice type represents principal and secondary voices in a score, either for analysis or for square bracket symbols that appear in a score. The element content is used for analysis and may be any text value. The symbol attribute indicates the type of symbol used. When used for analysis separate from any printed score markings, it should be set to none. Otherwise if the type is stop it should be set to plain.

See

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

Hierarchy

PrincipalVoice

Implements

XMLElement<"principal-voice", PrincipalVoiceAttributes, PrincipalVoiceContents>

Constructors

constructor

new PrincipalVoice(opts?): PrincipalVoice
Parameters
- Optional opts: {
  attributes?: Partial<PrincipalVoiceAttributes>;
  contents?: PrincipalVoiceContents;
  }
  - Optional attributes?: Partial<PrincipalVoiceAttributes>
  - Optional contents?: PrincipalVoiceContents
Returns PrincipalVoice
- Defined in generated/elements.ts:29595

Properties

attributes

attributes: PrincipalVoiceAttributes

contents: PrincipalVoiceContents

`Readonly` schema

schema: XMLElementSchema<"principal-voice"> = PrincipalVoice.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"principal-voice"> = schema.PrincipalVoice

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHalign

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

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

getId

getId(): null | string
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSymbol

getSymbol(): "none" | "Hauptstimme" | "Nebenstimme" | "plain"
Gets

Returns "none" | "Hauptstimme" | "Nebenstimme" | "plain"
- Defined in generated/elements.ts:29701

getText

getText(): string
Gets

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

getType

getType(): "start" | "stop"
Gets

Returns "start" | "stop"
- Defined in generated/elements.ts:29710

getValign

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

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

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

setId

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

setRelativeX

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

setRelativeY

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

setSymbol

setSymbol(symbol): PrincipalVoice
Sets
Parameters
- symbol: "none" | "Hauptstimme" | "Nebenstimme" | "plain"
Returns PrincipalVoice
- Defined in generated/elements.ts:29705

setText

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

setType

setType(type): PrincipalVoice
Sets
Parameters
- type: "start" | "stop"
Returns PrincipalVoice
- Defined in generated/elements.ts:29714

setValign

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

Class PrincipalVoice

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<PrincipalVoiceAttributes>; contents?: PrincipalVoiceContents; }

Optional attributes?: Partial<PrincipalVoiceAttributes>

Optional contents?: PrincipalVoiceContents

Returns PrincipalVoice

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

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

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getSymbol

Returns "none" | "Hauptstimme" | "Nebenstimme" | "plain"

getText

Returns string

getType

Returns "start" | "stop"

getValign

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

setColor

Parameters

color: null | string

Returns PrincipalVoice

setDefaultX

Parameters

defaultX: null | number

Returns PrincipalVoice

setDefaultY

Parameters

defaultY: null | number

Returns PrincipalVoice

setFontFamily

Parameters

fontFamily: null | string

Returns PrincipalVoice

setFontSize

Parameters

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

Returns PrincipalVoice

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns PrincipalVoice

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns PrincipalVoice

setHalign

`Optional` opts: {
attributes?: Partial<PrincipalVoiceAttributes>;
contents?: PrincipalVoiceContents;
}

`Optional` attributes?: Partial<PrincipalVoiceAttributes>

`Optional` contents?: PrincipalVoiceContents

`Readonly` schema

`Static` `Readonly` schema