Class Ornaments

The <ornaments> element.

Ornaments can be any of several types, followed optionally by accidentals. The accidental-mark element's content is represented the same as an accidental element, but with a different name to reflect the different musical meaning.

See

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

Hierarchy

Ornaments

Implements

XMLElement<"ornaments", OrnamentsAttributes, OrnamentsContents>

Index

Constructors

constructor

new Ornaments(opts?): Ornaments
Parameters
- Optional opts: {
  attributes?: Partial<OrnamentsAttributes>;
  contents?: OrnamentsContents;
  }
  - Optional attributes?: Partial<OrnamentsAttributes>
  - Optional contents?: OrnamentsContents
Returns Ornaments
- Defined in generated/elements.ts:14026

Properties

attributes

attributes: OrnamentsAttributes

contents: OrnamentsContents

`Readonly` schema

schema: XMLElementSchema<"ornaments"> = Ornaments.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"ornaments"> = schema.Ornaments

Methods

getAccidentalMarks

getAccidentalMarks(): AccidentalMark[]
Gets

Returns AccidentalMark[]
- Defined in generated/elements.ts:14083

getId

getId(): null | string
Gets

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

getValues

getValues(): (TrillMark | Turn | DelayedTurn | InvertedTurn | DelayedInvertedTurn | VerticalTurn | InvertedVerticalTurn | Shake | WavyLine | Mordent | InvertedMordent | Schleifer | Tremolo | Haydn | OtherOrnament)[]
Gets

Returns (TrillMark | Turn | DelayedTurn | InvertedTurn | DelayedInvertedTurn | VerticalTurn | InvertedVerticalTurn | Shake | WavyLine | Mordent | InvertedMordent | Schleifer | Tremolo | Haydn | OtherOrnament)[]
- Defined in generated/elements.ts:14040

setAccidentalMarks

setAccidentalMarks(accidentalMarks): Ornaments
Sets
Parameters
- accidentalMarks: AccidentalMark[]
Returns Ornaments
- Defined in generated/elements.ts:14087

setId

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

setValues

setValues(values): Ornaments
Sets
Parameters
- values: (TrillMark | Turn | DelayedTurn | InvertedTurn | DelayedInvertedTurn | VerticalTurn | InvertedVerticalTurn | Shake | WavyLine | Mordent | InvertedMordent | Schleifer | Tremolo | Haydn | OtherOrnament)[]
Returns Ornaments
- Defined in generated/elements.ts:14060

Class Ornaments

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<OrnamentsAttributes>; contents?: OrnamentsContents; }

Optional attributes?: Partial<OrnamentsAttributes>

Optional contents?: OrnamentsContents

Returns Ornaments

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getAccidentalMarks

Returns AccidentalMark[]

getId

Returns null | string

getValues

Returns (TrillMark | Turn | DelayedTurn | InvertedTurn | DelayedInvertedTurn | VerticalTurn | InvertedVerticalTurn | Shake | WavyLine | Mordent | InvertedMordent | Schleifer | Tremolo | Haydn | OtherOrnament)[]

setAccidentalMarks

Parameters

accidentalMarks: AccidentalMark[]

Returns Ornaments

setId

Parameters

id: null | string

Returns Ornaments

setValues

Parameters

values: (TrillMark | Turn | DelayedTurn | InvertedTurn | DelayedInvertedTurn | VerticalTurn | InvertedVerticalTurn | Shake | WavyLine | Mordent | InvertedMordent | Schleifer | Tremolo | Haydn | OtherOrnament)[]

Returns Ornaments

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<OrnamentsAttributes>;
contents?: OrnamentsContents;
}

`Optional` attributes?: Partial<OrnamentsAttributes>

`Optional` contents?: OrnamentsContents

`Readonly` schema

`Static` `Readonly` schema