Class Barre

The <barre> element

Parent element: <frame-note>

The <barre> element indicates placing a finger over multiple strings on a single fret.

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

Hierarchy

Barre

Implements

XMLElement<"barre", BarreAttributes, BarreContents>

Index

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

Properties

attributes

attributes: BarreAttributes

contents: []

`Readonly` schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["start", "stop"];
                type: "choices";
            };
        };
    };
    contents: readonly [];
    name: "barre";
} = Barre.schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
    type: {
        type: "required";
        value: {
            choices: readonly ["start", "stop"];
            type: "choices";
        };
    };
}
- Readonly color: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "#000000";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "#000000";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "#000000"
- Readonly type: {
      type: "required";
      value: {
          choices: readonly ["start", "stop"];
          type: "choices";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    choices: readonly ["start", "stop"];
    type: "choices";
    }
    - Readonly choices: readonly ["start", "stop"]
    - Readonly type: "choices"
Readonly contents: readonly []
Readonly name: "barre"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
    type: {
        type: "required";
        value: {
            choices: readonly ["start", "stop"];
            type: "choices";
        };
    };
}
- Readonly color: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "#000000";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "#000000";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "#000000"
- Readonly type: {
      type: "required";
      value: {
          choices: readonly ["start", "stop"];
          type: "choices";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    choices: readonly ["start", "stop"];
    type: "choices";
    }
    - Readonly choices: readonly ["start", "stop"]
    - Readonly type: "choices"
Readonly contents: readonly []
Readonly name: "barre"

Methods

getColor

getColor(): null | string
Gets

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

getType

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

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

setColor

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

setType

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

Class Barre

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<BarreAttributes>; contents?: []; }

Optional attributes?: Partial<BarreAttributes>

Optional contents?: []

Returns Barre

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: { color: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "#000000"; }; }; type: { type: "required"; value: { choices: readonly ["start", "stop"]; type: "choices"; }; }; }

Readonly color: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "#000000"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "#000000"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "#000000"

Readonly type: { type: "required"; value: { choices: readonly ["start", "stop"]; type: "choices"; }; }

Readonly type: "required"

Readonly value: { choices: readonly ["start", "stop"]; type: "choices"; }

Readonly choices: readonly ["start", "stop"]

Readonly type: "choices"

Readonly contents: readonly []

Readonly name: "barre"

Static Readonly schema

Type declaration

Readonly attributes: { color: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "#000000"; }; }; type: { type: "required"; value: { choices: readonly ["start", "stop"]; type: "choices"; }; }; }

Readonly color: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "#000000"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "#000000"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "#000000"

Readonly type: { type: "required"; value: { choices: readonly ["start", "stop"]; type: "choices"; }; }

Readonly type: "required"

Readonly value: { choices: readonly ["start", "stop"]; type: "choices"; }

Readonly choices: readonly ["start", "stop"]

Readonly type: "choices"

Readonly contents: readonly []

Readonly name: "barre"

Methods

getColor

Returns null | string

getType

Returns "start" | "stop"

setColor

Parameters

color: null | string

Returns Barre

setType

Parameters

type: "start" | "stop"

Returns Barre

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<BarreAttributes>;
contents?: [];
}

`Optional` attributes?: Partial<BarreAttributes>

`Optional` contents?: []

`Readonly` schema

`Readonly` attributes: {
color: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
};
};
type: {
type: "required";
value: {
choices: readonly ["start", "stop"];
type: "choices";
};
};
}

`Readonly` color: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "#000000"

`Readonly` type: {
type: "required";
value: {
choices: readonly ["start", "stop"];
type: "choices";
};
}

`Readonly` type: "required"

`Readonly` value: {
choices: readonly ["start", "stop"];
type: "choices";
}

`Readonly` choices: readonly ["start", "stop"]

`Readonly` type: "choices"

`Readonly` contents: readonly []

`Readonly` name: "barre"

`Static` `Readonly` schema

`Readonly` attributes: {
color: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
};
};
type: {
type: "required";
value: {
choices: readonly ["start", "stop"];
type: "choices";
};
};
}

`Readonly` color: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "#000000"

`Readonly` type: {
type: "required";
value: {
choices: readonly ["start", "stop"];
type: "choices";
};
}

`Readonly` type: "required"

`Readonly` value: {
choices: readonly ["start", "stop"];
type: "choices";
}

`Readonly` choices: readonly ["start", "stop"]

`Readonly` type: "choices"

`Readonly` contents: readonly []

`Readonly` name: "barre"