Class Notehead

A note head with shape and fill information belonging to a [[Note]].

Index

Constructors

Accessors

Filled Shape SourceNote

Methods

setShapeFromXml ShapeTypeXmlToShape

Constructors

constructor

new Notehead(
    sourceNote: Note,
    shapeTypeXml: string,
    filledXml?: boolean,
): Notehead
Parameters
- sourceNote: Note
- shapeTypeXml: string
  The shape type given from XML. See https://usermanuals.musicxml.com/MusicXML/Content/ST-MusicXML-notehead-value.htm
- filledXml: boolean = undefined
  The XML flag to fill the note shape. Can be undefined if not included in XML. If undefined, the filled parameter will be calculated by note duration (d < half note => filled)
Returns Notehead
- Defined in MusicalScore/VoiceData/Notehead.ts:15

Accessors

Filled

get Filled(): boolean
Returns boolean
- Defined in MusicalScore/VoiceData/Notehead.ts:56

Shape

get Shape(): NoteHeadShape
Returns NoteHeadShape
- Defined in MusicalScore/VoiceData/Notehead.ts:53

SourceNote

get SourceNote(): Note
Returns Note
- Defined in MusicalScore/VoiceData/Notehead.ts:49

Methods

setShapeFromXml

setShapeFromXml(shapeTypeXml: string, filledXmlAttribute?: boolean): void
Sets the note head's shape from XML parameters.
Parameters
- shapeTypeXml: string
  The XML shape.
- filledXmlAttribute: boolean = undefined
  the filled parameter as given in XML. Can be undefined if not given in XML or if it should be calculated from note duration. If undefined, this.sourceNote should not be undefined.
Returns void
- Defined in MusicalScore/VoiceData/Notehead.ts:33

`Static`ShapeTypeXmlToShape

ShapeTypeXmlToShape(shapeTypeXml: string): NoteHeadShape
Converts xml attribute to NoteHeadShape. Necessary because "circle-x" is not a valid enum member name.
Parameters
- shapeTypeXml: string
Returns NoteHeadShape
- Defined in MusicalScore/VoiceData/Notehead.ts:63