Class MeasureNumbering

The <measure-numbering> element.

The measure-numbering type describes how frequently measure numbers are displayed on this part. The text attribute from the measure element is used for display, or the number attribute if the text attribute is not present. Measures with an implicit attribute set to "yes" never display a measure number, regardless of the measure-numbering setting.

The optional staff attribute refers to staff numbers within the part, from top to bottom on the system. It indicates which staff is used as the reference point for vertical positioning. A value of 1 is assumed if not present.

The optional multiple-rest-always and multiple-rest-range attributes describe how measure numbers are shown on multiple rests when the measure-numbering value is not set to none. The multiple-rest-always attribute is set to yes when the measure number should always be shown, even if the multiple rest starts midway through a system when measure numbering is set to system level. The multiple-rest-range attribute is set to yes when measure numbers on multiple rests display the range of numbers for the first and last measure, rather than just the number of the first measure.

See

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

Hierarchy

MeasureNumbering

Implements

XMLElement<"measure-numbering", MeasureNumberingAttributes, MeasureNumberingContents>

Constructors

constructor

new MeasureNumbering(opts?): MeasureNumbering
Parameters
- Optional opts: {
  attributes?: Partial<MeasureNumberingAttributes>;
  contents?: MeasureNumberingContents;
  }
  - Optional attributes?: Partial<MeasureNumberingAttributes>
  - Optional contents?: MeasureNumberingContents
Returns MeasureNumbering
- Defined in generated/elements.ts:39711

Properties

attributes

attributes: MeasureNumberingAttributes

contents: MeasureNumberingContents

`Readonly` schema

schema: XMLElementSchema<"measure-numbering"> = MeasureNumbering.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"measure-numbering"> = schema.MeasureNumbering

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHalign

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

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

getMeasureNumberValue

getMeasureNumberValue(): "none" | "measure" | "system"
Gets

Returns "none" | "measure" | "system"
- Defined in generated/elements.ts:39853

getMultipleRestAlways

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

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

getMultipleRestRange

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getStaff

getStaff(): null | number
Gets

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

getSystem

getSystem(): null | "none" | "only-top" | "also-top" | "only-bottom" | "also-bottom"
Gets

Returns null | "none" | "only-top" | "also-top" | "only-bottom" | "also-bottom"
- Defined in generated/elements.ts:39835

getValign

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

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

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

setMeasureNumberValue

setMeasureNumberValue(measureNumberValue): MeasureNumbering
Sets
Parameters
- measureNumberValue: "none" | "measure" | "system"
Returns MeasureNumbering
- Defined in generated/elements.ts:39857

setMultipleRestAlways

setMultipleRestAlways(multipleRestAlways): MeasureNumbering
Sets
Parameters
- multipleRestAlways: null | "yes" | "no"
Returns MeasureNumbering
- Defined in generated/elements.ts:39794

setMultipleRestRange

setMultipleRestRange(multipleRestRange): MeasureNumbering
Sets
Parameters
- multipleRestRange: null | "yes" | "no"
Returns MeasureNumbering
- Defined in generated/elements.ts:39803

setRelativeX

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

setRelativeY

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

setStaff

setStaff(staff): MeasureNumbering
Sets
Parameters
- staff: null | number
Returns MeasureNumbering
- Defined in generated/elements.ts:39830

setSystem

setSystem(system): MeasureNumbering
Sets
Parameters
- system: null | "none" | "only-top" | "also-top" | "only-bottom" | "also-bottom"
Returns MeasureNumbering
- Defined in generated/elements.ts:39839

setValign

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

Class MeasureNumbering

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<MeasureNumberingAttributes>; contents?: MeasureNumberingContents; }

Optional attributes?: Partial<MeasureNumberingAttributes>

Optional contents?: MeasureNumberingContents

Returns MeasureNumbering

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"

getMeasureNumberValue

Returns "none" | "measure" | "system"

getMultipleRestAlways

Returns null | "yes" | "no"

getMultipleRestRange

Returns null | "yes" | "no"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getStaff

Returns null | number

getSystem

Returns null | "none" | "only-top" | "also-top" | "only-bottom" | "also-bottom"

getValign

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

setColor

Parameters

color: null | string

Returns MeasureNumbering

setDefaultX

Parameters

defaultX: null | number

Returns MeasureNumbering

setDefaultY

Parameters

defaultY: null | number

Returns MeasureNumbering

setFontFamily

Parameters

fontFamily: null | string

Returns MeasureNumbering

setFontSize

Parameters

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

Returns MeasureNumbering

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns MeasureNumbering

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

`Optional` opts: {
attributes?: Partial<MeasureNumberingAttributes>;
contents?: MeasureNumberingContents;
}

`Optional` attributes?: Partial<MeasureNumberingAttributes>

`Optional` contents?: MeasureNumberingContents

`Readonly` schema

`Static` `Readonly` schema