MusicPartManagerIterator | OpenSheetMusicDisplay

Hierarchy

MusicPartManagerIterator

Index

Constructors

constructor

Accessors

Constructors

constructor

new MusicPartManagerIterator(musicSheet: MusicSheet, startTimestamp?: Fraction, endTimestamp?: Fraction): MusicPartManagerIterator

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:20
Parameters
- musicSheet: MusicSheet
- Optional startTimestamp: Fraction
- Optional endTimestamp: Fraction
Returns MusicPartManagerIterator

Properties

SkipInvisibleNotes

SkipInvisibleNotes: boolean = true

Private activeDynamicExpressions

activeDynamicExpressions: AbstractExpression[] = []

Private activeTempoExpression

activeTempoExpression: MultiTempoExpression

backJumpOccurred

backJumpOccurred: boolean

Private currentBpm

currentBpm: number

Private currentDynamicChangingExpressions

currentDynamicChangingExpressions: DynamicsContainer[] = []

Private currentDynamicEntryIndex

currentDynamicEntryIndex: number = 0

Private currentEnrolledMeasureTimestamp

currentEnrolledMeasureTimestamp: Fraction = ...

Private currentMappingPart

currentMappingPart: MappingSourceMusicPart

Private currentMeasure

currentMeasure: SourceMeasure

Private currentMeasureIndex

currentMeasureIndex: number = 0

Private currentPartIndex

currentPartIndex: number = 0

Private currentRelativeInMeasureTimestamp

currentRelativeInMeasureTimestamp: Fraction = ...

Private currentRepetition

currentRepetition: Repetition = undefined

Private currentTempoChangingExpression

currentTempoChangingExpression: MultiTempoExpression

Private currentTempoEntryIndex

currentTempoEntryIndex: number = 0

currentTimeStamp

currentTimeStamp: Fraction = ...

Private currentVerticalContainerInMeasureTimestamp

currentVerticalContainerInMeasureTimestamp: Fraction = ...

Private currentVoiceEntries

currentVoiceEntries: VoiceEntry[]

Private currentVoiceEntryIndex

currentVoiceEntryIndex: number = -1

Private endReached

endReached: boolean = false

forwardJumpOccurred

forwardJumpOccurred: boolean

Private frontReached

frontReached: boolean = false

Private jumpResponsibleRepetition

jumpResponsibleRepetition: Repetition = undefined

Private musicSheet

musicSheet: MusicSheet

Private repetitionIterationCountDictKeys

repetitionIterationCountDictKeys: Repetition[]

Private repetitionIterationCountDictValues

repetitionIterationCountDictValues: number[]

Accessors

ActiveDynamicExpressions

get ActiveDynamicExpressions(): AbstractExpression[]

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:131
Returns AbstractExpression[]

ActiveTempoExpression

get ActiveTempoExpression(): MultiTempoExpression

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:128
Returns MultiTempoExpression

CurrentBpm

get CurrentBpm(): number

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:107
Returns number

CurrentEnrolledTimestamp

get CurrentEnrolledTimestamp(): Fraction

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:116
Returns Fraction

CurrentJumpResponsibleRepetitionIterationBeforeJump

get CurrentJumpResponsibleRepetitionIterationBeforeJump(): number

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:101
Returns number

CurrentMeasure

get CurrentMeasure(): SourceMeasure

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:89
Returns SourceMeasure

CurrentMeasureIndex

get CurrentMeasureIndex(): number

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:113
Returns number

CurrentRelativeInMeasureTimestamp

get CurrentRelativeInMeasureTimestamp(): Fraction

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:122
Returns Fraction

CurrentRepetition

get CurrentRepetition(): Repetition

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:92
Returns Repetition

CurrentRepetitionIteration

get CurrentRepetitionIteration(): number

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:95
Returns number

CurrentSourceTimestamp

get CurrentSourceTimestamp(): Fraction

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:119
Returns Fraction

CurrentTempoChangingExpression

get CurrentTempoChangingExpression(): MultiTempoExpression

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:134
Returns MultiTempoExpression

CurrentVoiceEntries

get CurrentVoiceEntries(): VoiceEntry[]

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:110
Returns VoiceEntry[]

EndReached

get EndReached(): boolean

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:83
Returns boolean

FrontReached

get FrontReached(): boolean

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:86
Returns boolean

JumpOccurred

get JumpOccurred(): boolean

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:125
Returns boolean

JumpResponsibleRepetition

get JumpResponsibleRepetition(): Repetition

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:137
Returns Repetition

Methods

CurrentAudibleVoiceEntries

CurrentAudibleVoiceEntries(instrument?: Instrument): VoiceEntry[]

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:187
Returns the visible voice entries for the provided instrument of the current iterator position.

Parameters
- Optional instrument: Instrument
  
  Returns: A List of voiceEntries. If there are no entries the List has a Count of 0 (it does not return null).
Returns VoiceEntry[]

CurrentScoreFollowingVoiceEntries

CurrentScoreFollowingVoiceEntries(instrument?: Instrument): VoiceEntry[]

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:221
Returns the score following voice entries for the provided instrument of the current iterator position.

Parameters
- Optional instrument: Instrument
  
  Returns: A List of voiceEntries. If there are no entries the List has a Count of 0 (it does not return null).
Returns VoiceEntry[]

CurrentVisibleVoiceEntries

CurrentVisibleVoiceEntries(instrument?: Instrument): VoiceEntry[]

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:162
Returns the visible voice entries for the provided instrument of the current iterator position.

Parameters
- Optional instrument: Instrument
  
  Returns: A List of voiceEntries. If there are no entries the List has a Count of 0 (it does not return null).
Returns VoiceEntry[]

Private activateCurrentDynamicOrTempoInstructions

