SVGSVGElement

Overview

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.

Location


 

animationsPaused

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

 

method animationsPaused: Boolean

 

Boolean animationsPaused()

 

func animationsPaused() -> Boolean

 

Boolean animationsPaused()

 

Function animationsPaused() As Boolean

checkEnclosure

Returns true if the rendered content of the given element is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

 

method checkEnclosure: Boolean

 

Boolean checkEnclosure()

 

func checkEnclosure() -> Boolean

 

Boolean checkEnclosure()

 

Function checkEnclosure() As Boolean

checkIntersection

Returns true if the rendered content of the given element intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

 

method checkIntersection: Boolean

 

Boolean checkIntersection()

 

func checkIntersection() -> Boolean

 

Boolean checkIntersection()

 

Function checkIntersection() As Boolean

contentScriptType

 

property contentScriptType: dynamic read write;

 

dynamic contentScriptType { get; set; }

 

var contentScriptType: dynamic { get{} set{} }

 

dynamic contentScriptType { __get; __set; }

 

Property contentScriptType() As dynamic

contentStyleType

 

property contentStyleType: dynamic read write;

 

dynamic contentStyleType { get; set; }

 

var contentStyleType: dynamic { get{} set{} }

 

dynamic contentStyleType { __get; __set; }

 

Property contentStyleType() As dynamic

createSVGAngle

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

 

method createSVGAngle: dynamic

 

dynamic createSVGAngle()

 

func createSVGAngle() -> dynamic

 

dynamic createSVGAngle()

 

Function createSVGAngle() As dynamic

createSVGLength

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

 

method createSVGLength: dynamic

 

dynamic createSVGLength()

 

func createSVGLength() -> dynamic

 

dynamic createSVGLength()

 

Function createSVGLength() As dynamic

createSVGMatrix

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

 

method createSVGMatrix: dynamic

 

dynamic createSVGMatrix()

 

func createSVGMatrix() -> dynamic

 

dynamic createSVGMatrix()

 

Function createSVGMatrix() As dynamic

createSVGNumber

Creates an SVGNumber object outside of any document trees. The object is initialized to 0.

 

method createSVGNumber: dynamic

 

dynamic createSVGNumber()

 

func createSVGNumber() -> dynamic

 

dynamic createSVGNumber()

 

Function createSVGNumber() As dynamic

createSVGPoint

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

 

method createSVGPoint: dynamic

 

dynamic createSVGPoint()

 

func createSVGPoint() -> dynamic

 

dynamic createSVGPoint()

 

Function createSVGPoint() As dynamic

createSVGRect

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

 

method createSVGRect: dynamic

 

dynamic createSVGRect()

 

func createSVGRect() -> dynamic

 

dynamic createSVGRect()

 

Function createSVGRect() As dynamic

createSVGTransform

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

 

method createSVGTransform: dynamic

 

dynamic createSVGTransform()

 

func createSVGTransform() -> dynamic

 

dynamic createSVGTransform()

 

Function createSVGTransform() As dynamic

createSVGTransformFromMatrix

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.

 

method createSVGTransformFromMatrix: dynamic

 

dynamic createSVGTransformFromMatrix()

 

func createSVGTransformFromMatrix() -> dynamic

 

dynamic createSVGTransformFromMatrix()

 

Function createSVGTransformFromMatrix() As dynamic

currentScale

 

property currentScale: String read write;

 

String currentScale { get; set; }

 

var currentScale: String { get{} set{} }

 

String currentScale { __get; __set; }

 

Property currentScale() As String

currentTranslate

 

property currentTranslate: SVGPoint read;

 

SVGPoint currentTranslate { get; }

 

var currentTranslate: SVGPoint { get{} }

 

SVGPoint currentTranslate { __get; }

 

ReadOnly Property currentTranslate() As SVGPoint

currentView

 

property currentView: String read write;

 

String currentView { get; set; }

 

var currentView: String { get{} set{} }

 

String currentView { __get; __set; }

 

Property currentView() As String

deselectAll

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

 

method deselectAll: dynamic

 

dynamic deselectAll()

 

func deselectAll() -> dynamic

 

dynamic deselectAll()

 

Function deselectAll() As dynamic

getCurrentTime

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.

 

method getCurrentTime: String

 

String getCurrentTime()

 

func getCurrentTime() -> String

 

String getCurrentTime()

 

Function getCurrentTime() As String

