Class Renderer

Support Canvas & SVG rendering contexts.

Index

Constructors

Properties

ctx Backends lastContext? LineEndType

Methods

getContext resize buildContext drawDashedLine getCanvasContext getSVGContext

Constructors

constructor

new Renderer(context: RenderContext): Renderer
Parameters
- context: RenderContext
Returns Renderer
- Defined in vexflow/src/renderer.ts:113
new Renderer(
canvas: string | HTMLCanvasElement | HTMLDivElement,
backend: number,
): Renderer
Parameters
- canvas: string | HTMLCanvasElement | HTMLDivElement
- backend: number
Returns Renderer
- Defined in vexflow/src/renderer.ts:114

Properties

`Protected`ctx

ctx: RenderContext

`Static`Backends

Backends: typeof RendererBackends = RendererBackends

`Static` `Optional`lastContext

lastContext?: RenderContext = undefined

`Static`LineEndType

LineEndType: typeof RendererLineEndType = RendererLineEndType

Methods

getContext

getContext(): RenderContext
Returns RenderContext
- Defined in vexflow/src/renderer.ts:163

resize

resize(width: number, height: number): this
Parameters
- width: number
- height: number
Returns this
- Defined in vexflow/src/renderer.ts:158

`Static`buildContext

buildContext(
    elementId: string | HTMLCanvasElement | HTMLDivElement,
    backend: number,
    width: number,
    height: number,
    background?: string,
): RenderContext
Parameters
- elementId: string | HTMLCanvasElement | HTMLDivElement
- backend: number
- width: number
- height: number
- background: string = '#FFF'
Returns RenderContext
- Defined in vexflow/src/renderer.ts:39

`Static`drawDashedLine

drawDashedLine(
    context: RenderContext,
    fromX: number,
    fromY: number,
    toX: number,
    toY: number,
    dashPattern: number[],
): void
Parameters
- context: RenderContext
- fromX: number
- fromY: number
- toX: number
- toY: number
- dashPattern: number[]
Returns void
- Defined in vexflow/src/renderer.ts:68

`Static`getCanvasContext

getCanvasContext(
    elementId: string,
    width: number,
    height: number,
    background?: string,
): RenderContext
Parameters
- elementId: string
- width: number
- height: number
- Optionalbackground: string
Returns RenderContext
- Defined in vexflow/src/renderer.ts:57

`Static`getSVGContext

getSVGContext(
    elementId: string,
    width: number,
    height: number,
    background?: string,
): RenderContext
Parameters
- elementId: string
- width: number
- height: number
- Optionalbackground: string
Returns RenderContext
- Defined in vexflow/src/renderer.ts:61