Options
All
  • Public
  • Public/Protected
  • All
Menu

This is the representation of a complete piece of sheet music. It includes the contents of a MusicXML file after the reading. Notes: the musicsheet might not need the Rules, e.g. in the testframework. The EngravingRules Constructor fails when no FontInfo exists, which needs a TextMeasurer

Hierarchy

  • MusicSheet

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

MeasureWidthFactor: number = 1.0

Global factor / scale by which all measure widths will be scaled. (e.g. 0.7 = all measures are only 70% as long) This is similar to SourceMeasure.widthFactor, which only applies to one measure and is multiplicative to the global factor. (so if globalWidthFactor is 0.7 and measure.widthFactor is 0.7, that measure's length will be 49% as long) As with measure.widthFactor, use this with caution, as it can cause overlaps, especially with lyrics.

composer: Label
copyright: Label
currentEnrolledPosition: Fraction = ...
defaultStartTempoInBpm: number = 0
drawErroneousMeasures: boolean = false
dynListStaves: DynamicsContainer[][] = []
hasBPMInfo: boolean
hasBeenOpenedForTheFirstTime: boolean = false
idString: string = "uninitialized"
instrumentalGroups: InstrumentalGroup[] = []
instruments: Instrument[] = []

The parts in the sheet, e.g. piano left hand, or piano right hand, or violin.

lyricist: Label
musicPartManager: MusicPartManager = undefined
musicSheetErrors: MusicSheetErrors = ...
pageWidth: number
path: string
playbackSettings: PlaybackSettings
repetitions: Repetition[] = []
selectionEnd: Fraction
selectionStart: Fraction
sourceMeasures: SourceMeasure[] = []
staves: Staff[] = []
subtitle: Label
timestampSortedDynamicExpressionsList: DynamicsContainer[] = []
timestampSortedTempoExpressionsList: MultiTempoExpression[] = []
title: Label
transpose: number = 0
userStartTempoInBPM: number
defaultTitle: string = "defaultTitle"

Accessors

  • get Composer(): Label
  • set Composer(value: Label): void
  • get ComposerString(): string
  • set ComposerString(value: string): void
  • get Copyright(): Label
  • set Copyright(value: Label): void
  • get CopyrightString(): string
  • set CopyrightString(value: string): void
  • get CurrentEnrolledPosition(): Fraction
  • set CurrentEnrolledPosition(value: Fraction): void
  • get DefaultStartTempoInBpm(): number
  • set DefaultStartTempoInBpm(value: number): void
  • get DrawErroneousMeasures(): boolean
  • set DrawErroneousMeasures(value: boolean): void
  • get DynListStaves(): DynamicsContainer[][]
  • get Errors(): {}
  • get FirstMeasureNumber(): number
  • get FullNameString(): string
  • get HasBPMInfo(): boolean
  • set HasBPMInfo(value: boolean): void
  • get HasBeenOpenedForTheFirstTime(): boolean
  • set HasBeenOpenedForTheFirstTime(value: boolean): void
  • get IdString(): string
  • set IdString(value: string): void
  • get LastMeasureNumber(): number
  • get Lyricist(): Label
  • set Lyricist(value: Label): void
  • get LyricistString(): string
  • set LyricistString(value: string): void
  • get Path(): string
  • set Path(value: string): void
  • get Subtitle(): Label
  • set Subtitle(value: Label): void
  • get SubtitleString(): string
  • set SubtitleString(value: string): void
  • get TimestampSortedDynamicExpressionsList(): DynamicsContainer[]
  • get TimestampSortedTempoExpressionsList(): MultiTempoExpression[]
  • get TitleString(): string
  • set TitleString(value: string): void
  • get Transpose(): number
  • set Transpose(value: number): void
  • Returns number

  • Sets the number of halftones for transposition. E.g. +1 halftone will transpose Eb major to E major. also see Instrument.Transpose (e.g. osmd.Sheet.Instruments[0].Transpose will additionally transpose this instrument only) osmd.TransposeCaculator needs to be defined/created for this to take effect. (just set it with new TransposeCalculator())

    Parameters

    • value: number

    Returns void

Methods

  • InitializeStartTempoInBPM(startTempo: number): void
  • checkForInstrumentWithNoVoice(): void
  • fillStaffList(): void
  • getCompleteNumberOfStaves(): number
  • getEnrolledSelectionStartTimeStampWorkaround(): Fraction
  • getExpressionsStartTempoInBPM(): number
  • getGlobalStaffIndexOfFirstStaff(instrument: Instrument): number
  • getListOfMeasuresFromIndeces(start: number, end: number): SourceMeasure[]
  • getMusicSheetInstrumentIndex(instrument: Instrument): number
  • getStaffFromIndex(staffIndexInMusicSheet: number): Staff
  • resetAllNoteStates(): void
  • setRepetitionNewUserNumberOfRepetitions(index: number, value: number): void
  • Set to the index-given Repetition a new (set from user) value.

    Parameters

    • index: number
    • value: number

    Returns void

  • getIndexFromStaff(staff: Staff): number

Generated using TypeDoc