Class CanvasVexFlowBackend

Hierarchy

VexFlowBackend
- CanvasVexFlowBackend

Constructors

constructor

new CanvasVexFlowBackend(rules: EngravingRules): CanvasVexFlowBackend

Overrides VexFlowBackend.constructor
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:17
Parameters
- rules: EngravingRules
Returns CanvasVexFlowBackend

Properties

Protected canvas

canvas: HTMLElement

Private ctx

ctx: CanvasContext

graphicalMusicPage

graphicalMusicPage: GraphicalMusicPage

The GraphicalMusicPage the backend is drawing from. Each backend only renders one GraphicalMusicPage, to which the coordinates are relative.

height

height: number

Protected inner

inner: HTMLElement

Protected renderer

renderer: Renderer

Protected rules

rules: EngravingRules

width

width: number

Private zoom

zoom: number

Accessors

CanvasRenderingCtx

get CanvasRenderingCtx(): CanvasRenderingContext2D

- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:204
Returns CanvasRenderingContext2D

Methods

clear

clear(): void

Overrides VexFlowBackend.clear
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:89
Returns void

free

free(): void

Overrides VexFlowBackend.free
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:77
(Try to) free memory. Currently only relevant on iOS.

Returns void

getCanvas

getCanvas(): HTMLElement

Inherited from VexFlowBackend.getCanvas
- Defined in MusicalScore/Graphical/VexFlow/VexFlowBackend.ts:34
Returns HTMLElement

getCanvasSize

getCanvasSize(): number

Overrides VexFlowBackend.getCanvasSize
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:30
Returns number

getContext

getContext(): CanvasContext

Overrides VexFlowBackend.getContext
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:73
Returns CanvasContext

getInnerElement

getInnerElement(): HTMLElement

Inherited from VexFlowBackend.getInnerElement
- Defined in MusicalScore/Graphical/VexFlow/VexFlowBackend.ts:30
Returns HTMLElement

getOSMDBackendType

getOSMDBackendType(): BackendType

Overrides VexFlowBackend.getOSMDBackendType
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:26
The general type of backend: Canvas or SVG. This is not used for now (only VexflowBackendType used), but it may be useful when we don't want to use a Vexflow class.

Returns BackendType

getRenderElement

getRenderElement(): HTMLElement

Inherited from VexFlowBackend.getRenderElement
- Defined in MusicalScore/Graphical/VexFlow/VexFlowBackend.ts:40
Returns HTMLElement

getRenderer

getRenderer(): Renderer

Inherited from VexFlowBackend.getRenderer
- Defined in MusicalScore/Graphical/VexFlow/VexFlowBackend.ts:52
Returns Renderer

getVexflowBackendType

getVexflowBackendType(): Backends

Overrides VexFlowBackend.getVexflowBackendType
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:22
Returns Backends

initialize

initialize(container: HTMLElement, zoom: number): void

Overrides VexFlowBackend.initialize
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:37
Parameters
- container: HTMLElement
- zoom: number
Returns void

initializeHeadless

initializeHeadless(width?: number, height?: number): void

- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:60
Initialize a canvas without attaching it to a DOM node. Can be used to draw in background

Parameters
- width: number = 300
  
  Width of the canvas
- height: number = 300
  
  Height of the canvas
Returns void

removeAllChildrenFromContainer

removeAllChildrenFromContainer(container: HTMLElement): void

Inherited from VexFlowBackend.removeAllChildrenFromContainer
- Defined in MusicalScore/Graphical/VexFlow/VexFlowBackend.ts:56
Parameters
- container: HTMLElement
Returns void

removeFromContainer

removeFromContainer(container: HTMLElement): void

Inherited from VexFlowBackend.removeFromContainer
- Defined in MusicalScore/Graphical/VexFlow/VexFlowBackend.ts:63
Parameters
- container: HTMLElement
Returns void

renderCurve

renderCurve(points: PointF2D[]): Node

Overrides VexFlowBackend.renderCurve
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:154
Parameters
- points: PointF2D[]
Returns Node

renderLine

renderLine(start: PointF2D, stop: PointF2D, color?: string, lineWidth?: number, id?: string): Node

Overrides VexFlowBackend.renderLine
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:143
Parameters
- start: PointF2D
- stop: PointF2D
- color: string = "#FF0000FF"
- lineWidth: number = 2
- Optional id: string
Returns Node

renderPath

renderPath(points: PointF2D[], fill?: boolean, id?: string): Node

Overrides VexFlowBackend.renderPath
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:181
Parameters
- points: PointF2D[]
- fill: boolean = true
- Optional id: string
Returns Node

renderRectangle

renderRectangle(rectangle: RectangleF2D, styleId: number, colorHex: string, alpha?: number): Node

Overrides VexFlowBackend.renderRectangle
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:129
Renders a rectangle with the given style to the screen. It is given in screen coordinates.

Parameters
- rectangle: RectangleF2D
- styleId: number
- colorHex: string
- alpha: number = 1
Returns Node

renderText

renderText(fontHeight: number, fontStyle: FontStyles, font: Fonts, text: string, heightInPixel: number, screenPosition: PointF2D, color?: string, fontFamily?: string): Node

Overrides VexFlowBackend.renderText
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:110
Parameters
- fontHeight: number
- fontStyle: FontStyles
- font: Fonts
- text: string
- heightInPixel: number
- screenPosition: PointF2D
- color: string = undefined
- fontFamily: string = undefined
Returns Node

resize

resize(width: number, height: number): void

Inherited from VexFlowBackend.resize
- Defined in MusicalScore/Graphical/VexFlow/VexFlowBackend.ts:83
Parameters
- width: number
- height: number
Returns void

scale

scale(k: number): void

Overrides VexFlowBackend.scale
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:103
Parameters
- k: number
Returns void

translate

translate(x: number, y: number): void

Overrides VexFlowBackend.translate
- Defined in MusicalScore/Graphical/VexFlow/CanvasVexFlowBackend.ts:107
Parameters
- x: number
- y: number
Returns void

Generated using TypeDoc