Class Suffix

The <suffix> element.

Values for the suffix element include plus and the accidental values sharp, flat, natural, double-sharp, flat-flat, and sharp-sharp. Suffixes include both symbols that come after the figure number and those that overstrike the figure number. The suffix values slash, back-slash, and vertical are used for slashed numbers indicating chromatic alteration. The orientation and display of the slash usually depends on the figure number. The suffix element may contain additional values for symbols specific to particular figured bass styles.

See

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

Hierarchy

Suffix

Implements

XMLElement<"suffix", SuffixAttributes, SuffixContents>

Constructors

constructor

new Suffix(opts?): Suffix
Parameters
- Optional opts: {
  attributes?: Partial<SuffixAttributes>;
  contents?: SuffixContents;
  }
  - Optional attributes?: Partial<SuffixAttributes>
  - Optional contents?: SuffixContents
Returns Suffix
- Defined in generated/elements.ts:39162

Properties

attributes

attributes: SuffixAttributes

contents: SuffixContents

`Readonly` schema

schema: XMLElementSchema<"suffix"> = Suffix.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"suffix"> = schema.Suffix

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setRelativeX

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

setRelativeY

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

setText

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

Class Suffix

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<SuffixAttributes>; contents?: SuffixContents; }

Optional attributes?: Partial<SuffixAttributes>

Optional contents?: SuffixContents

Returns Suffix

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

getText

Returns string

setColor

Parameters

color: null | string

Returns Suffix

setDefaultX

Parameters

defaultX: null | number

Returns Suffix

setDefaultY

Parameters

defaultY: null | number

Returns Suffix

setFontFamily

Parameters

fontFamily: null | string

Returns Suffix

setFontSize

Parameters

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

Returns Suffix

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Suffix

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns Suffix

setRelativeX

Parameters

relativeX: null | number

Returns Suffix

setRelativeY

Parameters

relativeY: null | number

Returns Suffix

setText

Parameters

text: string

`Optional` opts: {
attributes?: Partial<SuffixAttributes>;
contents?: SuffixContents;
}

`Optional` attributes?: Partial<SuffixAttributes>

`Optional` contents?: SuffixContents

`Readonly` schema

`Static` `Readonly` schema