C

SvgVisual

Show Usages
Wraps an SVGElement as a Visual.
Inheritance Hierarchy

Members

No filters for this type

Constructors

SvgVisual

(element: SVGElement)
Creates a new instance which wraps the specified SVG element.

Parameters

element: SVGElement
The SVG element which this visual wraps.

See Also

API
from, from

Properties

svgElement

: SVGElement
Gets or sets the SVG element of this visual.
final

See Also

Developer's Guide

Static Methods

from

<TElement> (element: TElement): TypedSvgVisual<TElement>
static
Creates a new TypedSvgVisual<TElement> for the given element.

The purpose of this factory method is to get an instance of SvgVisual but with a better matching type for the svgElement property.

Note that this method still returns an instance of the SvgVisual class, since TypedSvgVisual<TElement> is just a typeScript type. The main benefit is the added type-safety.

static

Parameters

element: TElement
The element to wrap.

Return Value

TypedSvgVisual<TElement>
A properly typed SvgVisual for the given element.

See Also

Developer's Guide
API
from

from

<TElement, TTag> (element: TElement, tag: TTag): TaggedSvgVisual<TElement, TTag>
static
Creates a new TaggedSvgVisual<TElement, TTag> for the given element and tag object.

The purpose of this factory method is to get an instance of SvgVisual but with a better matching type of the svgElement property and the ability to store an user-provided object as tag with type-safety.

Note that this method still returns an instance of the SvgVisual class, since TaggedSvgVisual<TElement, TTag> is just a typeScript type. The main benefit is the added type-safety.

static

Parameters

element: TElement
The element to wrap.
tag: TTag
The object to set to the SvgVisual as tag.

Return Value

TaggedSvgVisual<TElement, TTag>
A properly typed SvgVisual for the given element and tag value.

See Also

Developer's Guide
API
from

setScale

(
transformable: Element
scaleX: number
scaleY: number
)
static
Sets the transform to a scale transform using the given parameters.
This implementation uses caching and the baseVal property of the transform attribute if possible and thus performs better than using the plain DOM API.
static

Parameters

transformable: Element
The SVG element that should be translated.
scaleX: number
The vertical scale.
scaleY: number
The horizontal scale.

setTranslate

(
transformable: Element
dx: number
dy: number
)
static
Sets the transform to a translate transform using the given parameters.
This implementation uses caching and the baseVal property of the transform attribute if possible and thus performs better than using the plain DOM API.
static

Parameters

transformable: Element
The SVG element that should be translated.
dx: number
The offset on the x-axis.
dy: number
The offset on the y-axis.