Class Arrow

The <arrow> element.

The arrow element represents an arrow used for a musical technical indication. It can represent both Unicode and SMuFL arrows. The presence of an arrowhead element indicates that only the arrowhead is displayed, not the arrow stem. The smufl attribute distinguishes different SMuFL glyphs that have an arrow appearance such as arrowBlackUp, guitarStrumUp, or handbellsSwingUp. The specified glyph should match the descriptive representation.

See

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

Hierarchy

Arrow

Implements

XMLElement<"arrow", ArrowAttributes, ArrowContents>

Constructors

constructor

new Arrow(opts?): Arrow
Parameters
- Optional opts: {
  attributes?: Partial<ArrowAttributes>;
  contents?: ArrowContents;
  }
  - Optional attributes?: Partial<ArrowAttributes>
  - Optional contents?: ArrowContents
Returns Arrow
- Defined in generated/elements.ts:17736

Properties

attributes

attributes: ArrowAttributes

contents: ArrowContents

`Readonly` schema

schema: XMLElementSchema<"arrow"> = Arrow.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"arrow"> = schema.Arrow

Methods

getArrowDirection

getArrowDirection(): ArrowDirection
Gets

Returns ArrowDirection
- Defined in generated/elements.ts:17842

getArrowStyle

getArrowStyle(): null | ArrowStyle
Gets

Returns null | ArrowStyle
- Defined in generated/elements.ts:17851

getArrowhead

getArrowhead(): null | Arrowhead
Gets

Returns null | Arrowhead
- Defined in generated/elements.ts:17860

getCircularArrow

getCircularArrow(): null | CircularArrow
Gets

Returns null | CircularArrow
- Defined in generated/elements.ts:17869

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getPlacement

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSmufl

getSmufl(): null | string
Gets

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

setArrowDirection

setArrowDirection(arrowDirection): Arrow
Sets
Parameters
- arrowDirection: ArrowDirection
Returns Arrow
- Defined in generated/elements.ts:17846

setArrowStyle

setArrowStyle(arrowStyle): Arrow
Sets
Parameters
- arrowStyle: null | ArrowStyle
Returns Arrow
- Defined in generated/elements.ts:17855

setArrowhead

setArrowhead(arrowhead): Arrow
Sets
Parameters
- arrowhead: null | Arrowhead
Returns Arrow
- Defined in generated/elements.ts:17864

setCircularArrow

setCircularArrow(circularArrow): Arrow
Sets
Parameters
- circularArrow: null | CircularArrow
Returns Arrow
- Defined in generated/elements.ts:17873

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setPlacement

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

setRelativeX

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

setRelativeY

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

setSmufl

setSmufl(smufl): Arrow
Sets
Parameters
- smufl: null | string
Returns Arrow
- Defined in generated/elements.ts:17837

Class Arrow

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<ArrowAttributes>; contents?: ArrowContents; }

Optional attributes?: Partial<ArrowAttributes>

Optional contents?: ArrowContents

Returns Arrow

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getArrowDirection

Returns ArrowDirection

getArrowStyle

Returns null | ArrowStyle

getArrowhead

Returns null | Arrowhead

getCircularArrow

Returns null | CircularArrow

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

getSmufl

Returns null | string

setArrowDirection

Parameters

arrowDirection: ArrowDirection

Returns Arrow

setArrowStyle

Parameters

arrowStyle: null | ArrowStyle

Returns Arrow

setArrowhead

Parameters

arrowhead: null | Arrowhead

Returns Arrow

setCircularArrow

Parameters

circularArrow: null | CircularArrow

Returns Arrow

setColor

Parameters

color: null | string

Returns Arrow

setDefaultX

Parameters

defaultX: null | number

Returns Arrow

setDefaultY

Parameters

defaultY: null | number

Returns Arrow

setFontFamily

`Optional` opts: {
attributes?: Partial<ArrowAttributes>;
contents?: ArrowContents;
}

`Optional` attributes?: Partial<ArrowAttributes>

`Optional` contents?: ArrowContents

`Readonly` schema

`Static` `Readonly` schema