Class SvgHelper

Utility class to simplify SVG operations.

Constructors

constructor

new SvgHelper(): SvgHelper
Returns SvgHelper

Methods

`Static`clientToLocalCoordinates

clientToLocalCoordinates(
    localRoot: undefined | SVGElement,
    x: number,
    y: number,
    zoomLevel?: number,
): 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
- Defined in markerjs3/src/core/SvgHelper.ts:332

`Static`createCircle

createCircle(radius: number, attributes?: [string, string][]): SVGCircleElement
Creates an SVG circle with the specified radius.
Parameters
- radius: number
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGCircleElement
- Defined in markerjs3/src/core/SvgHelper.ts:107

`Static`createDefs

createDefs(): SVGDefsElement
Creates SVG "defs".

Returns SVGDefsElement
- Defined in markerjs3/src/core/SvgHelper.ts:10

`Static`createEllipse

createEllipse(
    rx: number,
    ry: number,
    attributes?: [string, string][],
): SVGEllipseElement
Creates an SVG ellipse with the specified horizontal and vertical radii.
Parameters
- rx: number
- ry: number
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGEllipseElement
- Defined in markerjs3/src/core/SvgHelper.ts:132

`Static`createFilter

createFilter(
    id: string,
    attributes?: [string, string][],
    innerHTML?: string,
): SVGFilterElement
Creates an SVG filter element.
Parameters
- id: string
  filter id
- Optionalattributes: [string, string][]
  other filter element attributes
- OptionalinnerHTML: string
  filter definition as string
Returns SVGFilterElement
filter element
- Defined in markerjs3/src/core/SvgHelper.ts:368

`Static`createForeignObject

createForeignObject(attributes?: [string, string][]): SVGForeignObjectElement
Creates an SVG text element.
Parameters
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGForeignObjectElement
- Defined in markerjs3/src/core/SvgHelper.ts:307

`Static`createGroup

createGroup(attributes?: [string, string][]): SVGGElement
Creates an SVG group.
Parameters
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGGElement
- Defined in markerjs3/src/core/SvgHelper.ts:157

`Static`createImage

createImage(attributes?: [string, string][]): SVGImageElement
Creates an SVG image element.
Parameters
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGImageElement
- Defined in markerjs3/src/core/SvgHelper.ts:255

`Static`createLine

createLine(
    x1: string | number,
    y1: string | number,
    x2: string | number,
    y2: string | number,
    attributes?: [string, string][],
): SVGLineElement
Creates an SVG line with specified end-point coordinates.
Parameters
- x1: string | number
- y1: string | number
- x2: string | number
- y2: string | number
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGLineElement
- Defined in markerjs3/src/core/SvgHelper.ts:60

`Static`createMarker

createMarker(
    id: string,
    orient: string,
    markerWidth: string | number,
    markerHeight: string | number,
    refX: string | number,
    refY: string | number,
    markerElement: SVGGraphicsElement,
): 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
- Defined in markerjs3/src/core/SvgHelper.ts:184

`Static`createPath

createPath(d: string, attributes?: [string, string][]): SVGPathElement
Creates an SVG path with the specified shape (d).
Parameters
- d: string
  path shape
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGPathElement
- Defined in markerjs3/src/core/SvgHelper.ts:289

`Static`createPoint

createPoint(x: number, y: number): DOMPoint
Creates an SVG point with the specified coordinates.
Parameters
- x: number
- y: number
Returns DOMPoint
- Defined in markerjs3/src/core/SvgHelper.ts:275

`Static`createPolygon

createPolygon(
points: string,
attributes?: [string, string][],
): SVGPolygonElement
Creates an SVG polygon with specified points.
Parameters
- points: string
  points as string.
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGPolygonElement
- Defined in markerjs3/src/core/SvgHelper.ts:85

`Static`createRect

createRect(
    width: string | number,
    height: string | number,
    attributes?: [string, string][],
): SVGRectElement
Creates an SVG rectangle with the specified width and height.
Parameters
- width: string | number
- height: string | number
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGRectElement
- Defined in markerjs3/src/core/SvgHelper.ts:36

`Static`createSvgFromString

createSvgFromString(stringSvg: string): 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
- Defined in markerjs3/src/core/SvgHelper.ts:354

`Static`createText

createText(attributes?: [string, string][]): SVGTextElement
Creates an SVG text element.
Parameters
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGTextElement
- Defined in markerjs3/src/core/SvgHelper.ts:215

`Static`createTransform

createTransform(): SVGTransform
Creates an SVG transform.

Returns SVGTransform
- Defined in markerjs3/src/core/SvgHelper.ts:168

`Static`createTSpan

createTSpan(text: string, attributes?: [string, string][]): SVGTSpanElement
Creates an SVG TSpan.
Parameters
- text: string
  inner text.
- Optionalattributes: [string, string][]
  additional attributes.
Returns SVGTSpanElement
- Defined in markerjs3/src/core/SvgHelper.ts:234

`Static`setAttributes

setAttributes(el: SVGElement, attributes: [string, string][]): 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
- Defined in markerjs3/src/core/SvgHelper.ts:21

Class SvgHelper

Index

Constructors

Methods

Constructors

constructor

Returns SvgHelper

Methods

StaticclientToLocalCoordinates

Parameters

Returns IPoint

StaticcreateCircle

Parameters

Returns SVGCircleElement

StaticcreateDefs

Returns SVGDefsElement

StaticcreateEllipse

Parameters

Returns SVGEllipseElement

StaticcreateFilter

Parameters

Returns SVGFilterElement

StaticcreateForeignObject

Parameters

Returns SVGForeignObjectElement

StaticcreateGroup

Parameters

Returns SVGGElement

StaticcreateImage

Parameters

Returns SVGImageElement

StaticcreateLine

Parameters

Returns SVGLineElement

StaticcreateMarker

Parameters

Returns SVGMarkerElement

StaticcreatePath

Parameters

Returns SVGPathElement

StaticcreatePoint

Parameters

Returns DOMPoint

StaticcreatePolygon

Parameters

Returns SVGPolygonElement

StaticcreateRect

Parameters

Returns SVGRectElement

StaticcreateSvgFromString

Parameters

Returns SVGSVGElement

StaticcreateText

Parameters

Returns SVGTextElement

StaticcreateTransform

Returns SVGTransform

StaticcreateTSpan

Parameters

Returns SVGTSpanElement

StaticsetAttributes

Parameters

Returns void

Settings

On This Page

`Static`clientToLocalCoordinates

`Static`createCircle

`Static`createDefs

`Static`createEllipse

`Static`createFilter

`Static`createForeignObject

`Static`createGroup

`Static`createImage

`Static`createLine

`Static`createMarker

`Static`createPath

`Static`createPoint

`Static`createPolygon

`Static`createRect

`Static`createSvgFromString

`Static`createText

`Static`createTransform

`Static`createTSpan

`Static`setAttributes