Class MusicSheetCalculatorAbstract

ProtecteddynamicExpressionMap

ProtectedgraphicalLyricWords

ProtectedgraphicalMusicSheet

ProtectedmusicSystems

Protectedrules

ProtectedstaffEntriesWithChordSymbols

ProtectedstaffEntriesWithGraphicalTies

ProtectedstaffEntriesWithOrnaments

ProtectedstaffLinesWithLyricWords

Protected StatictextMeasurer

ProtectedleadSheet

• get leadSheet(): boolean

  Returns boolean

ProtectedcalcGraphicalRepetitionEndingsRecursively

• calcGraphicalRepetitionEndingsRecursively(repetition: Repetition): void

  Parameters

  • repetition: Repetition

  Returns void

ProtectedcalculateAlignedChordSymbolsOffset

• calculateAlignedChordSymbolsOffset(
      staffEntries: GraphicalStaffEntry[],
      sbc: SkyBottomLineCalculator,
  ): { maxOffset: number; minOffset: number }

  Parameters

  • staffEntries: GraphicalStaffEntry[]
  • sbc: SkyBottomLineCalculator

  Returns { maxOffset: number; minOffset: number }

ProtectedcalculateChordSymbols

• calculateChordSymbols(): void

  Returns void

ProtectedcalculateComments

• calculateComments(): void

  Returns void

ProtectedcalculateDynamicExpressionsForMultiExpression

• calculateDynamicExpressionsForMultiExpression(
      multiExpression: MultiExpression,
      measureIndex: number,
      staffIndex: number,
  ): void

  Parameters

  • multiExpression: MultiExpression
  • measureIndex: number
  • staffIndex: number

  Returns void

ProtectedcalculateExpressionAlignements

• calculateExpressionAlignements(): void

  Re-adjust the x positioning of expressions.

  Returns void

ProtectedcalculateGlissandi

• calculateGlissandi(): void

  Returns void

ProtectedcalculateGraphicalInstantaneousDynamicExpression

• calculateGraphicalInstantaneousDynamicExpression(
      graphicalInstantaneousDynamic: GraphicalInstantaneousDynamicExpression,
      startPosInStaffline: PointF2D,
      timestamp: Fraction,
  ): void

  This method calculates the RelativePosition of a single GraphicalInstantaneousDynamicExpression.

  Parameters

  • graphicalInstantaneousDynamic: GraphicalInstantaneousDynamicExpression

    Dynamic expression to be calculated
  • startPosInStaffline: PointF2D

    Starting point in staff line
  • timestamp: Fraction

  Returns void

ProtectedcalculateGraphicalVerbalContinuousDynamic

• calculateGraphicalVerbalContinuousDynamic(
      graphicalContinuousDynamic: GraphicalContinuousDynamicExpression,
      startPosInStaffline: PointF2D,
  ): void

  This method calculates the RelativePosition of a single verbal GraphicalContinuousDynamic.

  Parameters

  • graphicalContinuousDynamic: GraphicalContinuousDynamicExpression

    Graphical continous dynamic to be calculated
  • startPosInStaffline: PointF2D

    Starting point in staff line

  Returns void

ProtectedcalculateLabel

• calculateLabel(
      staffLine: StaffLine,
      relative: PointF2D,
      combinedString: string,
      style: FontStyles,
      placement: PlacementEnum,
      fontHeight: number,
      textAlignment?: TextAlignmentEnum,
      yPadding?: number,
  ): GraphicalLabel

  Parameters

  • staffLine: StaffLine
  • relative: PointF2D
  • combinedString: string
  • style: FontStyles
  • placement: PlacementEnum
  • fontHeight: number
  • textAlignment: TextAlignmentEnum = TextAlignmentEnum.CenterBottom
  • yPadding: number = 0

  Returns GraphicalLabel

ProtectedcalculateLyricsExtendsAndDashes

• calculateLyricsExtendsAndDashes(lyricsStaffEntries: GraphicalStaffEntry[]): void

  calculates the dashes of lyric words and the extending underscore lines of syllables sung on more than one note.

  Parameters

  • lyricsStaffEntries: GraphicalStaffEntry[]

  Returns void

