Class Accidental

The <accidental> element.

The accidental type represents actual notated accidentals. Editorial and cautionary indications are indicated by attributes. Values for these attributes are "no" if not present. Specific graphic display such as parentheses, brackets, and size are controlled by the level-display attribute group.

See

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

Hierarchy

Accidental

Implements

XMLElement<"accidental", AccidentalAttributes, AccidentalContents>

Constructors

constructor

new Accidental(opts?): Accidental
Parameters
- Optional opts: {
  attributes?: Partial<AccidentalAttributes>;
  contents?: AccidentalContents;
  }
  - Optional attributes?: Partial<AccidentalAttributes>
  - Optional contents?: AccidentalContents
Returns Accidental
- Defined in generated/elements.ts:8370

Properties

attributes

attributes: AccidentalAttributes

contents: AccidentalContents

`Readonly` schema

schema: XMLElementSchema<"accidental"> = Accidental.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"accidental"> = schema.Accidental

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

getBracket

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

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

getCautionary

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

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

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getEditorial

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

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getParentheses

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSize

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

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

getSmufl

getSmufl(): null | string
Gets

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

setAccidentalValue

setAccidentalValue(accidentalValue): Accidental
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 Accidental
- Defined in generated/elements.ts:8557

setBracket

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

setCautionary

setCautionary(cautionary): Accidental
Sets
Parameters
- cautionary: null | "yes" | "no"
Returns Accidental
- Defined in generated/elements.ts:8388

setColor

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

setDefaultX

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

setDefaultY

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

setEditorial

setEditorial(editorial): Accidental
Sets
Parameters
- editorial: null | "yes" | "no"
Returns Accidental
- Defined in generated/elements.ts:8424

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setParentheses

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

setRelativeX

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

setRelativeY

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

setSize

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

setSmufl

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

Class Accidental

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<AccidentalAttributes>; contents?: AccidentalContents; }

Optional attributes?: Partial<AccidentalAttributes>

Optional contents?: AccidentalContents

Returns Accidental

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getAccidentalValue

getBracket

Returns null | "yes" | "no"

getCautionary

Returns null | "yes" | "no"

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getEditorial

Returns null | "yes" | "no"

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"

getParentheses

Returns null | "yes" | "no"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getSize

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

getSmufl

Returns null | string

setAccidentalValue

Parameters

Returns Accidental

setBracket

Parameters

bracket: null | "yes" | "no"

Returns Accidental

setCautionary

Parameters

cautionary: null | "yes" | "no"

Returns Accidental

setColor

Parameters

color: null | string

Returns Accidental

setDefaultX

Parameters

defaultX: null | number

Returns Accidental

setDefaultY

Parameters

defaultY: null | number

Returns Accidental

setEditorial

Parameters

editorial: null | "yes" | "no"

Returns Accidental

setFontFamily

`Optional` opts: {
attributes?: Partial<AccidentalAttributes>;
contents?: AccidentalContents;
}

`Optional` attributes?: Partial<AccidentalAttributes>

`Optional` contents?: AccidentalContents

`Readonly` schema

`Static` `Readonly` schema