Class PartAbbreviation

The <part-abbreviation> element.

The part-name type describes the name or abbreviation of a score-part element. Formatting attributes for the part-name element are deprecated in Version 2.0 in favor of the new part-name-display and part-abbreviation-display elements.

See

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

Hierarchy

PartAbbreviation

Implements

XMLElement<"part-abbreviation", PartAbbreviationAttributes, PartAbbreviationContents>

Constructors

constructor

new PartAbbreviation(opts?): PartAbbreviation
Parameters
- Optional opts: {
  attributes?: Partial<PartAbbreviationAttributes>;
  contents?: PartAbbreviationContents;
  }
  - Optional attributes?: Partial<PartAbbreviationAttributes>
  - Optional contents?: PartAbbreviationContents
Returns PartAbbreviation
- Defined in generated/elements.ts:6159

Properties

attributes

attributes: PartAbbreviationAttributes

contents: PartAbbreviationContents

`Readonly` schema

schema: XMLElementSchema<"part-abbreviation"> = PartAbbreviation.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"part-abbreviation"> = schema.PartAbbreviation

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getJustify

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

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

getPrintObject

getPrintObject(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:6238

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setJustify

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

setPrintObject

setPrintObject(printObject): PartAbbreviation
Sets
Parameters
- printObject: null | "yes" | "no"
Returns PartAbbreviation
- Defined in generated/elements.ts:6242

setRelativeX

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

setRelativeY

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

setText

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

Class PartAbbreviation

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<PartAbbreviationAttributes>; contents?: PartAbbreviationContents; }

Optional attributes?: Partial<PartAbbreviationAttributes>

Optional contents?: PartAbbreviationContents

Returns PartAbbreviation

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"

getJustify

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

getPrintObject

Returns null | "yes" | "no"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getText

Returns string

setColor

Parameters

color: null | string

Returns PartAbbreviation

setDefaultX

Parameters

defaultX: null | number

Returns PartAbbreviation

setDefaultY

Parameters

defaultY: null | number

Returns PartAbbreviation

setFontFamily

Parameters

fontFamily: null | string

Returns PartAbbreviation

setFontSize

Parameters

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

Returns PartAbbreviation

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns PartAbbreviation

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns PartAbbreviation

setJustify

Parameters

justify: null | "left" | "center" | "right"

Returns PartAbbreviation

setPrintObject

Parameters

printObject: null | "yes" | "no"

`Optional` opts: {
attributes?: Partial<PartAbbreviationAttributes>;
contents?: PartAbbreviationContents;
}

`Optional` attributes?: Partial<PartAbbreviationAttributes>

`Optional` contents?: PartAbbreviationContents

`Readonly` schema

`Static` `Readonly` schema