Class WithBar

The <with-bar> element.

The with-bar element indicates that the bend is to be done at the bridge with a whammy or vibrato bar. The content of the element indicates how this should be notated. Content values of "scoop" and "dip" refer to the SMuFL guitarVibratoBarScoop and guitarVibratoBarDip glyphs.

See

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

Hierarchy

WithBar

Implements

XMLElement<"with-bar", WithBarAttributes, WithBarContents>

Constructors

constructor

new WithBar(opts?): WithBar
Parameters
- Optional opts: {
  attributes?: Partial<WithBarAttributes>;
  contents?: WithBarContents;
  }
  - Optional attributes?: Partial<WithBarAttributes>
  - Optional contents?: WithBarContents
Returns WithBar
- Defined in generated/elements.ts:16389

Properties

attributes

attributes: WithBarAttributes

contents: WithBarContents

`Readonly` schema

schema: XMLElementSchema<"with-bar"> = WithBar.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"with-bar"> = schema.WithBar

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFirstBeat

getFirstBeat(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getPlacement

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

Returns string
- Defined in generated/elements.ts:16495

setColor

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

setDefaultX

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

setDefaultY

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

setFirstBeat

setFirstBeat(firstBeat): WithBar
Sets
Parameters
- firstBeat: null | number
Returns WithBar
- Defined in generated/elements.ts:16425

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setPlacement

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

setRelativeX

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

setRelativeY

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

setText

setText(text): WithBar
Sets
Parameters
- text: string
Returns WithBar
- Defined in generated/elements.ts:16499

Class WithBar

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<WithBarAttributes>; contents?: WithBarContents; }

Optional attributes?: Partial<WithBarAttributes>

Optional contents?: WithBarContents

Returns WithBar

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getFirstBeat

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

getText

Returns string

setColor

Parameters

color: null | string

Returns WithBar

setDefaultX

Parameters

defaultX: null | number

Returns WithBar

setDefaultY

Parameters

defaultY: null | number

Returns WithBar

setFirstBeat

Parameters

firstBeat: null | number

Returns WithBar

setFontFamily

Parameters

fontFamily: null | string

Returns WithBar

setFontSize

Parameters

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

Returns WithBar

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns WithBar

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns WithBar

setPlacement

Parameters

placement: null | "above" | "below"

`Optional` opts: {
attributes?: Partial<WithBarAttributes>;
contents?: WithBarContents;
}

`Optional` attributes?: Partial<WithBarAttributes>

`Optional` contents?: WithBarContents

`Readonly` schema

`Static` `Readonly` schema