Class PullOff

The <pull-off> element.

The hammer-on and pull-off elements are used in guitar and fretted instrument notation. Since a single slur can be marked over many notes, the hammer-on and pull-off elements are separate so the individual pair of notes can be specified. The element content can be used to specify how the hammer-on or pull-off should be notated. An empty element leaves this choice up to the application.

See

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

Hierarchy

PullOff

Implements

XMLElement<"pull-off", PullOffAttributes, PullOffContents>

Constructors

constructor

new PullOff(opts?): PullOff
Parameters
- Optional opts: {
  attributes?: Partial<PullOffAttributes>;
  contents?: PullOffContents;
  }
  - Optional attributes?: Partial<PullOffAttributes>
  - Optional contents?: PullOffContents
Returns PullOff
- Defined in generated/elements.ts:16135

Properties

attributes

attributes: PullOffAttributes

contents: PullOffContents

`Readonly` schema

schema: XMLElementSchema<"pull-off"> = PullOff.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"pull-off"> = schema.PullOff

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getNumber

getNumber(): null | number
Gets

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

getPlacement

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

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

getType

getType(): "start" | "stop"
Gets

Returns "start" | "stop"
- Defined in generated/elements.ts:16241

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setNumber

setNumber(number): PullOff
Sets
Parameters
- number: null | number
Returns PullOff
- Defined in generated/elements.ts:16209

setPlacement

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

setRelativeX

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

setRelativeY

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

setText

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

setType

setType(type): PullOff
Sets
Parameters
- type: "start" | "stop"
Returns PullOff
- Defined in generated/elements.ts:16245

Class PullOff

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<PullOffAttributes>; contents?: PullOffContents; }

Optional attributes?: Partial<PullOffAttributes>

Optional contents?: PullOffContents

Returns PullOff

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"

getNumber

Returns null | number

getPlacement

Returns null | "above" | "below"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getText

Returns string

getType

Returns "start" | "stop"

setColor

Parameters

color: null | string

Returns PullOff

setDefaultX

Parameters

defaultX: null | number

Returns PullOff

setDefaultY

Parameters

defaultY: null | number

Returns PullOff

setFontFamily

Parameters

fontFamily: null | string

Returns PullOff

setFontSize

Parameters

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

Returns PullOff

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns PullOff

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns PullOff

setNumber

Parameters

number: null | number

Returns PullOff

setPlacement

`Optional` opts: {
attributes?: Partial<PullOffAttributes>;
contents?: PullOffContents;
}

`Optional` attributes?: Partial<PullOffAttributes>

`Optional` contents?: PullOffContents

`Readonly` schema

`Static` `Readonly` schema