ProtectedcalculateMarkedAreas

• calculateMarkedAreas(): void

  Returns void

ProtectedcalculateMeasureNumberPlacement

• calculateMeasureNumberPlacement(musicSystem: MusicSystem): void

  Iterate through all Measures and calculates the MeasureNumberLabels.

  Parameters

  • musicSystem: MusicSystem

  Returns void

ProtectedcalculateMeasureXLayout

• calculateMeasureXLayout(measures: GraphicalMeasure[]): number

  Calculates the x layout of the staff entries within the staff measures belonging to one source measure. All staff entries are x-aligned throughout all the measures.

  Parameters

  • measures: GraphicalMeasure[]

    The minimum required x width of the source measure

  Returns number

ProtectedcalculateMoodAndUnknownExpression

• calculateMoodAndUnknownExpression(
      multiExpression: MultiExpression,
      measureIndex: number,
      staffIndex: number,
  ): void

  Calculate all the Mood and Unknown Expressions for a single [[MultiExpression]].

  Parameters

  • multiExpression: MultiExpression
  • measureIndex: number
  • staffIndex: number

  Returns void

ProtectedcalculateMusicSystems

• calculateMusicSystems(): void

  Store the newly computed [[Measure]]s in newly created [[MusicSystem]]s.

  Returns void

ProtectedcalculatePageLabels

• calculatePageLabels(page: GraphicalMusicPage): void

  Parameters

  • page: GraphicalMusicPage

  Returns void

ProtectedcalculateRehearsalMark

• calculateRehearsalMark(measure: SourceMeasure): void

  Parameters

  • measure: SourceMeasure

  Returns void

ProtectedcalculateRestNotePlacementWithinGraphicalBeam

• calculateRestNotePlacementWithinGraphicalBeam(
      graphicalStaffEntry: GraphicalStaffEntry,
      restNote: GraphicalNote,
      previousNote: GraphicalNote,
      nextStaffEntry: GraphicalStaffEntry,
      nextNote: GraphicalNote,
  ): void

  Parameters

  • graphicalStaffEntry: GraphicalStaffEntry
  • restNote: GraphicalNote
  • previousNote: GraphicalNote
  • nextStaffEntry: GraphicalStaffEntry
  • nextNote: GraphicalNote

  Returns void

ProtectedcalculateSheetLabelBoundingBoxes

• calculateSheetLabelBoundingBoxes(): void

  Returns void

ProtectedcalculateSingleOctaveShift

• calculateSingleOctaveShift(
      sourceMeasure: SourceMeasure,
      multiExpression: MultiExpression,
      measureIndex: number,
      staffIndex: number,
  ): void

  Calculate a single OctaveShift for a [[MultiExpression]].

  Parameters

  • sourceMeasure: SourceMeasure
  • multiExpression: MultiExpression
  • measureIndex: number
  • staffIndex: number

  Returns void

Protected AbstractcalculateSinglePedal

• calculateSinglePedal(
      sourceMeasure: SourceMeasure,
      multiExpression: MultiExpression,
      measureIndex: number,
      staffIndex: number,
  ): void

  Calculate a single Pedal for a [[MultiExpression]].

  Parameters

  • sourceMeasure: SourceMeasure
  • multiExpression: MultiExpression
  • measureIndex: number
  • staffIndex: number

  Returns void

ProtectedcalculateSingleStaffLineLyricsPosition

• calculateSingleStaffLineLyricsPosition(
      staffLine: StaffLine,
      lyricVersesNumber: string[],
  ): GraphicalStaffEntry[]

  Calculate the Lyrics YPositions for a single [[StaffLine]].

  Parameters

  • staffLine: StaffLine
  • lyricVersesNumber: string[]

  Returns GraphicalStaffEntry[]

ProtectedcalculateSkyBottomLines

• calculateSkyBottomLines(): void

  Returns void

ProtectedcalculateSlurs

• calculateSlurs(): void

  Returns void

ProtectedcalculateTempoExpressionsForMultiTempoExpression

• calculateTempoExpressionsForMultiTempoExpression(
      sourceMeasure: SourceMeasure,
      multiTempoExpression: MultiTempoExpression,
      measureIndex: number,
  ): void

  Parameters

  • sourceMeasure: SourceMeasure
  • multiTempoExpression: MultiTempoExpression
  • measureIndex: number

  Returns void

