Class BarStyle

The <bar-style> element

Parent element: <barline>

The <bar-style> element contains barline style and color information.

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

Hierarchy

BarStyle

Implements

XMLElement<"bar-style", BarStyleAttributes, BarStyleContents>

Index

Constructors

constructor

new BarStyle(opts?): BarStyle
Parameters
- Optional opts: {
  attributes?: Partial<BarStyleAttributes>;
  contents?: BarStyleContents;
  }
  - Optional attributes?: Partial<BarStyleAttributes>
  - Optional contents?: BarStyleContents
Returns BarStyle
- Defined in generated/elements.ts:58268

Properties

attributes

attributes: BarStyleAttributes

contents: BarStyleContents

`Readonly` schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "bar-style";
            type: "label";
            value: {
                choices: readonly ["none", "dashed", "dotted", "heavy", "heavy-heavy", "heavy-light", "light-heavy", "light-light", "regular", "short", "tick"];
                type: "choices";
            };
        };
    }];
    name: "bar-style";
} = BarStyle.schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
}
- 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 contents: readonly [{
    type: "required";
    value: {
        label: "bar-style";
        type: "label";
        value: {
            choices: readonly ["none", "dashed", "dotted", "heavy", "heavy-heavy", "heavy-light", "light-heavy", "light-light", "regular", "short", "tick"];
            type: "choices";
        };
    };
}]
Readonly name: "bar-style"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
}
- 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 contents: readonly [{
    type: "required";
    value: {
        label: "bar-style";
        type: "label";
        value: {
            choices: readonly ["none", "dashed", "dotted", "heavy", "heavy-heavy", "heavy-light", "light-heavy", "light-light", "regular", "short", "tick"];
            type: "choices";
        };
    };
}]
Readonly name: "bar-style"

Methods

getBarStyle

getBarStyle(): "none" | "dashed" | "dotted" | "short" | "tick" | "regular" | "heavy" | "heavy-heavy" | "heavy-light" | "light-heavy" | "light-light"
Gets

Returns "none" | "dashed" | "dotted" | "short" | "tick" | "regular" | "heavy" | "heavy-heavy" | "heavy-light" | "light-heavy" | "light-light"
- Defined in generated/elements.ts:58282

getColor

getColor(): null | string
Gets

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

setBarStyle

setBarStyle(barStyle): BarStyle
Sets
Parameters
- barStyle: "none" | "dashed" | "dotted" | "short" | "tick" | "regular" | "heavy" | "heavy-heavy" | "heavy-light" | "light-heavy" | "light-light"
Returns BarStyle
- Defined in generated/elements.ts:58297

setColor

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

Class BarStyle

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<BarStyleAttributes>; contents?: BarStyleContents; }

Optional attributes?: Partial<BarStyleAttributes>

Optional contents?: BarStyleContents

Returns BarStyle

Properties

attributes

contents

Readonly schema

Type declaration

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

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 contents: readonly [{ type: "required"; value: { label: "bar-style"; type: "label"; value: { choices: readonly ["none", "dashed", "dotted", "heavy", "heavy-heavy", "heavy-light", "light-heavy", "light-light", "regular", "short", "tick"]; type: "choices"; }; }; }]

Readonly name: "bar-style"

Static Readonly schema

Type declaration

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

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 contents: readonly [{ type: "required"; value: { label: "bar-style"; type: "label"; value: { choices: readonly ["none", "dashed", "dotted", "heavy", "heavy-heavy", "heavy-light", "light-heavy", "light-light", "regular", "short", "tick"]; type: "choices"; }; }; }]

Readonly name: "bar-style"

Methods

getBarStyle

Returns "none" | "dashed" | "dotted" | "short" | "tick" | "regular" | "heavy" | "heavy-heavy" | "heavy-light" | "light-heavy" | "light-light"

getColor

Returns null | string

setBarStyle

Parameters

barStyle: "none" | "dashed" | "dotted" | "short" | "tick" | "regular" | "heavy" | "heavy-heavy" | "heavy-light" | "light-heavy" | "light-light"

Returns BarStyle

setColor

Parameters

color: null | string

Returns BarStyle

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<BarStyleAttributes>;
contents?: BarStyleContents;
}

`Optional` attributes?: Partial<BarStyleAttributes>

`Optional` contents?: BarStyleContents

`Readonly` schema

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

`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` contents: readonly [{
type: "required";
value: {
label: "bar-style";
type: "label";
value: {
choices: readonly ["none", "dashed", "dotted", "heavy", "heavy-heavy", "heavy-light", "light-heavy", "light-light", "regular", "short", "tick"];
type: "choices";
};
};
}]

`Readonly` name: "bar-style"

`Static` `Readonly` schema

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

`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` contents: readonly [{
type: "required";
value: {
label: "bar-style";
type: "label";
value: {
choices: readonly ["none", "dashed", "dotted", "heavy", "heavy-heavy", "heavy-light", "light-heavy", "light-light", "regular", "short", "tick"];
type: "choices";
};
};
}]

`Readonly` name: "bar-style"