OpenSheetMusicDisplay
    Preparing search index...

    Class VexFlowVoiceEntry

    The graphical counterpart of a [[VoiceEntry]].

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    boundingBox: BoundingBox
    GraceSlash: boolean
    isStandAloneGrace: boolean = false

    A grace note that no main note follows in its staff entry (e.g. the only note of its voice there), drawn as its own tickable of the voice. Unlike a grace note after its main note (VoiceEntry.GraceAfterMainNote), it keeps its timestamp.

    noteHeadsCenterX: number

    The x of the centre of the column of note heads the notes are drawn in, relative to the voice entry like the positions of its notes: including the shift of all of them aside from another voice's notes, but not the shift of a single head beside the others (e.g. of a second in a chord), so the same for all notes of a chord. The column also has the heads of other voices that aren't moved aside from them, e.g. of a whole note beside a quarter note: its centre is that of the widest head. The fingerings of the notes are centred on it (see MusicSheetCalculator.calculateFingerings()). Set with the positions of the notes (see VexFlowStaffEntry.positionNotesAtNoteHeads()), undefined e.g. for a rest.

    notes: GraphicalNote[]
    octaveShiftValue: OctaveEnum

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

    parentStaffEntry: GraphicalStaffEntry
    parentVoiceEntry: VoiceEntry
    vfGhostNotes: GhostNote[]

    Accessors

    Methods

    • Sets the vertical borders of this voice entry to the bounding box of its Vexflow note, e.g. from the tip of an up-stem that a beam extended (see VexFlowMeasure.updateBeamedVoiceEntryBorders()) to the lowest note head. Keeps the position of the voice entry, which its notes are placed relative to (VexFlowMeasure.correctNotePositions()): the next render's calculateXPosition() puts the voice entry there again (applyBordersFromVexflow()) and calculates the bounding boxes with the notes still where this render placed them.

      Parameters

      • boundingBox: any
      • staveTopY: number = 0

        The y of the stave's top line where the note's bounding box was measured (0 in calculateXPosition()).

      Returns void