Class MRenderer

Renderer class.

Index

Constructors

Methods

draw hilightObject hilightStaffPos setCanvas setDocument setScoreEventListener

Constructors

constructor

new MRenderer(): MRenderer
Create new renderer instance.

Returns MRenderer

Methods

draw

draw(): void
Draw contents of attached music document to attached canvas.

Returns void

hilightObject

hilightObject(obj?: MusicInterface): void
Draw given music object hilighted.
Parameters
- Optionalobj: MusicInterface
  Music object or undefined to remove hilighting.
Returns void

hilightStaffPos

hilightStaffPos(staffPos?: { diatonicId: number; scoreRow: MScoreRow }): void
Draw given staff position hilighted.
Parameters
- OptionalstaffPos: { diatonicId: number; scoreRow: MScoreRow }
  Staff position (score row and diatonic id) or undefined to remove hilighting.
Returns void

setCanvas

setCanvas(canvas: string | HTMLCanvasElement): MRenderer
Set target canvas html element for this renderer.
Parameters
- canvas: string | HTMLCanvasElement
  HTML canvas element or element id.
Returns MRenderer
- This renderer instance.

setDocument

setDocument(doc?: MDocument): MRenderer
Attach music document to this renderer.
Parameters
- Optionaldoc: MDocument
  Music document.
Returns MRenderer
- This renderer instance.

setScoreEventListener

setScoreEventListener(scoreEventListener: ScoreEventListener): void
Set score event listener.
Parameters
- scoreEventListener: ScoreEventListener
  Score event listener.
Returns void