Class Barre

The <barre> element.

The barre element indicates placing a finger over multiple strings on a single fret. The type is "start" for the lowest pitched string (e.g., the string with the highest MusicXML number) and is "stop" for the highest pitched string.

See

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

Hierarchy

Barre

Implements

XMLElement<"barre", BarreAttributes, BarreContents>

Index

Constructors

Properties

attributes contents schema schema

Methods

getColor getType setColor setType

Constructors

constructor

new Barre(opts?): Barre
Parameters
- Optional opts: {
  attributes?: Partial<BarreAttributes>;
  contents?: [];
  }
  - Optional attributes?: Partial<BarreAttributes>
  - Optional contents?: []
Returns Barre
- Defined in generated/elements.ts:38320

Properties

attributes

attributes: BarreAttributes

contents

contents: []

`Readonly` schema

schema: XMLElementSchema<"barre"> = Barre.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"barre"> = schema.Barre

Methods

getColor

getColor(): null | string
Gets

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

getType

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

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

setColor

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

setType

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

Generated using TypeDoc