Class VexFlowBackendAbstract

constructor

• new VexFlowBackend(): VexFlowBackend

  Returns VexFlowBackend

graphicalMusicPage

height

width

Abstractclear

• clear(): void

  Returns void

Abstractfree

• free(): void

  (Try to) free memory. Currently only relevant on iOS.

  Returns void

getCanvas

• getCanvas(): HTMLElement

  Returns HTMLElement

AbstractgetCanvasSize

• getCanvasSize(): number

  Returns number

AbstractgetContext

• getContext(): IRenderContext

  Returns IRenderContext

getInnerElement

• getInnerElement(): HTMLElement

  Returns HTMLElement

AbstractgetOSMDBackendType

• getOSMDBackendType(): BackendType

  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

  Returns HTMLElement

getRenderer

• getRenderer(): Renderer

  Returns Renderer

AbstractgetVexflowBackendType

• getVexflowBackendType(): Backends

  Returns Backends

Abstractinitialize

• initialize(container: HTMLElement, zoom: number, id?: string): void

  Parameters

  • container: HTMLElement
  • zoom: number
  • Optionalid: string

  Returns void

removeAllChildrenFromContainer

• removeAllChildrenFromContainer(container: HTMLElement): void

  Parameters

  • container: HTMLElement

  Returns void

removeFromContainer

• removeFromContainer(container: HTMLElement): void

  Parameters

  • container: HTMLElement

  Returns void

AbstractrenderCurve

• renderCurve(
      points: PointF2D[],
      isSlur?: boolean,
      startNote?: VexFlowGraphicalNote,
  ): Node

  Parameters

  • points: PointF2D[]
  • OptionalisSlur: boolean
  • OptionalstartNote: VexFlowGraphicalNote

  Returns Node

AbstractrenderLine

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

  Parameters

  • start: PointF2D
  • stop: PointF2D
  • color: string
  • lineWidth: number
  • Optionalid: string

  Returns Node

AbstractrenderPath

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

  Parameters

  • points: PointF2D[]
  • fill: boolean
  • Optionalid: string
  • Optionalcolor: string

  Returns Node

AbstractrenderRectangle

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

  Renders a rectangle with the given style to the screen. It is given in screen coordinates.

  Parameters

  • rectangle: RectangleF2D

    the rect in screen coordinates

  • styleId: number

    the style id

  • colorHex: string
  • alpha: number

    alpha value between 0 and 1

  Returns Node

AbstractrenderText

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

  Renders a text to the screen.

  Parameters

  • fontHeight: number
  • fontStyle: FontStyles
  • font: Fonts
  • text: string
  • heightInPixel: number
  • screenPosition: PointF2D
  • Optionalcolor: string
  • OptionalfontFamily: string
  • Optionallanguage: string

    the language of the text as a BCP 47 tag (e.g. "ja"), for the browser's choice of fonts (see Label.language)

  Returns Node

resize

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

  Parameters

  • width: number
  • height: number

  Returns void

Abstractscale

• scale(k: number): void

  Parameters

  • k: number

  Returns void

Abstracttranslate

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

  Parameters

  • x: number
  • y: number

  Returns void