Class Key

The <key> element.

The key element represents a key signature. Both traditional and non-traditional key signatures are supported. The optional number attribute refers to staff numbers. If absent, the key signature applies to all staves in the part.

See

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

Hierarchy

Implements

XMLElement<"key", KeyAttributes, KeyContents>

Constructors

constructor

new Key(opts?): Key
Parameters
- Optional opts: {
  attributes?: Partial<KeyAttributes>;
  contents?: KeyContents;
  }
  - Optional attributes?: Partial<KeyAttributes>
  - Optional contents?: KeyContents
Returns Key
- Defined in generated/elements.ts:33145

Properties

attributes

attributes: KeyAttributes

contents: KeyContents

`Readonly` schema

schema: XMLElementSchema<"key"> = Key.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"key"> = schema.Key

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getId

getId(): null | string
Gets

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

getKeyOctaves

getKeyOctaves(): KeyOctave[]
Gets

Returns KeyOctave[]
- Defined in generated/elements.ts:33269

getNumber

getNumber(): null | number
Gets

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

getPrintObject

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getValue

getValue(): TranditionalKey | AlternateKey
Gets

Returns TranditionalKey | AlternateKey
- Defined in generated/elements.ts:33260

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setId

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

setKeyOctaves

setKeyOctaves(keyOctaves): Key
Sets
Parameters
- keyOctaves: KeyOctave[]
Returns Key
- Defined in generated/elements.ts:33273

setNumber

setNumber(number): Key
Sets
Parameters
- number: null | number
Returns Key
- Defined in generated/elements.ts:33228

setPrintObject

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

setRelativeX

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

setRelativeY

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

setValue

setValue(value): Key
Sets
Parameters
- value: TranditionalKey | AlternateKey
Returns Key
- Defined in generated/elements.ts:33264

Class Key

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<KeyAttributes>; contents?: KeyContents; }

Optional attributes?: Partial<KeyAttributes>

Optional contents?: KeyContents

Returns Key

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"

getId

Returns null | string

getKeyOctaves

Returns KeyOctave[]

getNumber

Returns null | number

getPrintObject

Returns null | "yes" | "no"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getValue

Returns TranditionalKey | AlternateKey

setColor

Parameters

color: null | string

Returns Key

setDefaultX

Parameters

defaultX: null | number

Returns Key

setDefaultY

Parameters

defaultY: null | number

Returns Key

setFontFamily

Parameters

fontFamily: null | string

Returns Key

setFontSize

Parameters

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

Returns Key

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Key

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns Key

setId

Parameters

id: null | string

`Optional` opts: {
attributes?: Partial<KeyAttributes>;
contents?: KeyContents;
}

`Optional` attributes?: Partial<KeyAttributes>

`Optional` contents?: KeyContents

`Readonly` schema

`Static` `Readonly` schema