Class Function

The <function> element.

The function element represents classical functional harmony with an indication like I, II, III rather than C, D, E. It represents the Roman numeral part of a functional harmony rather than the complete function itself. It has been deprecated as of MusicXML 4.0 in favor of the numeral element.

See

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

Hierarchy

Function

Implements

XMLElement<"function", FunctionAttributes, FunctionContents>

Constructors

constructor

new Function(opts?): Function
Parameters
- Optional opts: {
  attributes?: Partial<FunctionAttributes>;
  contents?: FunctionContents;
  }
  - Optional attributes?: Partial<FunctionAttributes>
  - Optional contents?: FunctionContents
Returns Function
- Defined in generated/elements.ts:36659

Properties

attributes

attributes: FunctionAttributes

contents

contents: FunctionContents

`Readonly` schema

schema: XMLElementSchema<"function"> = Function.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"function"> = schema.Function

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setRelativeX

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

setRelativeY

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

setText

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

Generated using TypeDoc