Class MRenderContext

Render context class.

Hierarchy (View Summary)

MRenderContext
- MRenderer

Index

Constructors

Methods

draw hilightObject hilightStaffPos setCanvas setDocument setScoreEventListener

Constructors

constructor

new MRenderContext(): MRenderContext
Create new render context instance.

Returns MRenderContext

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): MRenderContext
Set target canvas html element for this render context.
Parameters
- canvas: string | HTMLCanvasElement
  HTML canvas element or element id.
Returns MRenderContext
- This render context instance.

setDocument

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

setScoreEventListener

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