Class SVGRenderer

constructor

• new SVGRenderer(configuration: TIIRendererConfiguration): SVGRenderer

  Parameters

  • configuration: TIIRendererConfiguration

  Returns SVGRenderer

appendElement

• appendElement(el: Element): void

  Parameters

  • el: Element

  Returns void

buildElementFromSymbol

• buildElementFromSymbol(
      symbol: TIISymbol | IIEraser,
  ): SVGGraphicsElement | undefined

  Parameters

  • symbol: TIISymbol | IIEraser

  Returns SVGGraphicsElement | undefined

changeOrderSymbol

• changeOrderSymbol(
      symbolToMove: TIISymbol,
      position: "first" | "last" | "forward" | "backward",
  ): void

  Parameters

  • symbolToMove: TIISymbol
  • position: "first" | "last" | "forward" | "backward"

  Returns void

clear

• clear(): void

  Clear/reset the rendering context

  Returns void

clearElements

• clearElements(
      __namedParameters: {
          attrs?: { [key: string]: string };
          tagName?: string;
      },
  ): void

  Parameters

  • __namedParameters: { attrs?: { [key: string]: string }; tagName?: string }

  Returns void

destroy

• destroy(): void

  Returns void

drawCircle

• drawCircle(
      point: TPoint,
      radius: number,
      attrs?: { [key: string]: string },
  ): void

  Parameters

  • point: TPoint
  • radius: number
  • attrs: { [key: string]: string } = {}

  Returns void

drawConnectionBetweenBox

• drawConnectionBetweenBox(
      id: string,
      box1: TBox,
      box2: TBox,
      position: "corners" | "sides",
      attrs?: { [key: string]: string },
  ): void

  Parameters

  • id: string
  • box1: TBox
  • box2: TBox
  • position: "corners" | "sides"
  • Optionalattrs: { [key: string]: string }

  Returns void

drawLine

• drawLine(p1: TPoint, p2: TPoint, attrs?: { [key: string]: string }): void

  Parameters

  • p1: TPoint
  • p2: TPoint
  • attrs: { [key: string]: string } = {}

  Returns void

drawRect

• drawRect(box: TBox, attrs?: { [key: string]: string }): void

  Parameters

  • box: TBox
  • attrs: { [key: string]: string } = {}

  Returns void

drawSymbol

• drawSymbol(symbol: TIISymbol | IIEraser): SVGGraphicsElement | undefined

  Parameters

  • symbol: TIISymbol | IIEraser

  Returns SVGGraphicsElement | undefined

ensurePointVisible

• ensurePointVisible(point: TPoint, margin?: number): void

  Ensure a point is visible in the viewBox by panning if necessary

  Parameters

  • point: TPoint

    Point to make visible

  • margin: number = 50

    Optional margin around the point (default: 50)

  Returns void

getAttribute

• getAttribute(id: string, name: string): string | null | undefined

  Parameters

  • id: string
  • name: string

  Returns string | null | undefined

getElementById

• getElementById(id: string): SVGGraphicsElement | null

  Parameters

  • id: string

  Returns SVGGraphicsElement | null

getElements

• getElements(
      __namedParameters: {
          attrs?: { [key: string]: string };
          tagName?: string;
      },
  ): NodeListOf<Element>

  Parameters

  • __namedParameters: { attrs?: { [key: string]: string }; tagName?: string }

  Returns NodeListOf<Element>

getRenderingContext

• getRenderingContext(): SVGSVGElement

  Get the rendering context (Canvas2D, SVGElement, etc.)

  Returns SVGSVGElement

getViewBox

• getViewBox(): { height: number; width: number; x: number; y: number }

  Get current viewBox

  Returns { height: number; width: number; x: number; y: number }

  Current viewBox {x, y, width, height}

getZoom

• getZoom(): number

  Returns number

init

• init(element: HTMLElement): void

  Initialize the renderer in the given parent element

  Parameters

  • element: HTMLElement

  Returns void

pan

• pan(dx: number, dy: number, redrawGuides?: boolean): void

  Pan (translate) the viewBox

  Parameters

  • dx: number

    Horizontal translation (in viewBox coordinates)

  • dy: number

    Vertical translation (in viewBox coordinates)

  • redrawGuides: boolean = true

    Whether to redraw guides (default: true)

  Returns void

prependElement

• prependElement(el: Element): void

  Parameters

  • el: Element

  Returns void

redrawGuides

• redrawGuides(): void

  Returns void

removeElement

• removeElement(id: string): void

  Parameters

  • id: string

  Returns void

removeSymbol

• removeSymbol(id: string): void

  Parameters

  • id: string

  Returns void

replaceSymbol

• replaceSymbol(
      id: string,
      symbols: TIISymbol[],
  ): SVGGraphicsElement[] | undefined

  Parameters

  • id: string
  • symbols: TIISymbol[]

  Returns SVGGraphicsElement[] | undefined

resize

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

  Parameters

  • height: number
  • width: number

  Returns void

setAttribute

• setAttribute(id: string, name: string, value: string): void

  Parameters

  • id: string
  • name: string
  • value: string

  Returns void

setViewBox

• setViewBox(
      x: number,
      y: number,
      width: number,
      height: number,
      redrawGuides?: boolean,
  ): void

  Set viewBox

  Parameters

  • x: number

    X coordinate of top-left corner

  • y: number

    Y coordinate of top-left corner

  • width: number

    Width of viewBox

  • height: number

    Height of viewBox

  • redrawGuides: boolean = true

    Whether to redraw guides (default: true)

  Returns void

setZoom

• setZoom(zoom: number, centerX?: number, centerY?: number): void

  Parameters

  • zoom: number
  • OptionalcenterX: number
  • OptionalcenterY: number

  Returns void

definitionGroup

groupGuidesId

horizontalGuides

layer

verticalGuides