Class PartName

The <part-name> 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-name/

Hierarchy

PartName

Implements

XMLElement<"part-name", PartNameAttributes, PartNameContents>

Constructors

constructor

new PartName(opts?): PartName
Parameters
- Optional opts: {
  attributes?: Partial<PartNameAttributes>;
  contents?: PartNameContents;
  }
  - Optional attributes?: Partial<PartNameAttributes>
  - Optional contents?: PartNameContents
Returns PartName
- Defined in generated/elements.ts:5963

Properties

attributes

attributes: PartNameAttributes

contents: PartNameContents

`Readonly` schema

schema: XMLElementSchema<"part-name"> = PartName.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"part-name"> = schema.PartName

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getJustify

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

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

getPrintObject

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setJustify

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

setPrintObject

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

setRelativeX

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

setRelativeY

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

setText

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

Class PartName

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<PartNameAttributes>; contents?: PartNameContents; }

Optional attributes?: Partial<PartNameAttributes>

Optional contents?: PartNameContents

Returns PartName

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 PartName

setDefaultX

Parameters

defaultX: null | number

Returns PartName

setDefaultY

Parameters

defaultY: null | number

Returns PartName

setFontFamily

Parameters

fontFamily: null | string

Returns PartName

setFontSize

Parameters

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

Returns PartName

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns PartName

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns PartName

setJustify

Parameters

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

Returns PartName

setPrintObject

Parameters

printObject: null | "yes" | "no"

`Optional` opts: {
attributes?: Partial<PartNameAttributes>;
contents?: PartNameContents;
}

`Optional` attributes?: Partial<PartNameAttributes>

`Optional` contents?: PartNameContents

`Readonly` schema

`Static` `Readonly` schema