Class WmsView

Hierarchy (View Summary)

WmsView
- MRenderContext

Index

Constructors

Methods

draw hilightObject hilightStaffPos setCanvas setDocument setPaint setScoreEventListener setStaffSize setZoom getByElementId

Constructors

constructor

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

Returns WmsView

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;
        measure?: MMeasure;
        scoreRow?: MScoreRow;
        staff?: MStaff;
    },
): void
Draw given staff position hilighted.
Parameters
- OptionalstaffPos: { diatonicId: number; measure?: MMeasure; scoreRow?: MScoreRow; staff?: MStaff }
  Staff position information. Accepts ScoreStaffEvent and ScoreStaffPosEvent.
Returns void

setCanvas

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

setDocument

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

setPaint

setPaint(paint?: Paint): WmsView
Set Paint for this render context.
Parameters
- Optionalpaint: Paint
  Paint.
Returns WmsView
- This render context instance.
Deprecated
All paint stuff is deprecated. Will be removed in future release.

setScoreEventListener

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

setStaffSize

setStaffSize(staffSize?: StaffSize): WmsView
Set staff size, distance between top and bottom staff lines.
Parameters
- staffSize: StaffSize = "default"
  staff size e.g. 24, "24", "24px", "1cm", etc.
Returns WmsView
- This render context instance.

setZoom

setZoom(zoom?: number): WmsView
Set zoom level.
Parameters
- zoom: number = 1.0
  zoom level, default is 1.0.
Returns WmsView
- This render context instance.

`Static`getByElementId

getByElementId(elem: HTMLElement | null | undefined): WmsView | undefined
Get WmsView from custom HTML element .
Parameters
- elem: HTMLElement | null | undefined
  HTML element or element id.
Returns WmsView | undefined
- WmsView instance or undefined.