Class SvgHelper

Utility class to simplify SVG operations.

Hierarchy

SvgHelper

Index

Constructors

Methods

clientToLocalCoordinates createCircle createDefs createEllipse createForeignObject createGroup createImage createLine createMarker createPath createPoint createPolygon createRect createSvgFromString createTSpan createText createTransform setAttributes

Constructors

constructor

new SvgHelper(): SvgHelper
Returns SvgHelper

Methods

`Static` clientToLocalCoordinates

clientToLocalCoordinates(localRoot, x, y, zoomLevel?): IPoint
Returns local coordinates relative to the provided localRoot of a client (screen) point.
Parameters
- localRoot: undefined | SVGElement
  
  relative coordinate root
- x: number
  
  horizontal client coordinate
- y: number
  
  vertical client coordinate
- zoomLevel: number = 1
  
  zoom level
Returns IPoint
local coordinates relative to localRoot

`Static` createCircle

createCircle(radius, attributes?): SVGCircleElement
Creates an SVG circle with the specified radius.
Parameters
- radius: number
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGCircleElement

`Static` createDefs

createDefs(): SVGDefsElement
Creates SVG "defs".

Returns SVGDefsElement

`Static` createEllipse

createEllipse(rx, ry, attributes?): SVGEllipseElement
Creates an SVG ellipse with the specified horizontal and vertical radii.
Parameters
- rx: number
- ry: number
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGEllipseElement

`Static` createForeignObject

createForeignObject(attributes?): SVGForeignObjectElement
Creaes an SVG text element.
Parameters
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGForeignObjectElement

`Static` createGroup

createGroup(attributes?): SVGGElement
Creates an SVG group.
Parameters
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGGElement

`Static` createImage

createImage(attributes?): SVGImageElement
Creates an SVG image element.
Parameters
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGImageElement

`Static` createLine

createLine(x1, y1, x2, y2, attributes?): SVGLineElement
Creates an SVG line with specified end-point coordinates.
Parameters
- x1: string | number
- y1: string | number
- x2: string | number
- y2: string | number
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGLineElement

`Static` createMarker

createMarker(id, orient, markerWidth, markerHeight, refX, refY, markerElement): SVGMarkerElement
Creates an SVG marker.
Parameters
- id: string
- orient: string
- markerWidth: string | number
- markerHeight: string | number
- refX: string | number
- refY: string | number
- markerElement: SVGGraphicsElement
Returns SVGMarkerElement

`Static` createPath

createPath(d, attributes?): SVGPathElement
Creates an SVG path with the specified shape (d).
Parameters
- d: string
  
  path shape
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGPathElement

`Static` createPoint

createPoint(x, y): DOMPoint
Creates an SVG point with the specified coordinates.
Parameters
- x: number
- y: number
Returns DOMPoint

`Static` createPolygon

createPolygon(points, attributes?): SVGPolygonElement
Creates an SVG polygon with specified points.
Parameters
- points: string
  
  points as string.
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGPolygonElement

`Static` createRect

createRect(width, height, attributes?): SVGRectElement
Creates an SVG rectangle with the specified width and height.
Parameters
- width: string | number
- height: string | number
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGRectElement

`Static` createSvgFromString

createSvgFromString(stringSvg): SVGSVGElement
Creates an SVG image element from a supplied inner SVG markup string.
Parameters
- stringSvg: string
  
  SVG markup (without the root svg tags)
Returns SVGSVGElement
SVG image element

`Static` createTSpan

createTSpan(text, attributes?): SVGTSpanElement
Creates an SVG TSpan.
Parameters
- text: string
  
  inner text.
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGTSpanElement

`Static` createText

createText(attributes?): SVGTextElement
Creaes an SVG text element.
Parameters
- Optional attributes: [string, string][]
  
  additional attributes.
Returns SVGTextElement

`Static` createTransform

createTransform(): SVGTransform
Creates an SVG transform.

Returns SVGTransform

`Static` setAttributes

setAttributes(el, attributes): void
Sets attributes on an arbitrary SVG element
Parameters
- el: SVGElement
  
  target SVG element.
- attributes: [string, string][]
  
  set of name-value attribute pairs.
Returns void

Generated using TypeDoc