ProtectedcalculateTupletNumbers

• calculateTupletNumbers(): void

  Returns void

ProtectedcalculateWordRepetitionInstruction

• calculateWordRepetitionInstruction(
      repetitionInstruction: RepetitionInstruction,
      measureIndex: number,
  ): void

  Calculate all the textual [[RepetitionInstruction]]s (e.g. dal segno) for a single [[SourceMeasure]].

  Parameters

  • repetitionInstruction: RepetitionInstruction
  • measureIndex: number

  Returns void

ProtectedcheckMeasuresForWholeRestNotes

• checkMeasuresForWholeRestNotes(): void

  Returns void

ProtectedclearRecreatedObjects

• clearRecreatedObjects(): void

  Delete all Objects that must be recalculated. If graphicalMusicSheet.reCalculate has been called, then this method will be called to reset or remove all flexible graphical music symbols (e.g. Ornaments, Lyrics, Slurs) graphicalMusicSheet will have MusicPages, they will have MusicSystems etc...

  Returns void

ProtectedclearSystemsAndMeasures

• clearSystemsAndMeasures(): void

  Returns void

ProtectedcreateGraphicalTie

• createGraphicalTie(
      tie: Tie,
      startGse: GraphicalStaffEntry,
      endGse: GraphicalStaffEntry,
      startNote: GraphicalNote,
      endNote: GraphicalNote,
  ): GraphicalTie

  Parameters

  • tie: Tie
  • startGse: GraphicalStaffEntry
  • endGse: GraphicalStaffEntry
  • startNote: GraphicalNote
  • endNote: GraphicalNote

  Returns GraphicalTie

ProtectedcreateGraphicalTies

• createGraphicalTies(): void

  Returns void

ProtectedcreateMetronomeMark

• createMetronomeMark(metronomeExpression: InstantaneousTempoExpression): void

  Parameters

  • metronomeExpression: InstantaneousTempoExpression

  Returns void

ProtectedformatMeasures

• formatMeasures(): void

  Returns void

ProtectedgetRelativePositionInStaffLineFromTimestamp

• getRelativePositionInStaffLineFromTimestamp(
      timestamp: Fraction,
      verticalIndex: number,
      staffLine: StaffLine,
      multiStaffInstrument: boolean,
      firstVisibleMeasureRelativeX?: number,
      useLeftStaffEntryBorder?: boolean,
  ): PointF2D

  Parameters

  • timestamp: Fraction
  • verticalIndex: number
  • staffLine: StaffLine
  • multiStaffInstrument: boolean
  • firstVisibleMeasureRelativeX: number = 0.0
  • useLeftStaffEntryBorder: boolean = false

  Returns PointF2D

ProtectedgetRelativeXPositionFromTimestamp

• getRelativeXPositionFromTimestamp(timestamp: Fraction): number

  Parameters

  • timestamp: Fraction

  Returns number

ProtectedgraphicalMeasureCreatedCalculations

• graphicalMeasureCreatedCalculations(measure: GraphicalMeasure): void

  Parameters

  • measure: GraphicalMeasure

  Returns void

ProtectedhandleBeam

• handleBeam(graphicalNote: GraphicalNote, beam: Beam, openBeams: Beam[]): void

  Parameters

  • graphicalNote: GraphicalNote
  • beam: Beam
  • openBeams: Beam[]

  Returns void

ProtectedhandleStaffEntryLink

• handleStaffEntryLink(
      graphicalStaffEntry: GraphicalStaffEntry,
      staffEntryLinks: StaffEntryLink[],
  ): void

  This method handles a [[StaffEntryLink]].

  Parameters

  • graphicalStaffEntry: GraphicalStaffEntry
  • staffEntryLinks: StaffEntryLink[]

  Returns void

ProtectedhandleTiedGraphicalNote

