C

SvgVisualGroup

Show Usages
A container that can hold a number of SvgVisuals.
Inheritance Hierarchy

Remarks

Use this class in a IVisualCreator implementation to group several SvgVisuals.

The class cannot be used to group HtmlCanvasVisuals.

Note that each child visual may only appear once in the list of children. Adding a visual a second time results in undefined behavior. When changing the order of the child visuals, make sure to remove a visual first before adding it at another index.

See Also

Developer's Guide

Members

Show:

Constructors

SvgVisualGroup

()
Initializes a new instance of the SvgVisualGroup class.

Properties

children

: IList<SvgVisual>
readonly
Gets the list of children with read and write access.
Note that each child visual may only appear once in this list. Adding a visual a second time results in undefined behavior. When changing the order of the child visuals, make sure to remove a visual first before adding it at another index.
readonlyfinal

Property Value

The children.

svgElement

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

See Also

Developer's Guide

transform

: Matrix
Gets or sets a transform that is applied to the children of the container.

Property Value

The transform.

See Also

Developer's Guide

Methods

add

(child: SvgVisual)
Adds another SvgVisual to the children collection of this instance.
final

Parameters

child: SvgVisual
The child to add.

See Also

Developer's Guide

remove

(child: SvgVisual)
Removes a previously added SvgVisual from the children collection of this instance.
final

Parameters

child: SvgVisual
The child to remove.

See Also

Developer's Guide

Static Methods

from

<TTag> (tag: TTag): SvgVisualGroup & TaggedSvgVisual<SVGGElement, TTag>
static
Creates a new SvgVisualGroup with the given tag object and a properly typed SvgVisual.svgElement property.

The purpose of this factory method is to get an instance of SvgVisualGroup with an attached user-provided object as TaggedSvgVisual<gType, TTag>.tag with type-safety and a better-matching type of the SvgVisual.svgElement property.

Note that this method still returns an instance of the SvgVisualGroup class, since the returned type is just a TypeScript type. The main benefit is the added type-safety.

static

Parameters

tag: TTag
The object to set to the SvgVisual as TaggedSvgVisual<gType, TTag>.tag.

Return Value

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

See Also

API
from