Class Segno

The <segno> element.

The segno type is the visual indicator of a segno sign. The exact glyph can be specified with the smufl attribute. A sound element is also needed to guide playback applications reliably.

See

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

Hierarchy

Segno

Implements

XMLElement<"segno", SegnoAttributes, SegnoContents>

Constructors

constructor

new Segno(opts?): Segno
Parameters
- Optional opts: {
  attributes?: Partial<SegnoAttributes>;
  contents?: [];
  }
  - Optional attributes?: Partial<SegnoAttributes>
  - Optional contents?: []
Returns Segno
- Defined in generated/elements.ts:25762

Properties

attributes

attributes: SegnoAttributes

contents: []

`Readonly` schema

schema: XMLElementSchema<"segno"> = Segno.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"segno"> = schema.Segno

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getHalign

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

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

getId

getId(): null | string
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSmufl

getSmufl(): null | string
Gets

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

getValign

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

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

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

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

setId

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

setRelativeX

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

setRelativeY

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

setSmufl

setSmufl(smufl): Segno
Sets
Parameters
- smufl: null | string
Returns Segno
- Defined in generated/elements.ts:25872

setValign

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

Class Segno

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<SegnoAttributes>; contents?: []; }

Optional attributes?: Partial<SegnoAttributes>

Optional contents?: []

Returns Segno

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"

getHalign

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

getId

Returns null | string

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getSmufl

Returns null | string

getValign

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

setColor

Parameters

color: null | string

Returns Segno

setDefaultX

Parameters

defaultX: null | number

Returns Segno

setDefaultY

Parameters

defaultY: null | number

Returns Segno

setFontFamily

Parameters

fontFamily: null | string

Returns Segno

setFontSize

Parameters

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

Returns Segno

setFontStyle

Parameters

fontStyle: null | "normal" | "italic"

Returns Segno

setFontWeight

Parameters

fontWeight: null | "normal" | "bold"

Returns Segno

setHalign

Parameters

halign: null | "left" | "center" | "right"

Returns Segno

setId

`Optional` opts: {
attributes?: Partial<SegnoAttributes>;
contents?: [];
}

`Optional` attributes?: Partial<SegnoAttributes>

`Optional` contents?: []

`Readonly` schema

`Static` `Readonly` schema