Class VexFlowVoiceEntry

The graphical counterpart of a [[VoiceEntry]].

Hierarchy (View Summary)

GraphicalVoiceEntry
- VexFlowVoiceEntry

Index

Constructors

Properties

boundingBox GraceSlash notes octaveShiftValue parentStaffEntry parentVoiceEntry rules vfGhostNotes

Accessors

PositionAndShape vfStaveNote

Methods

applyBordersFromVexflow applyCustomNoteheads color isInstanceOfClass sort sortForVexflow

Constructors

constructor

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

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

vfGhostNotes

vfGhostNotes: GhostNote[]

Accessors

PositionAndShape

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

vfStaveNote

get vfStaveNote(): StemmableNote
Returns StemmableNote
- Defined in MusicalScore/Graphical/VexFlow/VexFlowVoiceEntry.ts:41
set vfStaveNote(value: StemmableNote): void
Parameters
- value: StemmableNote
Returns void
- Defined in MusicalScore/Graphical/VexFlow/VexFlowVoiceEntry.ts:37

Methods

applyBordersFromVexflow

applyBordersFromVexflow(): void
Returns void
- Defined in MusicalScore/Graphical/VexFlow/VexFlowVoiceEntry.ts:21

applyCustomNoteheads

applyCustomNoteheads(): void
Apply custom noteheads from Note.CustomNoteheadVFCode. This should happen before color().

Returns void
Overrides GraphicalVoiceEntry.applyCustomNoteheads
- Defined in MusicalScore/Graphical/VexFlow/VexFlowVoiceEntry.ts:46

color

color(): void
(Re-)color notes and stems by setting their Vexflow styles. Could be made redundant by a Vexflow PR, but Vexflow needs more solid and permanent color methods/variables for that See VexFlowConverter.StaveNote()

Returns void
Overrides GraphicalVoiceEntry.color
- Defined in MusicalScore/Graphical/VexFlow/VexFlowVoiceEntry.ts:65

isInstanceOfClass

isInstanceOfClass(className: string): boolean
Parameters
- className: string
Returns boolean
Inherited from GraphicalVoiceEntry.isInstanceOfClass
- Defined in MusicalScore/Interfaces/AClassHierarchyTrackable.ts:5

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[]
Inherited from GraphicalVoiceEntry.sort
- 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[]
Inherited from GraphicalVoiceEntry.sortForVexflow
- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:52