Class SvgVexFlowBackend

constructor

• new SvgVexFlowBackend(rules: EngravingRules): SvgVexFlowBackend

  Parameters

  • rules: EngravingRules

  Returns SvgVexFlowBackend

zoom

clear

• clear(): void

  Returns void

export

• export(): void

  Returns void

free

• free(): void

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

  Returns void

getCanvasSize

• getCanvasSize(): number

  Returns number

getContext

• getContext(): SVGContext

  Returns SVGContext

getOSMDBackendType

• 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

getSvgElement

• getSvgElement(): SVGElement

  Returns SVGElement

getVexflowBackendType

• getVexflowBackendType(): Backends

  Returns Backends

initialize

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

  Parameters

  • container: HTMLElement
  • zoom: number

  Returns void

removeNode

• removeNode(node: Node): boolean

  Parameters

  • node: Node

  Returns boolean

renderCurve

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

  Parameters

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

  Returns Node

renderLine

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

  Parameters

  • start: PointF2D
  • stop: PointF2D
  • color: string = "#FF0000FF"
  • lineWidth: number = 2
  • Optionalid: string

  Returns Node

renderPath

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

  Parameters

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

  Returns Node

renderRectangle

• 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 = 1

    alpha value between 0 and 1

  Returns Node

renderText

• 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
  • color: string = undefined
  • fontFamily: string = undefined
  • language: string = undefined

    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

scale

• scale(k: number): void

  Parameters

  • k: number

  Returns void

translate

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

  Parameters

  • x: number
  • y: number

  Returns void