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 (View Summary)

GraphicalObject
- StaffLine
  - VexFlowStaffLine

Constructors

constructor

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

Properties

`Protected`abstractExpressions

abstractExpressions: AbstractGraphicalExpression[] = []

`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

Pedals

Pedals: GraphicalPedal[] = []

`Protected`skyBottomLine

skyBottomLine: SkyBottomLineCalculator

`Protected`staffLines

staffLines: GraphicalLine[] = ...

Accessors

AbstractExpressions

get AbstractExpressions(): AbstractGraphicalExpression[]
Returns AbstractGraphicalExpression[]
- Defined in MusicalScore/Graphical/StaffLine.ts:119
set AbstractExpressions(value: AbstractGraphicalExpression[]): void
Parameters
- value: AbstractGraphicalExpression[]
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:123

BottomLine

get BottomLine(): number[]
Returns number[]
- Defined in MusicalScore/Graphical/StaffLine.ts:163

BottomLineOffset

get BottomLineOffset(): number
Returns number
- Defined in MusicalScore/Graphical/StaffLine.ts:184

GraphicalGlissandi

get GraphicalGlissandi(): GraphicalGlissando[]
Returns GraphicalGlissando[]
- Defined in MusicalScore/Graphical/StaffLine.ts:193

GraphicalSlurs

get GraphicalSlurs(): GraphicalSlur[]
Returns GraphicalSlur[]
- Defined in MusicalScore/Graphical/StaffLine.ts:189

LyricLines

get LyricLines(): GraphicalLine[]
Returns GraphicalLine[]
- Defined in MusicalScore/Graphical/StaffLine.ts:115
set LyricLines(value: GraphicalLine[]): void
Parameters
- value: GraphicalLine[]
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:127

LyricsDashes

get LyricsDashes(): GraphicalLabel[]
Returns GraphicalLabel[]
- Defined in MusicalScore/Graphical/StaffLine.ts:131
set LyricsDashes(value: GraphicalLabel[]): void
Parameters
- value: GraphicalLabel[]
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:135

Measures

get Measures(): GraphicalMeasure[]
Returns GraphicalMeasure[]
- Defined in MusicalScore/Graphical/StaffLine.ts:94
set Measures(value: GraphicalMeasure[]): void
Parameters
- value: GraphicalMeasure[]
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:98

NextStaffLine

get NextStaffLine(): StaffLine
Returns StaffLine
- Defined in MusicalScore/Graphical/StaffLine.ts:110

OctaveShifts

get OctaveShifts(): GraphicalOctaveShift[]
Returns GraphicalOctaveShift[]
- Defined in MusicalScore/Graphical/StaffLine.ts:167
set OctaveShifts(value: GraphicalOctaveShift[]): void
Parameters
- value: GraphicalOctaveShift[]
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:171

ParentMusicSystem

get ParentMusicSystem(): MusicSystem
Returns MusicSystem
- Defined in MusicalScore/Graphical/StaffLine.ts:139
set ParentMusicSystem(value: MusicSystem): void
Parameters
- value: MusicSystem
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:143

ParentStaff

get ParentStaff(): Staff
Returns Staff
- Defined in MusicalScore/Graphical/StaffLine.ts:147
set ParentStaff(value: Staff): void
Parameters
- value: Staff
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:151

PositionAndShape

get PositionAndShape(): BoundingBox
Returns BoundingBox
Inherited from GraphicalObject.PositionAndShape
- Defined in MusicalScore/Graphical/GraphicalObject.ts:8
set PositionAndShape(value: BoundingBox): void
Parameters
- value: BoundingBox
Returns void
Inherited from GraphicalObject.PositionAndShape
- Defined in MusicalScore/Graphical/GraphicalObject.ts:15

SkyBottomLineCalculator

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

SkyLine

get SkyLine(): number[]
Returns number[]
- Defined in MusicalScore/Graphical/StaffLine.ts:159

StaffHeight

get StaffHeight(): number
Returns number
- Defined in MusicalScore/Graphical/StaffLine.ts:177

StaffLines

get StaffLines(): GraphicalLine[]
Returns GraphicalLine[]
- Defined in MusicalScore/Graphical/StaffLine.ts:102
set StaffLines(value: GraphicalLine[]): void
Parameters
- value: GraphicalLine[]
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:106

TopLineOffset

get TopLineOffset(): number
Returns number
- Defined in MusicalScore/Graphical/StaffLine.ts:181

Methods

addActivitySymbolClickArea

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

addGlissandoToStaffline

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

addSlurToStaffline

addSlurToStaffline(gSlur: GraphicalSlur): void
Add a given Graphical Slur to the staffline
Parameters
- gSlur: GraphicalSlur
Returns void
- Defined in MusicalScore/Graphical/StaffLine.ts:201

findClosestStaffEntry

findClosestStaffEntry(xPosition: number): GraphicalStaffEntry
Find the [[GraphicalStaffEntry]] closest to the given xPosition.
Parameters
- xPosition: number
Returns GraphicalStaffEntry
- Defined in MusicalScore/Graphical/StaffLine.ts:235

isInstanceOfClass

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

isPartOfMultiStaffInstrument

isPartOfMultiStaffInstrument(): boolean
True iff [[StaffLine]] belongs to an [[Instrument]] with more than one [[Staff]].

Returns boolean
- Defined in MusicalScore/Graphical/StaffLine.ts:222