Class VexFlowInstrumentBracket

Class that defines a instrument bracket at the beginning of a line.

Hierarchy

GraphicalObject
- VexFlowInstrumentBracket
  - VexFlowInstrumentBrace

Index

Constructors

constructor

Properties

Accessors

PositionAndShape

Methods

Constructors

constructor

new VexFlowInstrumentBracket(firstVexFlowStaffLine: VexFlowStaffLine, lastVexFlowStaffLine: VexFlowStaffLine, depth?: number): VexFlowInstrumentBracket

Overrides GraphicalObject.constructor
- Defined in MusicalScore/Graphical/VexFlow/VexFlowInstrumentBracket.ts:17
Parameters
- firstVexFlowStaffLine: VexFlowStaffLine
- lastVexFlowStaffLine: VexFlowStaffLine
- depth: number = 0
Returns VexFlowInstrumentBracket

Properties

Visible

Visible: boolean = true

Protected boundingBox

boundingBox: BoundingBox

vexflowConnector

vexflowConnector: StaveConnector

Accessors

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:15
Parameters
- value: BoundingBox
Returns void

Methods

Private addConnector

addConnector(stave1: Stave, stave2: Stave, type: any, depth: number): void

- Defined in MusicalScore/Graphical/VexFlow/VexFlowInstrumentBracket.ts:53
Adds a connector between two staves

Parameters
- stave1: Stave
- stave2: Stave
- type: any
- depth: number
Returns void

draw

draw(ctx: IRenderContext): void

- Defined in MusicalScore/Graphical/VexFlow/VexFlowInstrumentBracket.ts:29
Render the bracket using the given backend

Parameters
- ctx: IRenderContext
  
  Render Vexflow context
Returns void

isInstanceOfClass

isInstanceOfClass(className: string): boolean

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

Generated using TypeDoc