Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VexFlowMeasure

Hierarchy

Index

Constructors

constructor

Properties

Private autoTupletVfBeams

autoTupletVfBeams: Beam[]

Beams of tuplet notes created by (optional) autoBeam function.

Private autoVfBeams

autoVfBeams: Beam[]

Beams created by (optional) autoBeam function.

Private beams

beams:

Intermediate object to construct beams

Type declaration

beginInstructionsWidth

beginInstructionsWidth: number

The x-width of possibly existing: repetition start line, clef, key, rhythm.

Protected boundingBox

boundingBox: BoundingBox

Private connectors

connectors: StaveConnector[] = []

VexFlow StaveConnectors (vertical lines)

endInstructionsWidth

endInstructionsWidth: number

The x-width of possibly existing: repetition end line, clef.

Protected firstInstructionStaffEntry

firstInstructionStaffEntry: GraphicalStaffEntry

formatVoices

formatVoices: (width: number) => void

Call this function (if present) to x-format all the voices in the measure

Type declaration

    • (width: number): void
    • Parameters

      • width: number

      Returns void

hasError

hasError: boolean

Protected lastInstructionStaffEntry

lastInstructionStaffEntry: GraphicalStaffEntry

minimumStaffEntriesWidth

minimumStaffEntriesWidth: number

The minimum possible x-width of all staff entries without overlapping.

octaveOffset

octaveOffset: number = 3

octaveOffset according to active clef

parentMusicSystem

parentMusicSystem: MusicSystem

parentSourceMeasure

parentSourceMeasure: SourceMeasure

staffEntries

staffEntries: GraphicalStaffEntry[]

staffEntriesScaleFactor

staffEntriesScaleFactor: number

Will be set by music system builder while building systems.

Private stave

stave: Stave

The VexFlow Stave (= one measure in a staffline)

Private tuplets

tuplets:

Intermediate object to construct tuplets

Type declaration

vfRepetitionWords

vfRepetitionWords: Repetition[] = []

The repetition instructions given as words or symbols (coda, dal segno..)

vfTies

vfTies: StaveTie[] = []

The VexFlow Ties in the measure

vfVoices

vfVoices:

The VexFlow Voices in the measure

Type declaration

  • [voiceID: number]: Voice

Private vfbeams

vfbeams:

VexFlow Beams

Type declaration

  • [voiceID: number]: Beam[]

Private vftuplets

vftuplets:

VexFlow Tuplets

Type declaration

  • [voiceID: number]: Tuplet[]

Accessors

FirstInstructionStaffEntry

LastInstructionStaffEntry

MeasureNumber

  • get MeasureNumber(): number

ParentStaff

  • get ParentStaff(): Staff

ParentStaffLine

PositionAndShape

Methods

addClefAtBegin

addClefAtEnd

addGraphicalStaffEntry

addGraphicalStaffEntryAtTimestamp

addKeyAtBegin

addMeasureLine

addMeasureNumber

  • addMeasureNumber(): void

addRhythmAtBegin

Private addVolta

addWordRepetition

Private autoBeamNotes

  • autoBeamNotes(beamedNotes: StemmableNote[]): void
  • Automatically creates beams for notes except beamedNotes, using Vexflow's Beam.generateBeams(). Takes options from EngravingRules.Rules.AutoBeamOptions.

    Parameters

    • beamedNotes: StemmableNote[]

      notes that will not be autobeamed (usually because they are already beamed)

    Returns void

beginsWithLineRepetition

  • beginsWithLineRepetition(): boolean

beginsWithWordRepetition

  • beginsWithWordRepetition(): boolean

clean

  • clean(): void

Private createArticulations

  • createArticulations(): void

Private createFingerings

Private createOrnaments

  • createOrnaments(): void

draw

  • draw(ctx: IRenderContext): void

endsWithLineRepetition

  • endsWithLineRepetition(): boolean

endsWithWordRepetition

  • endsWithWordRepetition(): boolean

finalizeBeams

  • finalizeBeams(): void

finalizeTuplets

  • finalizeTuplets(): void

findGraphicalStaffEntryFromTimestamp

findGraphicalStaffEntryFromVerticalContainerTimestamp

format

  • format(): void

getGraphicalMeasureDurationFromStaffEntries

  • getGraphicalMeasureDurationFromStaffEntries(): Fraction

getGraphicalVoiceEntriesPerVoice

getLineWidth

Private getRestFilledVexFlowStaveNotesPerVoice

  • Finds the gaps between the existing notes within a measure. Problem here is, that the graphicalVoiceEntry does not exist yet and that Tied notes are not present in the normal voiceEntries. To handle this, calculation with absolute timestamps is needed. And the graphical notes have to be analysed directly (and not the voiceEntries, as it actually should be -> needs refactoring)

    Parameters

    • voice: Voice

      the voice for which the ghost notes shall be searched.

    Returns GraphicalVoiceEntry[]

getVFStave

  • getVFStave(): Stave

getVoicesWithinMeasure

  • getVoicesWithinMeasure(): Voice[]

graphicalMeasureCreatedCalculations

  • graphicalMeasureCreatedCalculations(): void

handleBeam

handleTuplet

hasMultipleVoices

  • hasMultipleVoices(): boolean

hasSameDurationWithSourceMeasureParent

  • hasSameDurationWithSourceMeasureParent(): boolean

isVisible

  • isVisible(): boolean

layoutStaffEntry

layoutSymbols

  • layoutSymbols(): void

lineTo

resetLayout

  • resetLayout(): void

setAbsoluteCoordinates

  • setAbsoluteCoordinates(x: number, y: number): void

setPositionInStaffline

  • setPositionInStaffline(xPos: number): void

Private setStemDirectionFromVexFlow

  • setStemDirectionFromVexFlow(): void

setWidth

  • setWidth(width: number): void

Private updateInstructionWidth

  • updateInstructionWidth(): void

Generated using TypeDoc