Class GroupName

The <group-name> element.

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

See

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

Hierarchy

GroupName

Implements

XMLElement<"group-name", GroupNameAttributes, GroupNameContents>

Constructors

constructor

new GroupName(opts?): GroupName
Parameters
- Optional opts: {
  attributes?: Partial<GroupNameAttributes>;
  contents?: GroupNameContents;
  }
  - Optional attributes?: Partial<GroupNameAttributes>
  - Optional contents?: GroupNameContents
Returns GroupName
- Defined in generated/elements.ts:3967

Properties

attributes

attributes: GroupNameAttributes

contents: GroupNameContents

`Readonly` schema

schema: XMLElementSchema<"group-name"> = GroupName.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"group-name"> = schema.GroupName

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getJustify

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setJustify

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

setRelativeX

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

setRelativeY

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

setText

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

Class GroupName

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<GroupNameAttributes>; contents?: GroupNameContents; }

Optional attributes?: Partial<GroupNameAttributes>

Optional contents?: GroupNameContents

Returns GroupName

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"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getText

Returns string

setColor

Parameters

color: null | string

Returns GroupName

setDefaultX

Parameters

defaultX: null | number

Returns GroupName

setDefaultY

Parameters

defaultY: null | number

Returns GroupName

setFontFamily

Parameters

fontFamily: null | string

Returns GroupName

setFontSize

Parameters

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

Returns GroupName

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns GroupName

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns GroupName

setJustify

Parameters

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

Returns GroupName

setRelativeX

Parameters

relativeX: null | number

Returns GroupName

setRelativeY

`Optional` opts: {
attributes?: Partial<GroupNameAttributes>;
contents?: GroupNameContents;
}

`Optional` attributes?: Partial<GroupNameAttributes>

`Optional` contents?: GroupNameContents

`Readonly` schema

`Static` `Readonly` schema