Class StaffLine Abstract

A StaffLine contains the [[Measure]]s in one line of the music sheet (one instrument, one line, until a line break)

Hierarchy

GraphicalObject
- StaffLine
  - VexFlowStaffLine

Constructors

constructor

new StaffLine(parentSystem: MusicSystem, parentStaff: Staff): StaffLine

Overrides GraphicalObject.constructor
- Defined in MusicalScore/Graphical/StaffLine.ts:42
Parameters
- parentSystem: MusicSystem
- parentStaff: Staff
Returns StaffLine

Properties

Pedals

Pedals: GraphicalPedal[] = []

Protected abstractExpressions

abstractExpressions: AbstractGraphicalExpression[] = []

Private bottomLineOffset

bottomLineOffset: number

Protected boundingBox

boundingBox: BoundingBox

Protected graphicalGlissandi

graphicalGlissandi: GraphicalGlissando[] = []

Protected graphicalSlurs

graphicalSlurs: GraphicalSlur[] = []

Protected lyricLines

lyricLines: GraphicalLine[] = []

Protected lyricsDashes

lyricsDashes: GraphicalLabel[] = []

Protected measures

measures: GraphicalMeasure[] = []

Protected octaveShifts

octaveShifts: GraphicalOctaveShift[] = []

Protected parentMusicSystem

parentMusicSystem: MusicSystem

Protected parentStaff

parentStaff: Staff

Protected skyBottomLine

skyBottomLine: SkyBottomLineCalculator

Private staffHeight

staffHeight: number

The staff height in units

Protected staffLines

staffLines: GraphicalLine[] = ...

Private topLineOffset

topLineOffset: number

Accessors

AbstractExpressions

get AbstractExpressions(): AbstractGraphicalExpression[]
set AbstractExpressions(value: AbstractGraphicalExpression[]): void

- Defined in MusicalScore/Graphical/StaffLine.ts:119
Returns AbstractGraphicalExpression[]
- Defined in MusicalScore/Graphical/StaffLine.ts:123
Parameters
- value: AbstractGraphicalExpression[]
Returns void

BottomLine

get BottomLine(): number[]

- Defined in MusicalScore/Graphical/StaffLine.ts:163
Returns number[]

BottomLineOffset

get BottomLineOffset(): number

- Defined in MusicalScore/Graphical/StaffLine.ts:184
Returns number

GraphicalGlissandi

get GraphicalGlissandi(): GraphicalGlissando[]

- Defined in MusicalScore/Graphical/StaffLine.ts:193
Returns GraphicalGlissando[]

GraphicalSlurs

get GraphicalSlurs(): GraphicalSlur[]

- Defined in MusicalScore/Graphical/StaffLine.ts:189
Returns GraphicalSlur[]

LyricLines

get LyricLines(): GraphicalLine[]
set LyricLines(value: GraphicalLine[]): void

- Defined in MusicalScore/Graphical/StaffLine.ts:115
Returns GraphicalLine[]
- Defined in MusicalScore/Graphical/StaffLine.ts:127
Parameters
- value: GraphicalLine[]
Returns void

LyricsDashes

get LyricsDashes(): GraphicalLabel[]
set LyricsDashes(value: GraphicalLabel[]): void

- Defined in MusicalScore/Graphical/StaffLine.ts:131
Returns GraphicalLabel[]
- Defined in MusicalScore/Graphical/StaffLine.ts:135
Parameters
- value: GraphicalLabel[]
Returns void

Measures

get Measures(): GraphicalMeasure[]
set Measures(value: GraphicalMeasure[]): void

- Defined in MusicalScore/Graphical/StaffLine.ts:94
Returns GraphicalMeasure[]
- Defined in MusicalScore/Graphical/StaffLine.ts:98
Parameters
- value: GraphicalMeasure[]
Returns void

NextStaffLine

get NextStaffLine(): StaffLine

- Defined in MusicalScore/Graphical/StaffLine.ts:110
Returns StaffLine

OctaveShifts

get OctaveShifts(): GraphicalOctaveShift[]
set OctaveShifts(value: GraphicalOctaveShift[]): void

