Class Mordent

The <mordent> element.

The mordent element represents the sign with the vertical line. The choice of which mordent sign is inverted differs between MusicXML and SMuFL. The long attribute is "no" by default.

See

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

Hierarchy

Mordent

Implements

XMLElement<"mordent", MordentAttributes, MordentContents>

Constructors

constructor

new Mordent(opts?): Mordent
Parameters
- Optional opts: {
  attributes?: Partial<MordentAttributes>;
  contents?: [];
  }
  - Optional attributes?: Partial<MordentAttributes>
  - Optional contents?: []
Returns Mordent
- Defined in generated/elements.ts:12614

Properties

attributes

attributes: MordentAttributes

contents: []

`Readonly` schema

schema: XMLElementSchema<"mordent"> = Mordent.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"mordent"> = schema.Mordent

Methods

getAccelerate

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

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

getApproach

getApproach(): null | "above" | "below"
Gets

Returns null | "above" | "below"
- Defined in generated/elements.ts:12628

getBeats

getBeats(): null | number
Gets

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

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getDeparture

getDeparture(): null | "above" | "below"
Gets

Returns null | "above" | "below"
- Defined in generated/elements.ts:12673

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getLastBeat

getLastBeat(): null | number
Gets

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

getLong

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

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

getPlacement

getPlacement(): null | "above" | "below"
Gets

Returns null | "above" | "below"
- Defined in generated/elements.ts:12738

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSecondBeat

getSecondBeat(): null | number
Gets

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

getStartNote

getStartNote(): null | "below" | "upper" | "main"
Gets

Returns null | "below" | "upper" | "main"
- Defined in generated/elements.ts:12774

getTrillStep

getTrillStep(): null | "whole" | "half" | "unison"
Gets

Returns null | "whole" | "half" | "unison"
- Defined in generated/elements.ts:12783

getTwoNoteTurn

getTwoNoteTurn(): null | "none" | "whole" | "half"
Gets

Returns null | "none" | "whole" | "half"
- Defined in generated/elements.ts:12792

setAccelerate

setAccelerate(accelerate): Mordent
Sets
Parameters
- accelerate: null | "yes" | "no"
Returns Mordent
- Defined in generated/elements.ts:12623

setApproach

setApproach(approach): Mordent
Sets
Parameters
- approach: null | "above" | "below"
Returns Mordent
- Defined in generated/elements.ts:12632

setBeats

setBeats(beats): Mordent
Sets
Parameters
- beats: null | number
Returns Mordent
- Defined in generated/elements.ts:12641

setColor

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

setDefaultX

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

setDefaultY

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

setDeparture

setDeparture(departure): Mordent
Sets
Parameters
- departure: null | "above" | "below"
Returns Mordent
- Defined in generated/elements.ts:12677

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setLastBeat

setLastBeat(lastBeat): Mordent
Sets
Parameters
- lastBeat: null | number
Returns Mordent
- Defined in generated/elements.ts:12724

setLong

setLong(long): Mordent
Sets
Parameters
- long: null | "yes" | "no"
Returns Mordent
- Defined in generated/elements.ts:12733

setPlacement

setPlacement(placement): Mordent
Sets
Parameters
- placement: null | "above" | "below"
Returns Mordent
- Defined in generated/elements.ts:12742

setRelativeX

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

setRelativeY

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

setSecondBeat

setSecondBeat(secondBeat): Mordent
Sets
Parameters
- secondBeat: null | number
Returns Mordent
- Defined in generated/elements.ts:12769

setStartNote

setStartNote(startNote): Mordent
Sets
Parameters
- startNote: null | "below" | "upper" | "main"
Returns Mordent
- Defined in generated/elements.ts:12778

setTrillStep

setTrillStep(trillStep): Mordent
Sets
Parameters
- trillStep: null | "whole" | "half" | "unison"
Returns Mordent
- Defined in generated/elements.ts:12787

setTwoNoteTurn

setTwoNoteTurn(twoNoteTurn): Mordent
Sets
Parameters
- twoNoteTurn: null | "none" | "whole" | "half"
Returns Mordent
- Defined in generated/elements.ts:12796

Class Mordent

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<MordentAttributes>; contents?: []; }

Optional attributes?: Partial<MordentAttributes>

Optional contents?: []

Returns Mordent

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getAccelerate

Returns null | "yes" | "no"

getApproach

Returns null | "above" | "below"

getBeats

Returns null | number

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getDeparture

Returns null | "above" | "below"

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"

getLastBeat

Returns null | number

getLong

Returns null | "yes" | "no"

getPlacement

Returns null | "above" | "below"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getSecondBeat

Returns null | number

getStartNote

Returns null | "below" | "upper" | "main"

getTrillStep

Returns null | "whole" | "half" | "unison"

getTwoNoteTurn

Returns null | "none" | "whole" | "half"

setAccelerate

Parameters

accelerate: null | "yes" | "no"

Returns Mordent

setApproach

Parameters

approach: null | "above" | "below"

Returns Mordent

setBeats

Parameters

beats: null | number

Returns Mordent

setColor

Parameters

color: null | string

Returns Mordent

setDefaultX

Parameters

defaultX: null | number

`Optional` opts: {
attributes?: Partial<MordentAttributes>;
contents?: [];
}

`Optional` attributes?: Partial<MordentAttributes>

`Optional` contents?: []

`Readonly` schema

`Static` `Readonly` schema