getElementById

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.

 

method getElementById: Element

 

Element getElementById()

 

func getElementById() -> Element

 

Element getElementById()

 

Function getElementById() As Element

getEnclosureList

Returns a NodeList of graphics elements whose rendered content is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

 

method getEnclosureList: Node

 

Node getEnclosureList()

 

func getEnclosureList() -> Node

 

Node getEnclosureList()

 

Function getEnclosureList() As Node

getIntersectionList

Returns a NodeList of graphics elements whose rendered content intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

 

method getIntersectionList: Node

 

Node getIntersectionList()

 

func getIntersectionList() -> Node

 

Node getIntersectionList()

 

Function getIntersectionList() As Node

height

 

property height: Int32 read;

 

Int32 height { get; }

 

var height: Int32 { get{} }

 

Int32 height { __get; }

 

ReadOnly Property height() As Int32

pauseAnimations

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.

 

method pauseAnimations: String

 

String pauseAnimations()

 

func pauseAnimations() -> String

 

String pauseAnimations()

 

Function pauseAnimations() As String

setCurrentTime

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.

 

method setCurrentTime: String

 

String setCurrentTime()

 

func setCurrentTime() -> String

 

String setCurrentTime()

 

Function setCurrentTime() As String

unpauseAnimations

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.

 

method unpauseAnimations: dynamic

 

dynamic unpauseAnimations()

 

func unpauseAnimations() -> dynamic

 

dynamic unpauseAnimations()

 

Function unpauseAnimations() As dynamic

useCurrentView

 

property useCurrentView: String read write;

 

String useCurrentView { get; set; }

 

var useCurrentView: String { get{} set{} }

 

String useCurrentView { __get; __set; }

 

Property useCurrentView() As String

width

 

property width: Int32 read;

 

Int32 width { get; }

 

var width: Int32 { get{} }

 

Int32 width { __get; }

 

ReadOnly Property width() As Int32

x

 

property x: Double read;

 

Double x { get; }

 

var x: Double { get{} }

 

Double x { __get; }

 

ReadOnly Property x() As Double

y

 

property y: Double read;

 

Double y { get; }

 

var y: Double { get{} }

 

Double y { __get; }

 

ReadOnly Property y() As Double

 

contentScriptType

 

property contentScriptType: dynamic read write;

 

dynamic contentScriptType { get; set; }

 

var contentScriptType: dynamic { get{} set{} }

 

dynamic contentScriptType { __get; __set; }

 

Property contentScriptType() As dynamic

contentStyleType

 

property contentStyleType: dynamic read write;

 

dynamic contentStyleType { get; set; }

 

var contentStyleType: dynamic { get{} set{} }

 

dynamic contentStyleType { __get; __set; }

 

Property contentStyleType() As dynamic

currentScale

 

property currentScale: String read write;

 

String currentScale { get; set; }

 

var currentScale: String { get{} set{} }

 

String currentScale { __get; __set; }

 

Property currentScale() As String

currentTranslate

 

property currentTranslate: SVGPoint read;

 

SVGPoint currentTranslate { get; }

 

var currentTranslate: SVGPoint { get{} }

 

SVGPoint currentTranslate { __get; }

 

ReadOnly Property currentTranslate() As SVGPoint

currentView

 

property currentView: String read write;

 

String currentView { get; set; }

 

var currentView: String { get{} set{} }

 

String currentView { __get; __set; }

 

Property currentView() As String

height

 

property height: Int32 read;

 

Int32 height { get; }

 

var height: Int32 { get{} }

 

Int32 height { __get; }

 

ReadOnly Property height() As Int32

useCurrentView

 

property useCurrentView: String read write;

 

String useCurrentView { get; set; }

 

var useCurrentView: String { get{} set{} }

 

String useCurrentView { __get; __set; }

 

Property useCurrentView() As String

width

 

property width: Int32 read;

 

Int32 width { get; }

 

var width: Int32 { get{} }

 

Int32 width { __get; }

 

ReadOnly Property width() As Int32

x

 

property x: Double read;

 

Double x { get; }

 

var x: Double { get{} }

 

Double x { __get; }

 

ReadOnly Property x() As Double

y

 

property y: Double read;

 

Double y { get; }

 

var y: Double { get{} }

 

Double y { __get; }

 

ReadOnly Property y() As Double

 

animationsPaused

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

 

method animationsPaused: Boolean

 

