Class Pluck

The <pluck> element.

The pluck element is used to specify the plucking fingering on a fretted instrument, where the fingering element refers to the fretting fingering. Typical values are p, i, m, a for pulgar/thumb, indicio/index, medio/middle, and anular/ring fingers.

See

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

Hierarchy

Pluck

Implements

XMLElement<"pluck", PluckAttributes, PluckContents>

Constructors

constructor

new Pluck(opts?): Pluck
Parameters
- Optional opts: {
  attributes?: Partial<PluckAttributes>;
  contents?: PluckContents;
  }
  - Optional attributes?: Partial<PluckAttributes>
  - Optional contents?: PluckContents
Returns Pluck
- Defined in generated/elements.ts:15085

Properties

attributes

attributes: PluckAttributes

contents: PluckContents

`Readonly` schema

schema: XMLElementSchema<"pluck"> = Pluck.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"pluck"> = schema.Pluck

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getPlacement

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setPlacement

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

setRelativeX

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

setRelativeY

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

setText

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

Class Pluck

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<PluckAttributes>; contents?: PluckContents; }

Optional attributes?: Partial<PluckAttributes>

Optional contents?: PluckContents

Returns Pluck

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

getText

Returns string

setColor

Parameters

color: null | string

Returns Pluck

setDefaultX

Parameters

defaultX: null | number

Returns Pluck

setDefaultY

Parameters

defaultY: null | number

Returns Pluck

setFontFamily

Parameters

fontFamily: null | string

Returns Pluck

setFontSize

Parameters

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

Returns Pluck

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Pluck

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns Pluck

setPlacement

Parameters

placement: null | "above" | "below"

Returns Pluck

setRelativeX

Parameters

relativeX: null | number

Returns Pluck

setRelativeY

`Optional` opts: {
attributes?: Partial<PluckAttributes>;
contents?: PluckContents;
}

`Optional` attributes?: Partial<PluckAttributes>

`Optional` contents?: PluckContents

`Readonly` schema

`Static` `Readonly` schema