Class GraphicalVoiceEntry

The graphical counterpart of a VoiceEntry.

Hierarchy

GraphicalObject
- GraphicalVoiceEntry
  - VexFlowVoiceEntry

Index

Constructors

constructor

Properties

Accessors

PositionAndShape

Methods

Constructors

constructor

new GraphicalVoiceEntry(parentVoiceEntry: VoiceEntry, parentStaffEntry: GraphicalStaffEntry, rules?: EngravingRules): GraphicalVoiceEntry

Overrides GraphicalObject.constructor
- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:13
Parameters
- parentVoiceEntry: VoiceEntry
- parentStaffEntry: GraphicalStaffEntry
- Optional rules: EngravingRules
Returns GraphicalVoiceEntry

Properties

GraceSlash

GraceSlash: boolean

Protected boundingBox

boundingBox: BoundingBox

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
set PositionAndShape(value: BoundingBox): void

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

Methods

color

color(): void

- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:69
(Re-)color notes and stems

Returns void

isInstanceOfClass

isInstanceOfClass(className: string): boolean

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

sort

sort(): GraphicalNote[]

- Defined in MusicalScore/Graphical/GraphicalVoiceEntry.ts:39
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[]

sortForVexflow

sortForVexflow(): GraphicalNote[]

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

Generated using TypeDoc