Class GraphicalOctaveShift

The graphical counterpart of an [[OctaveShift]]

Hierarchy (View Summary)

GraphicalObject
- GraphicalOctaveShift
  - VexFlowOctaveShift

Index

Constructors

Properties

boundingBox dashesEnd dashesStart endMeasure endsOnDifferentStaffLine getOctaveShift graphicalEndAtMeasureEnd isFirstPart isSecondPart octaveSymbol

Accessors

PositionAndShape

Methods

isInstanceOfClass

Constructors

constructor

new GraphicalOctaveShift(
octaveShift: OctaveShift,
parent: BoundingBox,
): GraphicalOctaveShift
Parameters
- octaveShift: OctaveShift
- parent: BoundingBox
Returns GraphicalOctaveShift
Overrides GraphicalObject.constructor
- Defined in MusicalScore/Graphical/GraphicalOctaveShift.ts:14

Properties

`Protected`boundingBox

boundingBox: BoundingBox

dashesEnd

dashesEnd: PointF2D

dashesStart

dashesStart: PointF2D

endMeasure

endMeasure: GraphicalMeasure

The measure in which this OctaveShift (which can be a part/bracket of a multi-line shift) ends graphically.

endsOnDifferentStaffLine

endsOnDifferentStaffLine: boolean

getOctaveShift

getOctaveShift: OctaveShift

graphicalEndAtMeasureEnd

graphicalEndAtMeasureEnd: boolean

Whether the octave shift should be drawn until the end of the measure, instead of the current note.

isFirstPart

isFirstPart: boolean

isSecondPart

isSecondPart: boolean

octaveSymbol

octaveSymbol: MusicSymbol

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