Boolean animationsPaused()

 

func animationsPaused() -> Boolean

 

Boolean animationsPaused()

 

Function animationsPaused() As Boolean

checkEnclosure

Returns true if the rendered content of the given element is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

 

method checkEnclosure: Boolean

 

Boolean checkEnclosure()

 

func checkEnclosure() -> Boolean

 

Boolean checkEnclosure()

 

Function checkEnclosure() As Boolean

checkIntersection

Returns true if the rendered content of the given element intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

 

method checkIntersection: Boolean

 

Boolean checkIntersection()

 

func checkIntersection() -> Boolean

 

Boolean checkIntersection()

 

Function checkIntersection() As Boolean

createSVGAngle

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

 

method createSVGAngle: dynamic

 

dynamic createSVGAngle()

 

func createSVGAngle() -> dynamic

 

dynamic createSVGAngle()

 

Function createSVGAngle() As dynamic

createSVGLength

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

 

method createSVGLength: dynamic

 

dynamic createSVGLength()

 

func createSVGLength() -> dynamic

 

dynamic createSVGLength()

 

Function createSVGLength() As dynamic

createSVGMatrix

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

 

method createSVGMatrix: dynamic

 

dynamic createSVGMatrix()

 

func createSVGMatrix() -> dynamic

 

dynamic createSVGMatrix()

 

Function createSVGMatrix() As dynamic

createSVGNumber

Creates an SVGNumber object outside of any document trees. The object is initialized to 0.

 

method createSVGNumber: dynamic

 

dynamic createSVGNumber()

 

func createSVGNumber() -> dynamic

 

dynamic createSVGNumber()

 

Function createSVGNumber() As dynamic

createSVGPoint

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

 

method createSVGPoint: dynamic

 

dynamic createSVGPoint()

 

func createSVGPoint() -> dynamic

 

dynamic createSVGPoint()

 

Function createSVGPoint() As dynamic

createSVGRect

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

 

method createSVGRect: dynamic

 

dynamic createSVGRect()

 

func createSVGRect() -> dynamic

 

dynamic createSVGRect()

 

Function createSVGRect() As dynamic

createSVGTransform

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

 

method createSVGTransform: dynamic

 

dynamic createSVGTransform()

 

func createSVGTransform() -> dynamic

 

dynamic createSVGTransform()

 

Function createSVGTransform() As dynamic

createSVGTransformFromMatrix

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.

 

method createSVGTransformFromMatrix: dynamic

 

dynamic createSVGTransformFromMatrix()

 

func createSVGTransformFromMatrix() -> dynamic

 

dynamic createSVGTransformFromMatrix()

 

Function createSVGTransformFromMatrix() As dynamic

deselectAll

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

 

method deselectAll: dynamic

 

dynamic deselectAll()

 

func deselectAll() -> dynamic

 

dynamic deselectAll()

 

Function deselectAll() As dynamic

getCurrentTime

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.

 

method getCurrentTime: String

 

String getCurrentTime()

 

func getCurrentTime() -> String

 

String getCurrentTime()

 

Function getCurrentTime() As String

getElementById

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.

 

method getElementById: Element

 

Element getElementById()

 

func getElementById() -> Element

 

Element getElementById()

 

Function getElementById() As Element

getEnclosureList

Returns a NodeList of graphics elements whose rendered content is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

 

method getEnclosureList: Node

 

Node getEnclosureList()

 

func getEnclosureList() -> Node

 

Node getEnclosureList()

 

Function getEnclosureList() As Node

getIntersectionList

Returns a NodeList of graphics elements whose rendered content intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

 

method getIntersectionList: Node

 

Node getIntersectionList()

 

func getIntersectionList() -> Node

 

Node getIntersectionList()

 

Function getIntersectionList() As Node

pauseAnimations

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.

 

method pauseAnimations: String

 

String pauseAnimations()

 

func pauseAnimations() -> String

 

String pauseAnimations()

 

Function pauseAnimations() As String

setCurrentTime

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.

 

method setCurrentTime: String

 

String setCurrentTime()

 

func setCurrentTime() -> String

 

String setCurrentTime()

 

Function setCurrentTime() As String

unpauseAnimations

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.

 

method unpauseAnimations: dynamic

 

dynamic unpauseAnimations()

 

func unpauseAnimations() -> dynamic

 

dynamic unpauseAnimations()

 

Function unpauseAnimations() As dynamic