Class Percussion

The <percussion> element.

The percussion element is used to define percussion pictogram symbols. Definitions for these symbols can be found in Kurt Stone's "Music Notation in the Twentieth Century" on pages 206-212 and 223. Some values are added to these based on how usage has evolved in the 30 years since Stone's book was published.

See

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

Hierarchy

Percussion

Implements

XMLElement<"percussion", PercussionAttributes, PercussionContents>

Constructors

constructor

new Percussion(opts?): Percussion
Parameters
- Optional opts: {
  attributes?: Partial<PercussionAttributes>;
  contents?: PercussionContents;
  }
  - Optional attributes?: Partial<PercussionAttributes>
  - Optional contents?: PercussionContents
Returns Percussion
- Defined in generated/elements.ts:30766

Properties

attributes

attributes: PercussionAttributes

contents: PercussionContents

`Readonly` schema

schema: XMLElementSchema<"percussion"> = Percussion.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"percussion"> = schema.Percussion

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getEnclosure

getEnclosure(): null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
Gets

Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
- Defined in generated/elements.ts:30798

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHalign

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

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

getId

getId(): null | string
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getValign

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

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

getValue

getValue(): Glass | Metal | Wood | Pitched | Membrane | Effect | Timpani | Beater | Stick | StickLocation | OtherPercussion
Gets

Returns Glass | Metal | Wood | Pitched | Membrane | Effect | Timpani | Beater | Stick | StickLocation | OtherPercussion
- Defined in generated/elements.ts:30924

setColor

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

setDefaultX

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

setDefaultY

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

setEnclosure

setEnclosure(enclosure): Percussion
Sets
Parameters
- enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
Returns Percussion
- Defined in generated/elements.ts:30818

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

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

setId

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

setRelativeX

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

setRelativeY

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

setValign

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

setValue

setValue(value): Percussion
Sets
Parameters
- value: Glass | Metal | Wood | Pitched | Membrane | Effect | Timpani | Beater | Stick | StickLocation | OtherPercussion
Returns Percussion
- Defined in generated/elements.ts:30939

Class Percussion

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<PercussionAttributes>; contents?: PercussionContents; }

Optional attributes?: Partial<PercussionAttributes>

Optional contents?: PercussionContents

Returns Percussion

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getEnclosure

Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

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

getValign

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

getValue

Returns Glass | Metal | Wood | Pitched | Membrane | Effect | Timpani | Beater | Stick | StickLocation | OtherPercussion

setColor

Parameters

color: null | string

Returns Percussion

setDefaultX

Parameters

defaultX: null | number

Returns Percussion

setDefaultY

Parameters

defaultY: null | number

Returns Percussion

setEnclosure

Parameters

enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

Returns Percussion

setFontFamily

Parameters

fontFamily: null | string

Returns Percussion

setFontSize

Parameters

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

Returns Percussion

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Percussion

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

`Optional` opts: {
attributes?: Partial<PercussionAttributes>;
contents?: PercussionContents;
}

`Optional` attributes?: Partial<PercussionAttributes>

`Optional` contents?: PercussionContents

`Readonly` schema

`Static` `Readonly` schema