• handleTiedGraphicalNote(
      tiedGraphicalNote: GraphicalNote,
      beams: Beam[],
      activeClef: ClefInstruction,
      octaveShiftValue: OctaveEnum,
      graphicalStaffEntry: GraphicalStaffEntry,
      duration: Fraction,
      openTie: Tie,
      isLastTieNote: boolean,
  ): void

  Check if the tied graphical note belongs to any beams or tuplets and react accordingly.

  Parameters

  • tiedGraphicalNote: GraphicalNote
  • beams: Beam[]
  • activeClef: ClefInstruction
  • octaveShiftValue: OctaveEnum
  • graphicalStaffEntry: GraphicalStaffEntry
  • duration: Fraction
  • openTie: Tie
  • isLastTieNote: boolean

  Returns void

ProtectedhandleTuplet

• handleTuplet(
      graphicalNote: GraphicalNote,
      tuplet: Tuplet,
      openTuplets: Tuplet[],
  ): void

  Parameters

  • graphicalNote: GraphicalNote
  • tuplet: Tuplet
  • openTuplets: Tuplet[]

  Returns void

ProtectedhandleVoiceEntry

• handleVoiceEntry(
      voiceEntry: VoiceEntry,
      graphicalStaffEntry: GraphicalStaffEntry,
      accidentalCalculator: AccidentalCalculator,
      openLyricWords: LyricWord[],
      activeClef: ClefInstruction,
      openTuplets: Tuplet[],
      openBeams: Beam[],
      octaveShiftValue: OctaveEnum,
      staffIndex: number,
      linkedNotes?: Note[],
      sourceStaffEntry?: SourceStaffEntry,
  ): OctaveEnum

  Parameters

  • voiceEntry: VoiceEntry
  • graphicalStaffEntry: GraphicalStaffEntry
  • accidentalCalculator: AccidentalCalculator
  • openLyricWords: LyricWord[]
  • activeClef: ClefInstruction
  • openTuplets: Tuplet[]
  • openBeams: Beam[]
  • octaveShiftValue: OctaveEnum
  • staffIndex: number
  • linkedNotes: Note[] = undefined
  • sourceStaffEntry: SourceStaffEntry = undefined

  Returns OctaveEnum

ProtectedhandleVoiceEntryArticulations

• handleVoiceEntryArticulations(
      articulations: Articulation[],
      voiceEntry: VoiceEntry,
      staffEntry: GraphicalStaffEntry,
  ): void

  Parameters

  • articulations: Articulation[]
  • voiceEntry: VoiceEntry
  • staffEntry: GraphicalStaffEntry

  Returns void

ProtectedhandleVoiceEntryLyrics

• handleVoiceEntryLyrics(
      voiceEntry: VoiceEntry,
      graphicalStaffEntry: GraphicalStaffEntry,
      openLyricWords: LyricWord[],
  ): void

  Parameters

  • voiceEntry: VoiceEntry
  • graphicalStaffEntry: GraphicalStaffEntry
  • openLyricWords: LyricWord[]

  Returns void

ProtectedhandleVoiceEntryOrnaments

• handleVoiceEntryOrnaments(
      ornamentContainer: OrnamentContainer,
      voiceEntry: VoiceEntry,
      graphicalStaffEntry: GraphicalStaffEntry,
  ): void

  Parameters

  • ornamentContainer: OrnamentContainer
  • voiceEntry: VoiceEntry
  • graphicalStaffEntry: GraphicalStaffEntry

  Returns void

ProtectedhandleVoiceEntryTechnicalInstructions

• handleVoiceEntryTechnicalInstructions(
      technicalInstructions: TechnicalInstruction[],
      voiceEntry: VoiceEntry,
      staffEntry: GraphicalStaffEntry,
  ): void

  Adds a technical instruction at the given staff entry.

  Parameters

  • technicalInstructions: TechnicalInstruction[]
  • voiceEntry: VoiceEntry
  • staffEntry: GraphicalStaffEntry

  Returns void

ProtectedinitGraphicalMeasuresCreation

• initGraphicalMeasuresCreation(): void

  Called for every source measure when generating the list of staff measures for it.

  Returns void

ProtectedlayoutArticulationMarks

• layoutArticulationMarks(
      articulations: Articulation[],
      voiceEntry: VoiceEntry,
      graphicalStaffEntry: GraphicalStaffEntry,
  ): void

  Parameters

  • articulations: Articulation[]
  • voiceEntry: VoiceEntry
  • graphicalStaffEntry: GraphicalStaffEntry

  Returns void