activateCurrentDynamicOrTempoInstructions(): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:442
Returns void

Private activateCurrentRhythmInstructions

activateCurrentRhythmInstructions(): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:427
Returns void

Private checkEntries

checkEntries(notesOnly: boolean): boolean

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:609
helper function for moveToNextVisibleVoiceEntry and moveToPreviousVisibleVoiceEntry Get all entries and check if there is at least one valid entry in the list

Parameters
- notesOnly: boolean
Returns boolean

clone

clone(startTimeStamp?: Fraction, endTimeStamp?: Fraction): MusicPartManagerIterator

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:144
Creates a clone of this iterator which has the same actual position.

Parameters
- startTimeStamp: Fraction = undefined
- endTimeStamp: Fraction = undefined
Returns MusicPartManagerIterator

Private doBackJump

doBackJump(currentRepetition: Repetition): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:420
Parameters
- currentRepetition: Repetition
Returns void

Private getAudibleEntries

getAudibleEntries(entry: VoiceEntry, audibleEntries: VoiceEntry[]): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:635
Parameters
- entry: VoiceEntry
- audibleEntries: VoiceEntry[]
Returns void

getCurrentDynamicChangingExpressions

getCurrentDynamicChangingExpressions(): DynamicsContainer[]

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:211
Returns the audible dynamics of the current iterator position. Returns: A List of Dynamics. If there are no entries the List has a Count of 0 (it does not return null).

Returns DynamicsContainer[]

Private getRepetitionIterationCount

getRepetitionIterationCount(rep: Repetition): number

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:308
Parameters
- rep: Repetition
Returns number

Private getScoreFollowingEntries

getScoreFollowingEntries(entry: VoiceEntry, followingEntries: VoiceEntry[]): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:640
Parameters
- entry: VoiceEntry
- followingEntries: VoiceEntry[]
Returns void

Private getVisibleEntries

getVisibleEntries(entry: VoiceEntry, visibleEntries: VoiceEntry[]): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:620
Parameters
- entry: VoiceEntry
- visibleEntries: VoiceEntry[]
Returns void

Private getVoiceEntries

getVoiceEntries(container: VerticalSourceStaffEntryContainer): VoiceEntry[]

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:645
Parameters
- container: VerticalSourceStaffEntryContainer
Returns VoiceEntry[]

Private handleRepetitionsAtMeasureBegin

handleRepetitionsAtMeasureBegin(): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:358
Returns void

Private handleRepetitionsAtMeasureEnd

handleRepetitionsAtMeasureEnd(): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:377
Returns void

Private incrementRepetitionIterationCount

incrementRepetitionIterationCount(repetition: Repetition): number

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:291
Parameters
- repetition: Repetition
Returns number

moveToNext

moveToNext(): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:265
Returns void

moveToNextVisibleVoiceEntry

moveToNextVisibleVoiceEntry(notesOnly: boolean): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:281
Parameters
- notesOnly: boolean
Returns void

moveToPrevious

moveToPrevious(): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:246
Returns void

moveToPreviousVisibleVoiceEntry

moveToPreviousVisibleVoiceEntry(notesOnly: boolean): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:257
Parameters
- notesOnly: boolean
Returns void

Private recursiveMove

recursiveMove(): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:568
Returns void

Private recursiveMoveBack

recursiveMoveBack(): void

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:530
Returns void

Private resetRepetitionIterationCount

resetRepetitionIterationCount(repetition: Repetition): number

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:287
Parameters
- repetition: Repetition
Returns number

Private setRepetitionIterationCount

setRepetitionIterationCount(repetition: Repetition, iterationCount: number): number

- Defined in MusicalScore/MusicParts/MusicPartManagerIterator.ts:298
Parameters
- repetition: Repetition
- iterationCount: number
Returns number

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

musicSheet: MusicSheet

Optional startTimestamp: Fraction

Optional endTimestamp: Fraction

Returns MusicPartManagerIterator

Properties

SkipInvisibleNotes

Private activeDynamicExpressions

Private activeTempoExpression

backJumpOccurred

Private currentBpm

Private currentDynamicChangingExpressions

Private currentDynamicEntryIndex

Private currentEnrolledMeasureTimestamp

Private currentMappingPart

Private currentMeasure

Private currentMeasureIndex

Private currentPartIndex

Private currentRelativeInMeasureTimestamp

Private currentRepetition

Private currentTempoChangingExpression

Private currentTempoEntryIndex

currentTimeStamp

Private currentVerticalContainerInMeasureTimestamp

Private currentVoiceEntries

Private currentVoiceEntryIndex

Private endReached

forwardJumpOccurred

Private frontReached

Private jumpResponsibleRepetition

Private musicSheet

Private repetitionIterationCountDictKeys

Private repetitionIterationCountDictValues

Accessors

ActiveDynamicExpressions

Returns AbstractExpression[]

ActiveTempoExpression

Returns MultiTempoExpression

CurrentBpm

Returns number

CurrentEnrolledTimestamp

Returns Fraction

CurrentJumpResponsibleRepetitionIterationBeforeJump

Returns number

CurrentMeasure

Returns SourceMeasure

CurrentMeasureIndex

Returns number

CurrentRelativeInMeasureTimestamp

Returns Fraction

CurrentRepetition

Returns Repetition

CurrentRepetitionIteration

Returns number

CurrentSourceTimestamp

Returns Fraction

CurrentTempoChangingExpression

Returns MultiTempoExpression

CurrentVoiceEntries

Returns VoiceEntry[]

EndReached

Returns boolean

FrontReached

Returns boolean

JumpOccurred

Returns boolean

JumpResponsibleRepetition

Returns Repetition

Methods

CurrentAudibleVoiceEntries

Parameters

Optional instrument: Instrument