Class SVGRenderingContext

constructor

• new SVGRenderingContext(
      canvas?: { height: number; width: number },
  ): SVGRenderingContext

  Parameters

  • Optionalcanvas: { height: number; width: number }

  Returns SVGRenderingContext

Readonlycanvas

fillStyle

font

globalAlpha

lineCap

lineJoin

lineWidth

strokeStyle

textAlign

textBaseline

arc

• arc(x: number, y: number, r: number, startAngle: number, endAngle: number): void

  Parameters

  • x: number
  • y: number
  • r: number
  • startAngle: number
  • endAngle: number

  Returns void

beginPath

• beginPath(): void

  Returns void

clearRect

• clearRect(_x: number, _y: number, _w: number, _h: number): void

  Parameters

  • _x: number
  • _y: number
  • _w: number
  • _h: number

  Returns void

clip

• clip(): void

  Apply the current path's bounding box as a rectangular clip for every element emitted until the matching restore(). The renderers only ever clip to axis-aligned rectangles (chart area / pane bands), so a bbox clip is exact for their usage.

  Returns void

closePath

• closePath(): void

  Returns void

createLinearGradient

• createLinearGradient(
      x0: number,
      y0: number,
      x1: number,
      y1: number,
  ): SVGGradient

  Parameters

  • x0: number
  • y0: number
  • x1: number
  • y1: number

  Returns SVGGradient

drawImage

• drawImage(..._args: unknown[]): void

  Raster image blits can't be vectorized; ignored in the SVG output.

  Parameters

  • ..._args: unknown[]

  Returns void

fill

• fill(): void

  Returns void

fillRect

• fillRect(x: number, y: number, w: number, h: number): void

  Parameters

  • x: number
  • y: number
  • w: number
  • h: number

  Returns void

fillText

• fillText(text: string, x: number, y: number): void

  Parameters

  • text: string
  • x: number
  • y: number

  Returns void

getImageData

• getImageData(): { data: Uint8ClampedArray }

  Returns a 1×1 transparent stub; renderers only probe .data length.

  Returns { data: Uint8ClampedArray }

getLineDash

• getLineDash(): number[]

  Returns number[]

lineTo

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

  Parameters

  • x: number
  • y: number

  Returns void

measureText

• measureText(text: string): SVGTextMetrics

  Parameters

  • text: string

  Returns SVGTextMetrics

moveTo

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

  Parameters

  • x: number
  • y: number

  Returns void

quadraticCurveTo

• quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void

  Parameters

  • cpx: number
  • cpy: number
  • x: number
  • y: number

  Returns void

rect

• rect(x: number, y: number, w: number, h: number): void

  Parameters

  • x: number
  • y: number
  • w: number
  • h: number

  Returns void

restore

• restore(): void

  Returns void

save

• save(): void

  Returns void

scale

• scale(_x: number, _y: number): void

  HiDPI scale is irrelevant to a vector export (works in CSS px). No-op.

  Parameters

  • _x: number
  • _y: number

  Returns void

setLineDash

• setLineDash(segments: number[]): void

  Parameters

  • segments: number[]

  Returns void

stroke

• stroke(): void

  Returns void

strokeRect

• strokeRect(x: number, y: number, w: number, h: number): void

  Parameters

  • x: number
  • y: number
  • w: number
  • h: number

  Returns void

strokeText

• strokeText(text: string, x: number, y: number): void

  Renderers don't stroke text; provided for API completeness (renders as fill).

  Parameters

  • text: string
  • x: number
  • y: number

  Returns void

toSVG

• toSVG(width: number, height: number, background?: string): string

  Serialize everything recorded so far into a standalone <svg> document string of the given pixel size, with background painted as a full-bleed rect underneath the recorded elements.

  Parameters

  • width: number
  • height: number
  • Optionalbackground: string

  Returns string