Class FiguredBass

The <figured-bass> element.

The figured-bass element represents figured bass notation. Figured bass elements take their position from the first regular note (not a grace note or chord note) that follows in score order. The optional duration element is used to indicate changes of figures under a note.

Figures are ordered from top to bottom. The value of parentheses is "no" if not present.

See

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

Hierarchy

FiguredBass

Implements

XMLElement<"figured-bass", FiguredBassAttributes, FiguredBassContents>

Constructors

constructor

new FiguredBass(opts?): FiguredBass
Parameters
- Optional opts: {
  attributes?: Partial<FiguredBassAttributes>;
  contents?: FiguredBassContents;
  }
  - Optional attributes?: Partial<FiguredBassAttributes>
  - Optional contents?: FiguredBassContents
Returns FiguredBass
- Defined in generated/elements.ts:39389

Properties

attributes

attributes: FiguredBassAttributes

contents: FiguredBassContents

`Readonly` schema

schema: XMLElementSchema<"figured-bass"> = FiguredBass.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"figured-bass"> = schema.FiguredBass

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getDuration

getDuration(): null | Duration
Gets

Returns null | Duration
- Defined in generated/elements.ts:39567

getFigures

getFigures(): Figure[]
Gets

Returns Figure[]
- Defined in generated/elements.ts:39558

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getFootnote

getFootnote(): null | Footnote
Gets

Returns null | Footnote
- Defined in generated/elements.ts:39576

getHalign

getHalign(): null | "left" | "center" | "right"
Gets

Returns null | "left" | "center" | "right"
- Defined in generated/elements.ts:39459

getId

getId(): null | string
Gets

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

getLevel

getLevel(): null | Level
Gets

Returns null | Level
- Defined in generated/elements.ts:39585

getParentheses

getParentheses(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:39477

getPlacement

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

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

getPrintDot

getPrintDot(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:39495

getPrintLyric

getPrintLyric(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:39504

getPrintObject

getPrintObject(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:39513

getPrintSpacing

getPrintSpacing(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:39522

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getValign

getValign(): null | "top" | "middle" | "bottom" | "baseline"
Gets

Returns null | "top" | "middle" | "bottom" | "baseline"
- Defined in generated/elements.ts:39549

setColor

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

setDefaultX

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

setDefaultY

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

setDuration

setDuration(duration): FiguredBass
Sets
Parameters
- duration: null | Duration
Returns FiguredBass
- Defined in generated/elements.ts:39571

setFigures

setFigures(figures): FiguredBass
Sets
Parameters
- figures: Figure[]
Returns FiguredBass
- Defined in generated/elements.ts:39562

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setFootnote

setFootnote(footnote): FiguredBass
Sets
Parameters
- footnote: null | Footnote
Returns FiguredBass
- Defined in generated/elements.ts:39580

setHalign

setHalign(halign): FiguredBass
Sets
Parameters
- halign: null | "left" | "center" | "right"
Returns FiguredBass
- Defined in generated/elements.ts:39463

setId

setId(id): FiguredBass
Sets
Parameters
- id: null | string
Returns FiguredBass
- Defined in generated/elements.ts:39472

setLevel

setLevel(level): FiguredBass
Sets
Parameters
- level: null | Level
Returns FiguredBass
- Defined in generated/elements.ts:39589

setParentheses

setParentheses(parentheses): FiguredBass
Sets
Parameters
- parentheses: null | "yes" | "no"
Returns FiguredBass
- Defined in generated/elements.ts:39481

setPlacement

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

setPrintDot

setPrintDot(printDot): FiguredBass
Sets
Parameters
- printDot: null | "yes" | "no"
Returns FiguredBass
- Defined in generated/elements.ts:39499

setPrintLyric

setPrintLyric(printLyric): FiguredBass
Sets
Parameters
- printLyric: null | "yes" | "no"
Returns FiguredBass
- Defined in generated/elements.ts:39508

setPrintObject

setPrintObject(printObject): FiguredBass
Sets
Parameters
- printObject: null | "yes" | "no"
Returns FiguredBass
- Defined in generated/elements.ts:39517

setPrintSpacing

setPrintSpacing(printSpacing): FiguredBass
Sets
Parameters
- printSpacing: null | "yes" | "no"
Returns FiguredBass
- Defined in generated/elements.ts:39526

setRelativeX

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

setRelativeY

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

setValign

setValign(valign): FiguredBass
Sets
Parameters
- valign: null | "top" | "middle" | "bottom" | "baseline"
Returns FiguredBass
- Defined in generated/elements.ts:39553

Class FiguredBass

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<FiguredBassAttributes>; contents?: FiguredBassContents; }

Optional attributes?: Partial<FiguredBassAttributes>

Optional contents?: FiguredBassContents

Returns FiguredBass

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getDuration

Returns null | Duration

getFigures

Returns Figure[]

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"

getFootnote

Returns null | Footnote

getHalign

Returns null | "left" | "center" | "right"

getId

Returns null | string

getLevel

Returns null | Level

getParentheses

Returns null | "yes" | "no"

getPlacement

Returns null | "above" | "below"

getPrintDot

Returns null | "yes" | "no"

getPrintLyric

Returns null | "yes" | "no"

getPrintObject

Returns null | "yes" | "no"

getPrintSpacing

Returns null | "yes" | "no"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getValign

Returns null | "top" | "middle" | "bottom" | "baseline"

setColor

Parameters

color: null | string

Returns FiguredBass

setDefaultX

Parameters

defaultX: null | number

Returns FiguredBass

setDefaultY

Parameters

defaultY: null | number

Returns FiguredBass

setDuration

Parameters

duration: null | Duration

`Optional` opts: {
attributes?: Partial<FiguredBassAttributes>;
contents?: FiguredBassContents;
}

`Optional` attributes?: Partial<FiguredBassAttributes>

`Optional` contents?: FiguredBassContents

`Readonly` schema

`Static` `Readonly` schema