- Defined in MusicalScore/Graphical/StaffLine.ts:167
Returns GraphicalOctaveShift[]
- Defined in MusicalScore/Graphical/StaffLine.ts:171
Parameters
- value: GraphicalOctaveShift[]
Returns void

ParentMusicSystem

get ParentMusicSystem(): MusicSystem
set ParentMusicSystem(value: MusicSystem): void

- Defined in MusicalScore/Graphical/StaffLine.ts:139
Returns MusicSystem
- Defined in MusicalScore/Graphical/StaffLine.ts:143
Parameters
- value: MusicSystem
Returns void

ParentStaff

get ParentStaff(): Staff
set ParentStaff(value: Staff): void

- Defined in MusicalScore/Graphical/StaffLine.ts:147
Returns Staff
- Defined in MusicalScore/Graphical/StaffLine.ts:151
Parameters
- value: Staff
Returns void

PositionAndShape

get PositionAndShape(): BoundingBox
set PositionAndShape(value: BoundingBox): void

Inherited from GraphicalObject.PositionAndShape
- Defined in MusicalScore/Graphical/GraphicalObject.ts:8
Returns BoundingBox
Inherited from GraphicalObject.PositionAndShape
- Defined in MusicalScore/Graphical/GraphicalObject.ts:12
Parameters
- value: BoundingBox
Returns void

SkyBottomLineCalculator

get SkyBottomLineCalculator(): SkyBottomLineCalculator

- Defined in MusicalScore/Graphical/StaffLine.ts:155
Returns SkyBottomLineCalculator

SkyLine

get SkyLine(): number[]

- Defined in MusicalScore/Graphical/StaffLine.ts:159
Returns number[]

StaffHeight

get StaffHeight(): number

- Defined in MusicalScore/Graphical/StaffLine.ts:177
Returns number

StaffLines

get StaffLines(): GraphicalLine[]
set StaffLines(value: GraphicalLine[]): void

- Defined in MusicalScore/Graphical/StaffLine.ts:102
Returns GraphicalLine[]
- Defined in MusicalScore/Graphical/StaffLine.ts:106
Parameters
- value: GraphicalLine[]
Returns void

TopLineOffset

get TopLineOffset(): number

- Defined in MusicalScore/Graphical/StaffLine.ts:181
Returns number

Methods

addActivitySymbolClickArea

addActivitySymbolClickArea(): void

- Defined in MusicalScore/Graphical/StaffLine.ts:210
Returns void

addGlissandoToStaffline

addGlissandoToStaffline(gGlissando: GraphicalGlissando): void

- Defined in MusicalScore/Graphical/StaffLine.ts:205
Parameters
- gGlissando: GraphicalGlissando
Returns void

addSlurToStaffline

addSlurToStaffline(gSlur: GraphicalSlur): void

- Defined in MusicalScore/Graphical/StaffLine.ts:201
Add a given Graphical Slur to the staffline

Parameters
- gSlur: GraphicalSlur
Returns void

Private calculateStaffLineOffsets

calculateStaffLineOffsets(): void

- Defined in MusicalScore/Graphical/StaffLine.ts:59
If the musicXML sets different numbers of stafflines, we need to have different offsets to accomodate this - primarily for the sky and bottom lines and cursor.

Returns void

findClosestStaffEntry

findClosestStaffEntry(xPosition: number): GraphicalStaffEntry

- Defined in MusicalScore/Graphical/StaffLine.ts:235
Find the GraphicalStaffEntry closest to the given xPosition.

Parameters
- xPosition: number
Returns GraphicalStaffEntry

isInstanceOfClass

isInstanceOfClass(className: string): boolean

Inherited from GraphicalObject.isInstanceOfClass
- Defined in MusicalScore/Interfaces/AClassHierarchyTrackable.ts:5
Parameters
- className: string
Returns boolean

isPartOfMultiStaffInstrument

isPartOfMultiStaffInstrument(): boolean

- Defined in MusicalScore/Graphical/StaffLine.ts:222
True iff StaffLine belongs to an Instrument with more than one Staff.

Returns boolean

Generated using TypeDoc