Class Tap

The <tap> element.

The tap type indicates a tap on the fretboard. The text content allows specification of the notation; + and T are common choices. If the element is empty, the hand attribute is used to specify the symbol to use. The hand attribute is ignored if the tap glyph is already specified by the text content. If neither text content nor the hand attribute are present, the display is application-specific.

See

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

Hierarchy

Implements

XMLElement<"tap", TapAttributes, TapContents>

Constructors

constructor

new Tap(opts?): Tap
Parameters
- Optional opts: {
  attributes?: Partial<TapAttributes>;
  contents?: TapContents;
  }
  - Optional attributes?: Partial<TapAttributes>
  - Optional contents?: TapContents
Returns Tap
- Defined in generated/elements.ts:16733

Properties

attributes

attributes: TapAttributes

contents: TapContents

`Readonly` schema

schema: XMLElementSchema<"tap"> = Tap.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"tap"> = schema.Tap

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHand

getHand(): null | "left" | "right"
Gets

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

getPlacement

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): null | string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHand

setHand(hand): Tap
Sets
Parameters
- hand: null | "left" | "right"
Returns Tap
- Defined in generated/elements.ts:16807

setPlacement

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

setRelativeX

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

setRelativeY

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

setText

setText(text): Tap
Sets
Parameters
- text: null | string
Returns Tap
- Defined in generated/elements.ts:16843

Class Tap

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<TapAttributes>; contents?: TapContents; }

Optional attributes?: Partial<TapAttributes>

Optional contents?: TapContents

Returns Tap

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"

getHand

Returns null | "left" | "right"

getPlacement

Returns null | "above" | "below"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getText

Returns null | string

setColor

Parameters

color: null | string

Returns Tap

setDefaultX

Parameters

defaultX: null | number

Returns Tap

setDefaultY

Parameters

defaultY: null | number

Returns Tap

setFontFamily

Parameters

fontFamily: null | string

Returns Tap

setFontSize

Parameters

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

Returns Tap

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Tap

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns Tap

setHand

Parameters

hand: null | "left" | "right"

Returns Tap

setPlacement

Parameters

placement: null | "above" | "below"

`Optional` opts: {
attributes?: Partial<TapAttributes>;
contents?: TapContents;
}

`Optional` attributes?: Partial<TapAttributes>

`Optional` contents?: TapContents

`Readonly` schema

`Static` `Readonly` schema