Class Distance

The <distance> element.

The distance element represents standard distances between notation elements in tenths. The type attribute defines what type of distance is being defined. Valid values include hyphen (for hyphens in lyrics) and beam.

See

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

Hierarchy

Distance

Implements

XMLElement<"distance", DistanceAttributes, DistanceContents>

Index

Constructors

Properties

attributes contents schema schema

Methods

getDistance getType setDistance setType

Constructors

constructor

new Distance(opts?): Distance
Parameters
- Optional opts: {
  attributes?: Partial<DistanceAttributes>;
  contents?: DistanceContents;
  }
  - Optional attributes?: Partial<DistanceAttributes>
  - Optional contents?: DistanceContents
Returns Distance
- Defined in generated/elements.ts:2197

Properties

attributes

attributes: DistanceAttributes

contents

contents: DistanceContents

`Readonly` schema

schema: XMLElementSchema<"distance"> = Distance.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"distance"> = schema.Distance

Methods

getDistance

getDistance(): number
Gets

Returns number
- Defined in generated/elements.ts:2211

getType

getType(): "beam" | "hyphen"
Gets

Returns "beam" | "hyphen"
- Defined in generated/elements.ts:2202

setDistance

setDistance(distance): Distance
Sets
Parameters
- distance: number
Returns Distance
- Defined in generated/elements.ts:2215

setType

setType(type): Distance
Sets
Parameters
- type: "beam" | "hyphen"
Returns Distance
- Defined in generated/elements.ts:2206

Generated using TypeDoc