Class GraphicalVoiceEntry

The graphical counterpart of a [[VoiceEntry]].

Hierarchy (View Summary)

GraphicalObject
- GraphicalVoiceEntry
  - VexFlowVoiceEntry

Index

Constructors

Properties

boundingBox GraceSlash notes octaveShiftValue parentStaffEntry parentVoiceEntry rules

Accessors

PositionAndShape

Methods

applyCustomNoteheads color isInstanceOfClass sort sortForVexflow

Constructors

constructor

new GraphicalVoiceEntry(
    parentVoiceEntry: VoiceEntry,
    parentStaffEntry: GraphicalStaffEntry,
    rules?: EngravingRules,
): GraphicalVoiceEntry
Parameters
- parentVoiceEntry: VoiceEntry
- parentStaffEntry: GraphicalStaffEntry
- Optionalrules: EngravingRules
Returns GraphicalVoiceEntry
Overrides GraphicalObject.constructor
- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:13

Properties

`Protected`boundingBox

boundingBox: BoundingBox

GraceSlash

GraceSlash: boolean

notes

notes: GraphicalNote[]

octaveShiftValue

octaveShiftValue: OctaveEnum

Contains octave shifts affecting this voice entry, caused by octave brackets.

parentStaffEntry

parentStaffEntry: GraphicalStaffEntry

parentVoiceEntry

parentVoiceEntry: VoiceEntry

`Protected`rules

rules: EngravingRules

Accessors

PositionAndShape

get PositionAndShape(): BoundingBox
Returns BoundingBox
Inherited from GraphicalObject.PositionAndShape
- Defined in MusicalScore/Graphical/GraphicalObject.ts:8
set PositionAndShape(value: BoundingBox): void
Parameters
- value: BoundingBox
Returns void
Inherited from GraphicalObject.PositionAndShape
- Defined in MusicalScore/Graphical/GraphicalObject.ts:15

Methods

applyCustomNoteheads

applyCustomNoteheads(): void
Returns void
- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:67

color

color(): void
(Re-)color notes and stems

Returns void
- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:73

isInstanceOfClass

isInstanceOfClass(classOrName: string | ClassType<unknown>): boolean
Returns whether this object is an instance of the class, e.g. isInstanceOfClass(GraphicalMeasure).
Parameters
- classOrName: string | ClassType<unknown>
  The class, or its name (e.g. GraphicalMeasure.name). A name is unreliable in minified builds: they rename the classes, and give different classes the same name, e.g. "a" to GraphicalMeasure and GraphicalNote.
Returns boolean
Inherited from GraphicalObject.isInstanceOfClass
- Defined in MusicalScore/Interfaces/AClassHierarchyTrackable.ts:13

sort

sort(): GraphicalNote[]
Sort this entry's notes by pitch. Notes need to be sorted for Vexflow StaveNote creation. Note that Vexflow needs the reverse order, see VexFlowConverter.StaveNote().

Returns GraphicalNote[]
- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:39

sortForVexflow

sortForVexflow(): GraphicalNote[]
Sort notes for vexflow (bottom to top), which needs them in the reverse order OSMD likes to have them. Note that sort() and reverse() replace the array in place, so to avoid changing the array one could copy it first, see sortedNotesCopyForVexflow() (commented), though copying the array is also unnecessary (time+memory) for now.

Returns GraphicalNote[]
- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:52