Class Metronome

The <metronome> element.

The metronome type represents metronome marks and other metric relationships. The beat-unit group and per-minute element specify regular metronome marks. The metronome-note and metronome-relation elements allow for the specification of metric modulations and other metric relationships, such as swing tempo marks where two eighths are equated to a quarter note / eighth note triplet. Tied notes can be represented in both types of metronome marks by using the beat-unit-tied and metronome-tied elements. The parentheses attribute indicates whether or not to put the metronome mark in parentheses; its value is no if not specified. The print-object attribute is set to no in cases where the metronome element represents a relationship or range that is not displayed in the music notation.

See

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

Hierarchy

Metronome

Implements

XMLElement<"metronome", MetronomeAttributes, MetronomeContents>

Constructors

constructor

new Metronome(opts?): Metronome
Parameters
- Optional opts: {
  attributes?: Partial<MetronomeAttributes>;
  contents?: MetronomeContents;
  }
  - Optional attributes?: Partial<MetronomeAttributes>
  - Optional contents?: MetronomeContents
Returns Metronome
- Defined in generated/elements.ts:27997

Properties

attributes

attributes: MetronomeAttributes

contents: MetronomeContents

`Readonly` schema

schema: XMLElementSchema<"metronome"> = Metronome.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"metronome"> = schema.Metronome

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHalign

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

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

getId

getId(): null | string
Gets

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

getJustify

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

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

getMetronome

getMetronome(): BeatSpec | MetronomeSpec
Gets

Returns BeatSpec | MetronomeSpec
- Defined in generated/elements.ts:28139

getParentheses

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

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

getPrintObject

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getValign

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

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

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

setId

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

setJustify

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

setMetronome

setMetronome(metronome): Metronome
Sets
Parameters
- metronome: BeatSpec | MetronomeSpec
Returns Metronome
- Defined in generated/elements.ts:28143

setParentheses

setParentheses(parentheses): Metronome
Sets
Parameters
- parentheses: null | "yes" | "no"
Returns Metronome
- Defined in generated/elements.ts:28098

setPrintObject

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

setRelativeX

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

setRelativeY

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

setValign

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

Class Metronome

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<MetronomeAttributes>; contents?: MetronomeContents; }

Optional attributes?: Partial<MetronomeAttributes>

Optional contents?: MetronomeContents

Returns Metronome

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"

getHalign

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

getId

Returns null | string

getJustify

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

getMetronome

Returns BeatSpec | MetronomeSpec

getParentheses

Returns null | "yes" | "no"

getPrintObject

Returns null | "yes" | "no"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getValign

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

setColor

Parameters

color: null | string

Returns Metronome

setDefaultX

Parameters

defaultX: null | number

Returns Metronome

setDefaultY

Parameters

defaultY: null | number

Returns Metronome

setFontFamily

Parameters

fontFamily: null | string

Returns Metronome

setFontSize

Parameters

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

Returns Metronome

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Metronome

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

`Optional` opts: {
attributes?: Partial<MetronomeAttributes>;
contents?: MetronomeContents;
}

`Optional` attributes?: Partial<MetronomeAttributes>

`Optional` contents?: MetronomeContents

`Readonly` schema

`Static` `Readonly` schema