Class BassStep

The <bass-step> element.

The bass-step type represents the pitch step of the bass of the current chord within the harmony element. The text attribute indicates how the bass should appear in a score if not using the element contents.

See

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

Hierarchy

BassStep

Implements

XMLElement<"bass-step", BassStepAttributes, BassStepContents>

Constructors

constructor

new BassStep(opts?): BassStep
Parameters
- Optional opts: {
  attributes?: Partial<BassStepAttributes>;
  contents?: BassStepContents;
  }
  - Optional attributes?: Partial<BassStepAttributes>
  - Optional contents?: BassStepContents
Returns BassStep
- Defined in generated/elements.ts:37370

Properties

attributes

attributes: BassStepAttributes

contents: BassStepContents

`Readonly` schema

schema: XMLElementSchema<"bass-step"> = BassStep.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"bass-step"> = schema.BassStep

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getStep

getStep(): "A" | "B" | "C" | "D" | "E" | "F" | "G"
Gets

Returns "A" | "B" | "C" | "D" | "E" | "F" | "G"
- Defined in generated/elements.ts:37467

getText

getText(): null | string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setRelativeX

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

setRelativeY

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

setStep

setStep(step): BassStep
Sets
Parameters
- step: "A" | "B" | "C" | "D" | "E" | "F" | "G"
Returns BassStep
- Defined in generated/elements.ts:37471

setText

setText(text): BassStep
Sets
Parameters
- text: null | string
Returns BassStep
- Defined in generated/elements.ts:37462

Class BassStep

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<BassStepAttributes>; contents?: BassStepContents; }

Optional attributes?: Partial<BassStepAttributes>

Optional contents?: BassStepContents

Returns BassStep

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

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"

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getStep

Returns "A" | "B" | "C" | "D" | "E" | "F" | "G"

getText

Returns null | string

setColor

Parameters

color: null | string

Returns BassStep

setDefaultX

Parameters

defaultX: null | number

Returns BassStep

setDefaultY

Parameters

defaultY: null | number

Returns BassStep

setFontFamily

Parameters

fontFamily: null | string

Returns BassStep

setFontSize

Parameters

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

Returns BassStep

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns BassStep

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns BassStep

setRelativeX

Parameters

relativeX: null | number

Returns BassStep

setRelativeY

Parameters

relativeY: null | number

Returns BassStep

setStep

`Optional` opts: {
attributes?: Partial<BassStepAttributes>;
contents?: BassStepContents;
}

`Optional` attributes?: Partial<BassStepAttributes>

`Optional` contents?: BassStepContents

`Readonly` schema

`Static` `Readonly` schema