Class Directive

The <directive> element.

Directives are like directions, but can be grouped together with attributes for convenience. This is typically used for tempo markings at the beginning of a piece of music. This element was deprecated in Version 2.0 in favor of the direction element's directive attribute. Language names come from ISO 639, with optional country subcodes from ISO 3166.

See

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

Hierarchy

Directive

Implements

XMLElement<"directive", DirectiveAttributes, DirectiveContents>

Constructors

constructor

new Directive(opts?): Directive
Parameters
- Optional opts: {
  attributes?: Partial<DirectiveAttributes>;
  contents?: DirectiveContents;
  }
  - Optional attributes?: Partial<DirectiveAttributes>
  - Optional contents?: DirectiveContents
Returns Directive
- Defined in generated/elements.ts:35070

Properties

attributes

attributes: DirectiveAttributes

contents: DirectiveContents

`Readonly` schema

schema: XMLElementSchema<"directive"> = Directive.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"directive"> = schema.Directive

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getText

getText(): string
Gets

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

getXmlLang

getXmlLang(): null | string
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setRelativeX

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

setRelativeY

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

setText

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

setXmlLang

setXmlLang(xmlLang): Directive
Sets
Parameters
- xmlLang: null | string
Returns Directive
- Defined in generated/elements.ts:35162

Class Directive

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<DirectiveAttributes>; contents?: DirectiveContents; }

Optional attributes?: Partial<DirectiveAttributes>

Optional contents?: DirectiveContents

Returns Directive

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

getXmlLang

Returns null | string

setColor

Parameters

color: null | string

Returns Directive

setDefaultX

Parameters

defaultX: null | number

Returns Directive

setDefaultY

Parameters

defaultY: null | number

Returns Directive

setFontFamily

Parameters

fontFamily: null | string

Returns Directive

setFontSize

Parameters

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

Returns Directive

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Directive

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns Directive

setRelativeX

Parameters

relativeX: null | number

Returns Directive

setRelativeY

Parameters

relativeY: null | number

Returns Directive

setText

`Optional` opts: {
attributes?: Partial<DirectiveAttributes>;
contents?: DirectiveContents;
}

`Optional` attributes?: Partial<DirectiveAttributes>

`Optional` contents?: DirectiveContents

`Readonly` schema

`Static` `Readonly` schema