Class SystemLine

Hierarchy (View Summary)

GraphicalObject
- SystemLine

Index

Constructors

Properties

bottomMeasure boundingBox linePosition lineType parentMusicSystem parentTopStaffLine topMeasure

Accessors

PositionAndShape

Methods

isInstanceOfClass getObjectWidthForLineType

Constructors

constructor

new SystemLine(
    lineType: SystemLinesEnum,
    linePosition: SystemLinePosition,
    musicSystem: MusicSystem,
    topMeasure: GraphicalMeasure,
    bottomMeasure?: GraphicalMeasure,
): SystemLine
Parameters
- lineType: SystemLinesEnum
- linePosition: SystemLinePosition
- musicSystem: MusicSystem
- topMeasure: GraphicalMeasure
- bottomMeasure: GraphicalMeasure = undefined
Returns SystemLine
Overrides GraphicalObject.constructor
- Defined in MusicalScore/Graphical/SystemLine.ts:12

Properties

bottomMeasure

bottomMeasure: GraphicalMeasure

`Protected`boundingBox

boundingBox: BoundingBox

linePosition

linePosition: SystemLinePosition

lineType

lineType: SystemLinesEnum

parentMusicSystem

parentMusicSystem: MusicSystem

parentTopStaffLine

parentTopStaffLine: StaffLine

topMeasure

topMeasure: GraphicalMeasure

Accessors

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

Methods

isInstanceOfClass

isInstanceOfClass(classOrName: string | ClassType<unknown>): boolean
Returns whether this object is an instance of the class, e.g. isInstanceOfClass(GraphicalMeasure).
Parameters
- classOrName: string | ClassType<unknown>
  The class, or its name (e.g. GraphicalMeasure.name). A name is unreliable in minified builds: they rename the classes, and give different classes the same name, e.g. "a" to GraphicalMeasure and GraphicalNote.
Returns boolean
Inherited from GraphicalObject.isInstanceOfClass
- Defined in MusicalScore/Interfaces/AClassHierarchyTrackable.ts:13

`Static`getObjectWidthForLineType

getObjectWidthForLineType(
rules: EngravingRules,
systemLineType: SystemLinesEnum,
): number
Return the width of the SystemLinesContainer for the given SystemLineType.
Parameters
- rules: EngravingRules
- systemLineType: SystemLinesEnum
Returns number
- Defined in MusicalScore/Graphical/SystemLine.ts:37