Class OtherOrnament

The <other-ornament> element.

The other-ornament element is used to define any ornaments not yet in the MusicXML format. The smufl attribute can be used to specify a particular ornament, allowing application interoperability without requiring every SMuFL ornament to have a MusicXML element equivalent. Using the other-ornament element without the smufl attribute allows for extended representation, though without application interoperability.

See

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

Hierarchy

OtherOrnament

Implements

XMLElement<"other-ornament", OtherOrnamentAttributes, OtherOrnamentContents>

Constructors

constructor

new OtherOrnament(opts?): OtherOrnament
Parameters
- Optional opts: {
  attributes?: Partial<OtherOrnamentAttributes>;
  contents?: OtherOrnamentContents;
  }
  - Optional attributes?: Partial<OtherOrnamentAttributes>
  - Optional contents?: OtherOrnamentContents
Returns OtherOrnament
- Defined in generated/elements.ts:13557

Properties

attributes

attributes: OtherOrnamentAttributes

contents: OtherOrnamentContents

`Readonly` schema

schema: XMLElementSchema<"other-ornament"> = OtherOrnament.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"other-ornament"> = schema.OtherOrnament

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getPlacement

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSmufl

getSmufl(): null | string
Gets

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

getText

getText(): string
Gets

Returns string
- Defined in generated/elements.ts:13663

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setPlacement

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

setRelativeX

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

setRelativeY

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

setSmufl

setSmufl(smufl): OtherOrnament
Sets
Parameters
- smufl: null | string
Returns OtherOrnament
- Defined in generated/elements.ts:13658

setText

setText(text): OtherOrnament
Sets
Parameters
- text: string
Returns OtherOrnament
- Defined in generated/elements.ts:13667

Class OtherOrnament

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<OtherOrnamentAttributes>; contents?: OtherOrnamentContents; }

Optional attributes?: Partial<OtherOrnamentAttributes>

Optional contents?: OtherOrnamentContents

Returns OtherOrnament

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"

getPlacement

Returns null | "above" | "below"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getSmufl

Returns null | string

getText

Returns string

setColor

Parameters

color: null | string

Returns OtherOrnament

setDefaultX

Parameters

defaultX: null | number

Returns OtherOrnament

setDefaultY

Parameters

defaultY: null | number

Returns OtherOrnament

setFontFamily

Parameters

fontFamily: null | string

Returns OtherOrnament

setFontSize

Parameters

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

Returns OtherOrnament

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns OtherOrnament

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns OtherOrnament

setPlacement

Parameters

placement: null | "above" | "below"

Returns OtherOrnament

setRelativeX

Parameters

relativeX: null | number

`Optional` opts: {
attributes?: Partial<OtherOrnamentAttributes>;
contents?: OtherOrnamentContents;
}

`Optional` attributes?: Partial<OtherOrnamentAttributes>

`Optional` contents?: OtherOrnamentContents

`Readonly` schema

`Static` `Readonly` schema