Class Fingering

The <fingering> element.

Fingering is typically indicated 1,2,3,4,5. Multiple fingerings may be given, typically to substitute fingerings in the middle of a note. The substitution and alternate values are "no" if the attribute is not present. For guitar and other fretted instruments, the fingering element represents the fretting finger; the pluck element represents the plucking finger.

See

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

Hierarchy

Fingering

Implements

XMLElement<"fingering", FingeringAttributes, FingeringContents>

Constructors

constructor

new Fingering(opts?): Fingering
Parameters
- Optional opts: {
  attributes?: Partial<FingeringAttributes>;
  contents?: FingeringContents;
  }
  - Optional attributes?: Partial<FingeringAttributes>
  - Optional contents?: FingeringContents
Returns Fingering
- Defined in generated/elements.ts:14929

Properties

attributes

attributes: FingeringAttributes

contents: FingeringContents

`Readonly` schema

schema: XMLElementSchema<"fingering"> = Fingering.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"fingering"> = schema.Fingering

Methods

getAlternate

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

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

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getPlacement

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSubstitution

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

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

getText

getText(): string
Gets

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

setAlternate

setAlternate(alternate): Fingering
Sets
Parameters
- alternate: null | "yes" | "no"
Returns Fingering
- Defined in generated/elements.ts:14938

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setPlacement

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

setRelativeX

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

setRelativeY

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

setSubstitution

setSubstitution(substitution): Fingering
Sets
Parameters
- substitution: null | "yes" | "no"
Returns Fingering
- Defined in generated/elements.ts:15039

setText

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

Class Fingering

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<FingeringAttributes>; contents?: FingeringContents; }

Optional attributes?: Partial<FingeringAttributes>

Optional contents?: FingeringContents

Returns Fingering

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getAlternate

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"

getPlacement

Returns null | "above" | "below"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getSubstitution

Returns null | "yes" | "no"

getText

Returns string

setAlternate

Parameters

alternate: null | "yes" | "no"

Returns Fingering

setColor

Parameters

color: null | string

Returns Fingering

setDefaultX

Parameters

defaultX: null | number

Returns Fingering

setDefaultY

Parameters

defaultY: null | number

Returns Fingering

setFontFamily

Parameters

fontFamily: null | string

Returns Fingering

setFontSize

Parameters

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

Returns Fingering

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Fingering

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns Fingering

setPlacement

`Optional` opts: {
attributes?: Partial<FingeringAttributes>;
contents?: FingeringContents;
}

`Optional` attributes?: Partial<FingeringAttributes>

`Optional` contents?: FingeringContents

`Readonly` schema

`Static` `Readonly` schema