Class HarpPedals

The <harp-pedals> element.

The harp-pedals type is used to create harp pedal diagrams. The pedal-step and pedal-alter elements use the same values as the step and alter elements. For easiest reading, the pedal-tuning elements should follow standard harp pedal order, with pedal-step values of D, C, B, E, F, G, and A.

See

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

Hierarchy

HarpPedals

Implements

XMLElement<"harp-pedals", HarpPedalsAttributes, HarpPedalsContents>

Constructors

constructor

new HarpPedals(opts?): HarpPedals
Parameters
- Optional opts: {
  attributes?: Partial<HarpPedalsAttributes>;
  contents?: HarpPedalsContents;
  }
  - Optional attributes?: Partial<HarpPedalsAttributes>
  - Optional contents?: HarpPedalsContents
Returns HarpPedals
- Defined in generated/elements.ts:28478

Properties

attributes

attributes: HarpPedalsAttributes

contents: HarpPedalsContents

`Readonly` schema

schema: XMLElementSchema<"harp-pedals"> = HarpPedals.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"harp-pedals"> = schema.HarpPedals

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHalign

getHalign(): null | "left" | "center" | "right"
Gets

Returns null | "left" | "center" | "right"
- Defined in generated/elements.ts:28548

getId

getId(): null | string
Gets

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

getPedalTunings

getPedalTunings(): PedalTuning[]
Gets

Returns PedalTuning[]
- Defined in generated/elements.ts:28593

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getValign

getValign(): null | "top" | "middle" | "bottom" | "baseline"
Gets

Returns null | "top" | "middle" | "bottom" | "baseline"
- Defined in generated/elements.ts:28584

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

setHalign(halign): HarpPedals
Sets
Parameters
- halign: null | "left" | "center" | "right"
Returns HarpPedals
- Defined in generated/elements.ts:28552

setId

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

setPedalTunings

setPedalTunings(pedalTunings): HarpPedals
Sets
Parameters
- pedalTunings: PedalTuning[]
Returns HarpPedals
- Defined in generated/elements.ts:28597

setRelativeX

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

setRelativeY

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

setValign

setValign(valign): HarpPedals
Sets
Parameters
- valign: null | "top" | "middle" | "bottom" | "baseline"
Returns HarpPedals
- Defined in generated/elements.ts:28588

Class HarpPedals

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<HarpPedalsAttributes>; contents?: HarpPedalsContents; }

Optional attributes?: Partial<HarpPedalsAttributes>

Optional contents?: HarpPedalsContents

Returns HarpPedals

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"

getHalign

Returns null | "left" | "center" | "right"

getId

Returns null | string

getPedalTunings

Returns PedalTuning[]

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getValign

Returns null | "top" | "middle" | "bottom" | "baseline"

setColor

Parameters

color: null | string

Returns HarpPedals

setDefaultX

Parameters

defaultX: null | number

Returns HarpPedals

setDefaultY

Parameters

defaultY: null | number

Returns HarpPedals

setFontFamily

Parameters

fontFamily: null | string

Returns HarpPedals

setFontSize

Parameters

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

Returns HarpPedals

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns HarpPedals

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns HarpPedals

setHalign

Parameters

halign: null | "left" | "center" | "right"

Returns HarpPedals

setId

`Optional` opts: {
attributes?: Partial<HarpPedalsAttributes>;
contents?: HarpPedalsContents;
}

`Optional` attributes?: Partial<HarpPedalsAttributes>

`Optional` contents?: HarpPedalsContents

`Readonly` schema

`Static` `Readonly` schema