SVGElement

package js.html.svg

extends GraphicsElement › Element › DOMElement › Node › EventTarget

Available on js

The SVGSVGElement interface provides access to the properties of svg elements, as well as methods to manipulate them. This interface contains also various miscellaneous commonly-used utility methods, such as matrix operations and the ability to control the time of redraw on visual rendering devices.

Documentation SVGSVGElement by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

• https://developer.mozilla.org/en-US/docs/Web/API/SVGSVGElement

Static variables

staticinlineread onlySVG_ZOOMANDPAN_DISABLE:Int = 1

staticinlineread onlySVG_ZOOMANDPAN_MAGNIFY:Int = 2

staticinlineread onlySVG_ZOOMANDPAN_UNKNOWN:Int = 0

Variables

currentScale:Float

On an outermost svg element, this float attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations. DOM attributes currentScale and currentTranslate are equivalent to the 2x3 matrix [a b c d e f] = [currentScale 0 0 currentScale currentTranslate.x currentTranslate.y]. If "magnification" is enabled (i.e., zoomAndPan="magnify"), then the effect is as if an extra transformation were placed at the outermost level on the SVG document fragment (i.e., outside the outermost svg element).

read onlycurrentTranslate:Point

An SVGPoint representing the translation factor that takes into account user "magnification" corresponding to an outermost svg element. The behavior is undefined for svg elements that are not at the outermost level.

read onlyheight:AnimatedLength

An SVGAnimatedLength corresponding to the height attribute of the given svg element.

read onlypreserveAspectRatio:AnimatedPreserveAspectRatio

read onlyuseCurrentView:Bool

The initial view (i.e., before magnification and panning) of the current innermost SVG document fragment can be either the "standard" view, i.e., based on attributes on the svg element such as viewBox) or on a "custom" view (i.e., a hyperlink into a particular view or other element). If the initial view is the "standard" view, then this attribute is false. If the initial view is a "custom" view, then this attribute is true.

read onlyviewBox:AnimatedRect

read onlywidth:AnimatedLength

An SVGAnimatedLength corresponding to the width attribute of the given svg element.

read onlyx:AnimatedLength

An SVGAnimatedLength corresponding to the x attribute of the given svg element.

read onlyy:AnimatedLength

An SVGAnimatedLength corresponding to the y attribute of the given svg element.

zoomAndPan:Int

Methods

animationsPaused():Bool

Returns true if this SVG document fragment is in a paused state.

createSVGAngle():Angle

Creates an SVGAngle object outside of any document trees. The object is initialized to a value of zero degrees (unitless).

createSVGLength():Length

Creates an SVGLength object outside of any document trees. The object is initialized to a value of zero user units.

createSVGMatrix():Matrix

Creates an SVGMatrix object outside of any document trees. The object is initialized to the identity matrix.

createSVGNumber():Number

Creates an SVGNumber object outside of any document trees. The object is initialized to a value of zero.

createSVGPoint():Point

Creates an SVGPoint object outside of any document trees. The object is initialized to the point (0,0) in the user coordinate system.

createSVGRect():Rect

Creates an SVGRect object outside of any document trees. The object is initialized such that all values are set to 0 user units.

createSVGTransform():Transform

Creates an SVGTransform object outside of any document trees. The object is initialized to an identity matrix transform (SVG_TRANSFORM_MATRIX).

createSVGTransformFromMatrix(matrix:Matrix):Transform

Creates an SVGTransform object outside of any document trees. The object is initialized to the given matrix transform (i.e., SVG_TRANSFORM_MATRIX). The values from the parameter matrix are copied, the matrix parameter is not adopted as SVGTransform::matrix.

deselectAll():Void

Unselects any selected objects, including any selections of text strings and type-in bars.

forceRedraw():Void

In rendering environments supporting interactivity, forces the user agent to immediately redraw all regions of the viewport that require updating.

getCurrentTime():Float

Returns the current time in seconds relative to the start time for the current SVG document fragment. If getCurrentTime is called before the document timeline has begun (for example, by script running in a script element before the document's SVGLoad event is dispatched), then 0 is returned.

getElementById(elementId:String):Element

Searches this SVG document fragment (i.e., the search is restricted to a subset of the document tree) for an Element whose id is given by elementId. If an Element is found, that Element is returned. If no such element exists, returns null. Behavior is not defined if more than one element has this id.

pauseAnimations():Void

Suspends (i.e., pauses) all currently running animations that are defined within the SVG document fragment corresponding to this svg element, causing the animation clock corresponding to this document fragment to stand still until it is unpaused.

setCurrentTime(seconds:Float):Void

Adjusts the clock for this SVG document fragment, establishing a new current time. If setCurrentTime is called before the document timeline has begun (for example, by script running in a script element before the document's SVGLoad event is dispatched), then the value of seconds in the last invocation of the method gives the time that the document will seek to once the document timeline has begun.

suspendRedraw(maxWaitMilliseconds:Int):Int

Takes a time-out value which indicates that redraw shall not occur until: the corresponding unsuspendRedraw() call has been made, an unsuspendRedrawAll() call has been made, or its timer has timed out.

In environments that do not support interactivity (e.g., print media), then redraw shall not be suspended. Calls to suspendRedraw() and unsuspendRedraw() should, but need not be, made in balanced pairs.

To suspend redraw actions as a collection of SVG DOM changes occur, precede the changes to the SVG DOM with a method call similar to:

suspendHandleID = suspendRedraw(maxWaitMilliseconds);

and follow the changes with a method call similar to:

unsuspendRedraw(suspendHandleID);

Note that multiple suspendRedraw calls can be used at once and that each such method call is treated independently of the other suspendRedraw method calls.

unpauseAnimations():Void

Unsuspends (i.e., unpauses) currently running animations that are defined within the SVG document fragment, causing the animation clock to continue from the time at which it was suspended.

unsuspendRedraw(suspendHandleID:Int):Void

Cancels a specified suspendRedraw() by providing a unique suspend handle ID that was returned by a previous suspendRedraw() call.

unsuspendRedrawAll():Void

Cancels all currently active suspendRedraw() method calls. This method is most useful at the very end of a set of SVG DOM calls to ensure that all pending suspendRedraw() method calls have been cancelled.