ProtectedlayoutBeams

• layoutBeams(staffEntry: GraphicalStaffEntry): void

  Parameters

  • staffEntry: GraphicalStaffEntry

  Returns void

ProtectedlayoutGraphicalTie

• layoutGraphicalTie(
      tie: GraphicalTie,
      tieIsAtSystemBreak: boolean,
      isTab: boolean,
  ): void

  Calculate the shape (Bézier curve) for this tie.

  Parameters

  • tie: GraphicalTie
  • tieIsAtSystemBreak: boolean
  • isTab: boolean

  Returns void

ProtectedlayoutMeasureWithWholeRest

• layoutMeasureWithWholeRest(
      rest: GraphicalNote,
      gse: GraphicalStaffEntry,
      measure: GraphicalMeasure,
  ): void

  Do layout on staff measures which only consist of a full rest.

  Parameters

  • rest: GraphicalNote
  • gse: GraphicalStaffEntry
  • measure: GraphicalMeasure

  Returns void

ProtectedlayoutOrnament

• layoutOrnament(
      ornaments: OrnamentContainer,
      voiceEntry: VoiceEntry,
      graphicalStaffEntry: GraphicalStaffEntry,
  ): void

  Parameters

  • ornaments: OrnamentContainer
  • voiceEntry: VoiceEntry
  • graphicalStaffEntry: GraphicalStaffEntry

  Returns void

ProtectedlayoutSingleRepetitionEnding

• layoutSingleRepetitionEnding(
      start: GraphicalMeasure,
      end: GraphicalMeasure,
      numberText: string,
      offset: number,
      leftOpen: boolean,
      rightOpen: boolean,
  ): void

  Calculate a single GraphicalRepetition.

  Parameters

  • start: GraphicalMeasure
  • end: GraphicalMeasure
  • numberText: string
  • offset: number
  • leftOpen: boolean
  • rightOpen: boolean

  Returns void

ProtectedlayoutStaffEntry

• layoutStaffEntry(graphicalStaffEntry: GraphicalStaffEntry): void

  Parameters

  • graphicalStaffEntry: GraphicalStaffEntry

  Returns void

ProtectedlayoutVoiceEntries

• layoutVoiceEntries(
      graphicalStaffEntry: GraphicalStaffEntry,
      staffIndex: number,
  ): void

  Parameters

  • graphicalStaffEntry: GraphicalStaffEntry
  • staffIndex: number

  Returns void

ProtectedlayoutVoiceEntry

• layoutVoiceEntry(
      voiceEntry: VoiceEntry,
      graphicalNotes: GraphicalNote[],
      graphicalStaffEntry: GraphicalStaffEntry,
      hasPitchedNote: boolean,
  ): void

  Parameters

  • voiceEntry: VoiceEntry
  • graphicalNotes: GraphicalNote[]
  • graphicalStaffEntry: GraphicalStaffEntry
  • hasPitchedNote: boolean

  Returns void

ProtectedmaxInstrNameLabelLength

• maxInstrNameLabelLength(): number

  Returns number

ProtectedoptimizeRestNotePlacement

• optimizeRestNotePlacement(
      graphicalStaffEntry: GraphicalStaffEntry,
      measure: GraphicalMeasure,
  ): void

  Parameters

  • graphicalStaffEntry: GraphicalStaffEntry
  • measure: GraphicalMeasure

  Returns void

ProtectedresetYPositionForLeadSheet

• resetYPositionForLeadSheet(psi: BoundingBox): void

  Parameters

  • psi: BoundingBox

  Returns void

ProtectedupdateStaffLineBorders

• updateStaffLineBorders(staffLine: StaffLine): void

  Parameters

  • staffLine: StaffLine

  Returns void

Protected StaticsetMeasuresMinStaffEntriesWidth

• setMeasuresMinStaffEntriesWidth(
      measures: GraphicalMeasure[],
      minimumStaffEntriesWidth: number,
  ): void

  Parameters

  • measures: GraphicalMeasure[]
  • minimumStaffEntriesWidth: number

  Returns void