Class AccidentalMark

The <accidental-mark> element.

An accidental-mark can be used as a separate notation or as part of an ornament. When used in an ornament, position and placement are relative to the ornament, not relative to the note.

See

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

Hierarchy

AccidentalMark

Implements

XMLElement<"accidental-mark", AccidentalMarkAttributes, AccidentalMarkContents>

Constructors

constructor

new AccidentalMark(opts?): AccidentalMark
Parameters
- Optional opts: {
  attributes?: Partial<AccidentalMarkAttributes>;
  contents?: AccidentalMarkContents;
  }
  - Optional attributes?: Partial<AccidentalMarkAttributes>
  - Optional contents?: AccidentalMarkContents
Returns AccidentalMark
- Defined in generated/elements.ts:13751

Properties

attributes

attributes: AccidentalMarkAttributes

contents: AccidentalMarkContents

`Readonly` schema

schema: XMLElementSchema<"accidental-mark"> = AccidentalMark.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"accidental-mark"> = schema.AccidentalMark

Methods

getAccidentalValue

getAccidentalValue(): "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
Gets

Returns "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
- Defined in generated/elements.ts:13893

getBracket

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

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

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getId

getId(): null | string
Gets

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

getParentheses

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

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

getPlacement

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSize

getSize(): null | "large" | "cue" | "grace-cue" | "full"
Gets

Returns null | "large" | "cue" | "grace-cue" | "full"
- Defined in generated/elements.ts:13875

getSmufl

getSmufl(): null | string
Gets

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

setAccidentalValue

setAccidentalValue(accidentalValue): AccidentalMark
Sets
Parameters
- accidentalValue: "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
Returns AccidentalMark
- Defined in generated/elements.ts:13938

setBracket

setBracket(bracket): AccidentalMark
Sets
Parameters
- bracket: null | "yes" | "no"
Returns AccidentalMark
- Defined in generated/elements.ts:13760

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setId

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

setParentheses

setParentheses(parentheses): AccidentalMark
Sets
Parameters
- parentheses: null | "yes" | "no"
Returns AccidentalMark
- Defined in generated/elements.ts:13843

setPlacement

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

setRelativeX

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

setRelativeY

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

setSize

setSize(size): AccidentalMark
Sets
Parameters
- size: null | "large" | "cue" | "grace-cue" | "full"
Returns AccidentalMark
- Defined in generated/elements.ts:13879

setSmufl

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

Class AccidentalMark

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<AccidentalMarkAttributes>; contents?: AccidentalMarkContents; }

Optional attributes?: Partial<AccidentalMarkAttributes>

Optional contents?: AccidentalMarkContents

Returns AccidentalMark

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getAccidentalValue

getBracket

Returns null | "yes" | "no"

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"

getId

Returns null | string

getParentheses

Returns null | "yes" | "no"

getPlacement

Returns null | "above" | "below"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getSize

Returns null | "large" | "cue" | "grace-cue" | "full"

getSmufl

Returns null | string

setAccidentalValue

Parameters

Returns AccidentalMark

setBracket

Parameters

bracket: null | "yes" | "no"

Returns AccidentalMark

setColor

Parameters

color: null | string

Returns AccidentalMark

setDefaultX

Parameters

defaultX: null | number

Returns AccidentalMark

setDefaultY

Parameters

defaultY: null | number

Returns AccidentalMark

setFontFamily

Parameters

fontFamily: null | string

Returns AccidentalMark

setFontSize

Parameters

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

Returns AccidentalMark

setFontStyle

`Optional` opts: {
attributes?: Partial<AccidentalMarkAttributes>;
contents?: AccidentalMarkContents;
}

`Optional` attributes?: Partial<AccidentalMarkAttributes>

`Optional` contents?: AccidentalMarkContents

`Readonly` schema

`Static` `Readonly` schema