Class Symbol

The <symbol> element.

The symbol element specifies a musical symbol using a canonical SMuFL glyph name. It is used when an occasional musical symbol is interspersed into text. It should not be used in place of semantic markup, such as metronome marks that mix text and symbols. Left justification is used if not specified. Enclosure is none if not specified.

See

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

Hierarchy

Symbol

Implements

XMLElement<"symbol", SymbolAttributes, SymbolContents>

Constructors

constructor

new Symbol(opts?): Symbol
Parameters
- Optional opts: {
  attributes?: Partial<SymbolAttributes>;
  contents?: SymbolContents;
  }
  - Optional attributes?: Partial<SymbolAttributes>
  - Optional contents?: SymbolContents
Returns Symbol
- Defined in generated/elements.ts:26422

Properties

attributes

attributes: SymbolAttributes

contents: SymbolContents

`Readonly` schema

schema: XMLElementSchema<"symbol"> = Symbol.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"symbol"> = schema.Symbol

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getDir

getDir(): null | "ltr" | "rtl" | "lro" | "rlo"
Gets

Returns null | "ltr" | "rtl" | "lro" | "rlo"
- Defined in generated/elements.ts:26454

getEnclosure

getEnclosure(): null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
Gets

Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
- Defined in generated/elements.ts:26463

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHalign

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

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

getId

getId(): null | string
Gets

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

getJustify

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

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

getLetterSpacing

getLetterSpacing(): null | number | "normal"
Gets

Returns null | number | "normal"
- Defined in generated/elements.ts:26571

getLineHeight

getLineHeight(): null | number | "normal"
Gets

Returns null | number | "normal"
- Defined in generated/elements.ts:26580

getLineThrough

getLineThrough(): null | number
Gets

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

getOverline

getOverline(): null | number
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getRotation

getRotation(): null | number
Gets

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

getText

getText(): string
Gets

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

getUnderline

getUnderline(): null | number
Gets

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

getValign

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

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

setColor

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

setDefaultX

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

setDefaultY

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

setDir

setDir(dir): Symbol
Sets
Parameters
- dir: null | "ltr" | "rtl" | "lro" | "rlo"
Returns Symbol
- Defined in generated/elements.ts:26458

setEnclosure

setEnclosure(enclosure): Symbol
Sets
Parameters
- enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
Returns Symbol
- Defined in generated/elements.ts:26483

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

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

setId

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

setJustify

setJustify(justify): Symbol
Sets
Parameters
- justify: null | "left" | "center" | "right"
Returns Symbol
- Defined in generated/elements.ts:26566

setLetterSpacing

setLetterSpacing(letterSpacing): Symbol
Sets
Parameters
- letterSpacing: null | number | "normal"
Returns Symbol
- Defined in generated/elements.ts:26575

setLineHeight

setLineHeight(lineHeight): Symbol
Sets
Parameters
- lineHeight: null | number | "normal"
Returns Symbol
- Defined in generated/elements.ts:26584

setLineThrough

setLineThrough(lineThrough): Symbol
Sets
Parameters
- lineThrough: null | number
Returns Symbol
- Defined in generated/elements.ts:26593

setOverline

setOverline(overline): Symbol
Sets
Parameters
- overline: null | number
Returns Symbol
- Defined in generated/elements.ts:26602

setRelativeX

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

setRelativeY

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

setRotation

setRotation(rotation): Symbol
Sets
Parameters
- rotation: null | number
Returns Symbol
- Defined in generated/elements.ts:26629

setText

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

setUnderline

setUnderline(underline): Symbol
Sets
Parameters
- underline: null | number
Returns Symbol
- Defined in generated/elements.ts:26638

setValign

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

Class Symbol

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<SymbolAttributes>; contents?: SymbolContents; }

Optional attributes?: Partial<SymbolAttributes>

Optional contents?: SymbolContents

Returns Symbol

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getDir

Returns null | "ltr" | "rtl" | "lro" | "rlo"

getEnclosure

Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

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"

getHalign

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

getId

Returns null | string

getJustify

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

getLetterSpacing

Returns null | number | "normal"

getLineHeight

Returns null | number | "normal"

getLineThrough

Returns null | number

getOverline

Returns null | number

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getRotation

Returns null | number

getText

Returns string

getUnderline

Returns null | number

getValign

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

setColor

Parameters

color: null | string

Returns Symbol

setDefaultX

Parameters

defaultX: null | number

Returns Symbol

setDefaultY

Parameters

defaultY: null | number

Returns Symbol

setDir

Parameters

dir: null | "ltr" | "rtl" | "lro" | "rlo"

`Optional` opts: {
attributes?: Partial<SymbolAttributes>;
contents?: SymbolContents;
}

`Optional` attributes?: Partial<SymbolAttributes>

`Optional` contents?: SymbolContents

`Readonly` schema

`Static` `Readonly` schema