SVGSVGElement (GWT Elemental 2.7.0)

All Superinterfaces:

Element, ElementTraversal, EventTarget, Node, NodeSelector, SVGElement, SVGExternalResourcesRequired, SVGFitToViewBox, SVGLangSpace, SVGLocatable, SVGStylable, SVGTests, SVGZoomAndPan

All Known Implementing Classes:

JsSVGSVGElement
```
public interface SVGSVGElement
extends SVGElement, SVGTests, SVGLangSpace, SVGExternalResourcesRequired, SVGStylable, SVGLocatable, SVGFitToViewBox, SVGZoomAndPan
```
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.

Field Summary
- Fields inherited from interface elemental.dom.Element
  ALLOW_KEYBOARD_INPUT
- Fields inherited from interface elemental.dom.Node
  ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
- Fields inherited from interface elemental.svg.SVGZoomAndPan
  SVG_ZOOMANDPAN_DISABLE, SVG_ZOOMANDPAN_MAGNIFY, SVG_ZOOMANDPAN_UNKNOWN

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`animationsPaused()` Returns true if this SVG document fragment is in a paused state.
`boolean`	`checkEnclosure(SVGElement element, SVGRect rect)` Returns true if the rendered content of the given element is entirely contained within the supplied rectangle.
`boolean`	`checkIntersection(SVGElement element, SVGRect rect)` Returns true if the rendered content of the given element intersects the supplied rectangle.
`SVGAngle`	`createSVGAngle()` Creates an `SVGAngle` object outside of any document trees.
`SVGLength`	`createSVGLength()` Creates an `SVGLength` object outside of any document trees.
`SVGMatrix`	`createSVGMatrix()` Creates an `SVGMatrix` object outside of any document trees.
`SVGNumber`	`createSVGNumber()` Creates an `SVGNumber` object outside of any document trees.
`SVGPoint`	`createSVGPoint()` Creates an `SVGPoint` object outside of any document trees.
`SVGRect`	`createSVGRect()` Creates an `SVGRect` object outside of any document trees.
`SVGTransform`	`createSVGTransform()` Creates an `SVGTransform` object outside of any document trees.
`SVGTransform`	`createSVGTransformFromMatrix(SVGMatrix matrix)` Creates an `SVGTransform` object outside of any document trees.
`void`	`deselectAll()` Unselects any selected objects, including any selections of text strings and type-in bars.
`void`	`forceRedraw()` In rendering environments supporting interactivity, forces the user agent to immediately redraw all regions of the viewport that require updating.
`SVGAnimatedLength`	`getAnimatedHeight()` Corresponds to attribute `height` on the given `<svg>` element.
`SVGAnimatedLength`	`getAnimatedWidth()` Corresponds to attribute `width` on the given `<svg>` element.
`String`	`getContentScriptType()` Corresponds to attribute `contentScriptType` on the given `<svg>` element.
`String`	`getContentStyleType()` Corresponds to attribute `contentStyleType` on the given `<svg>` element.
`float`	`getCurrentScale()` On an outermost `<svg>` element, this attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations.
`float`	`getCurrentTime()` Returns the current time in seconds relative to the start time for the current SVG document fragment.
`SVGPoint`	`getCurrentTranslate()` On an outermost `<svg>` element, the corresponding translation factor that takes into account user "magnification".
`SVGViewSpec`	`getCurrentView()` The definition of the initial view (i.e., before magnification and panning) of the current innermost SVG document fragment.
`Element`	`getElementById(String elementId)` 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.
`NodeList`	`getEnclosureList(SVGRect rect, SVGElement referenceElement)` Returns the list of graphics elements whose rendered content is entirely contained within the supplied rectangle.
`NodeList`	`getIntersectionList(SVGRect rect, SVGElement referenceElement)` Returns the list of graphics elements whose rendered content intersects the supplied rectangle.
`float`	`getPixelUnitToMillimeterX()` Size of a pixel units (as defined by CSS2) along the x-axis of the viewport, which represents a unit somewhere in the range of 70dpi to 120dpi, and, on systems that support this, might actually match the characteristics of the target medium.
`float`	`getPixelUnitToMillimeterY()` Corresponding size of a pixel unit along the y-axis of the viewport.
`float`	`getScreenPixelToMillimeterX()` User interface (UI) events in DOM Level 2 indicate the screen positions at which the given UI event occurred.
`float`	`getScreenPixelToMillimeterY()` Corresponding size of a screen pixel along the y-axis of the viewport.
`SVGRect`	`getViewport()` The position and size of the viewport (implicit or explicit) that corresponds to this `<svg>` element.
`SVGAnimatedLength`	`getX()`
`SVGAnimatedLength`	`getY()`
`boolean`	`isUseCurrentView()` 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 to a "custom" view (i.e., a hyperlink into a particular `<view>` or other element).
`void`	`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.
`void`	`setContentScriptType(String arg)`
`void`	`setContentStyleType(String arg)`
`void`	`setCurrentScale(float arg)`
`void`	`setCurrentTime(float seconds)` Adjusts the clock for this SVG document fragment, establishing a new current time.
`int`	`suspendRedraw(int maxWaitMilliseconds)` Takes a time-out value which indicates that redraw shall not occur until:
`void`	`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.
`void`	`unsuspendRedraw(int suspendHandleId)` Cancels a specified `suspendRedraw()` by providing a unique suspend handle ID that was returned by a previous `suspendRedraw()` call.
`void`	`unsuspendRedrawAll()` Cancels all currently active `suspendRedraw()` method calls.

Methods inherited from interface elemental.svg.SVGElement
getId, getOwnerSVGElement, getViewportElement, getXmlbase, setId, setXmlbase

Methods inherited from interface elemental.dom.Element
blur, click, focus, getAccessKey, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getBoundingClientRect, getChildElementCount, getChildren, getClassList, getClassName, getClientHeight, getClientLeft, getClientRects, getClientTop, getClientWidth, getContentEditable, getDataset, getDir, getElementsByClassName, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getInnerHTML, getInnerText, getLang, getLastElementChild, getNextElementSibling, getOffsetHeight, getOffsetLeft, getOffsetParent, getOffsetTop, getOffsetWidth, getOnabort, getOnbeforecopy, getOnbeforecut, getOnbeforepaste, getOnblur, getOnchange, getOnclick, getOncontextmenu, getOncopy, getOncut, getOndblclick, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOnerror, getOnfocus, getOninput, getOninvalid, getOnkeydown, getOnkeypress, getOnkeyup, getOnload, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnmousewheel, getOnpaste, getOnreset, getOnscroll, getOnsearch, getOnselect, getOnselectstart, getOnsubmit, getOntouchcancel, getOntouchend, getOntouchmove, getOntouchstart, getOnwebkitfullscreenchange, getOnwebkitfullscreenerror, getOuterHTML, getOuterText, getPreviousElementSibling, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getStyle, getTabIndex, getTagName, getTitle, getWebkitdropzone, getWebkitRegionOverflow, hasAttribute, hasAttributeNS, insertAdjacentElement, insertAdjacentHTML, insertAdjacentText, isContentEditable, isDraggable, isHidden, isSpellcheck, isTranslate, querySelector, querySelectorAll, removeAttribute, removeAttributeNode, removeAttributeNS, scrollByLines, scrollByPages, scrollIntoView, scrollIntoView, scrollIntoViewIfNeeded, scrollIntoViewIfNeeded, setAccessKey, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setClassName, setContentEditable, setDir, setDraggable, setHidden, setInnerHTML, setInnerText, setLang, setOnabort, setOnbeforecopy, setOnbeforecut, setOnbeforepaste, setOnblur, setOnchange, setOnclick, setOncontextmenu, setOncopy, setOncut, setOndblclick, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOnerror, setOnfocus, setOninput, setOninvalid, setOnkeydown, setOnkeypress, setOnkeyup, setOnload, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnpaste, setOnreset, setOnscroll, setOnsearch, setOnselect, setOnselectstart, setOnsubmit, setOntouchcancel, setOntouchend, setOntouchmove, setOntouchstart, setOnwebkitfullscreenchange, setOnwebkitfullscreenerror, setOuterHTML, setOuterText, setScrollLeft, setScrollTop, setSpellcheck, setTabIndex, setTitle, setTranslate, setWebkitdropzone, webkitMatchesSelector, webkitRequestFullscreen, webkitRequestFullScreen

Methods inherited from interface elemental.svg.SVGTests
getRequiredExtensions, getRequiredFeatures, getSystemLanguage, hasExtension

Methods inherited from interface elemental.svg.SVGLangSpace
getXmllang, getXmlspace, setXmllang, setXmlspace

Methods inherited from interface elemental.svg.SVGExternalResourcesRequired
getExternalResourcesRequired

Methods inherited from interface elemental.svg.SVGStylable
getAnimatedClassName, getPresentationAttribute, getSvgStyle

Methods inherited from interface elemental.svg.SVGLocatable
getBBox, getCTM, getFarthestViewportElement, getNearestViewportElement, getScreenCTM, getTransformToElement

Methods inherited from interface elemental.svg.SVGFitToViewBox
getPreserveAspectRatio, getViewBox

Methods inherited from interface elemental.svg.SVGZoomAndPan
getZoomAndPan, setZoomAndPan

- Method Detail
  - getContentScriptType
```
String getContentScriptType()
```
    Corresponds to attribute contentScriptType on the given <svg> element.
  - setContentScriptType
```
void setContentScriptType(String arg)
```
  - getContentStyleType
```
String getContentStyleType()
```
    Corresponds to attribute contentStyleType on the given <svg> element.
  - setContentStyleType
```
void setContentStyleType(String arg)
```
  - getCurrentScale
```
float getCurrentScale()
```
    On an outermost <svg> element, this 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).
  - setCurrentScale
```
void setCurrentScale(float arg)
```
  - getCurrentTranslate
```
SVGPoint getCurrentTranslate()
```
    On an outermost <svg> element, the corresponding translation factor that takes into account user "magnification".
  - getCurrentView
```
SVGViewSpec getCurrentView()
```
    The definition of the initial view (i.e., before magnification and panning) of the current innermost SVG document fragment. The meaning depends on the situation:
    - If the initial view was a "standard" view, then:
      
      the values for viewBox, preserveAspectRatio and zoomAndPan within currentView will match the values for the corresponding DOM attributes that are on SVGSVGElement directly
      
      the values for transform and viewTarget within currentView will be null
    - If the initial view was a link into a <view> element, then:
      
      the values for viewBox, preserveAspectRatio and zoomAndPan within currentView will correspond to the corresponding attributes for the given <view> element
      
      the values for transform and viewTarget within currentView will be null
    - If the initial view was a link into another element (i.e., other than a <view> ), then:
      
      the values for viewBox, preserveAspectRatio and zoomAndPan within currentView will match the values for the corresponding DOM attributes that are on SVGSVGElement directly for the closest ancestor <svg> element
      
      the values for transform within currentView will be null
      
      the viewTarget within currentView will represent the target of the link
    - If the initial view was a link into the SVG document fragment using an SVG view specification fragment identifier (i.e., #svgView(...)), then:
      
      the values for viewBox, preserveAspectRatio, zoomAndPan, transform and viewTarget within currentView will correspond to the values from the SVG view specification fragment identifier
  - getAnimatedHeight
```
SVGAnimatedLength getAnimatedHeight()
```
    Corresponds to attribute height on the given <svg> element.
  - getPixelUnitToMillimeterX
```
float getPixelUnitToMillimeterX()
```
    Size of a pixel units (as defined by CSS2) along the x-axis of the viewport, which represents a unit somewhere in the range of 70dpi to 120dpi, and, on systems that support this, might actually match the characteristics of the target medium. On systems where it is impossible to know the size of a pixel, a suitable default pixel size is provided.
  - getPixelUnitToMillimeterY
```
float getPixelUnitToMillimeterY()
```
    Corresponding size of a pixel unit along the y-axis of the viewport.
  - getScreenPixelToMillimeterX
```
float getScreenPixelToMillimeterX()
```
    User interface (UI) events in DOM Level 2 indicate the screen positions at which the given UI event occurred. When the browser actually knows the physical size of a "screen unit", this attribute will express that information; otherwise, user agents will provide a suitable default value such as .28mm.
  - getScreenPixelToMillimeterY
```
float getScreenPixelToMillimeterY()
```
    Corresponding size of a screen pixel along the y-axis of the viewport.
  - isUseCurrentView
```
boolean isUseCurrentView()
```
    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 to 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.
  - getViewport
```
SVGRect getViewport()
```
    The position and size of the viewport (implicit or explicit) that corresponds to this <svg> element. When the browser is actually rendering the content, then the position and size values represent the actual values when rendering. The position and size values are unitless values in the coordinate system of the parent element. If no parent element exists (i.e., <svg> element represents the root of the document tree), if this SVG document is embedded as part of another document (e.g., via the HTML <object> element), then the position and size are unitless values in the coordinate system of the parent document. (If the parent uses CSS or XSL layout, then unitless values represent pixel units for the current CSS or XSL viewport.)
  - getAnimatedWidth
```
SVGAnimatedLength getAnimatedWidth()
```
    Corresponds to attribute width on the given <svg> element.
  - getX
```
SVGAnimatedLength getX()
```
  - getY
```
SVGAnimatedLength getY()
```
  - animationsPaused
```
boolean animationsPaused()
```
    Returns true if this SVG document fragment is in a paused state.
  - checkEnclosure
```
boolean checkEnclosure(SVGElement element,
                       SVGRect rect)
```
    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.
  - checkIntersection
```
boolean checkIntersection(SVGElement element,
                          SVGRect rect)
```
    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.
  - createSVGAngle
```
SVGAngle createSVGAngle()
```
    Creates an SVGAngle object outside of any document trees. The object is initialized to a value of zero degrees (unitless).
  - createSVGLength
```
SVGLength createSVGLength()
```
    Creates an SVGLength object outside of any document trees. The object is initialized to a value of zero user units.
  - createSVGMatrix
```
SVGMatrix createSVGMatrix()
```
    Creates an SVGMatrix object outside of any document trees. The object is initialized to the identity matrix.
  - createSVGNumber
```
SVGNumber createSVGNumber()
```
    Creates an SVGNumber object outside of any document trees. The object is initialized to a value of zero.
  - createSVGPoint
```
SVGPoint createSVGPoint()
```
    Creates an SVGPoint object outside of any document trees. The object is initialized to the point (0,0) in the user coordinate system.
  - createSVGRect
```
SVGRect createSVGRect()
```
    Creates an SVGRect object outside of any document trees. The object is initialized such that all values are set to 0 user units.
  - createSVGTransform
```
SVGTransform createSVGTransform()
```
    Creates an SVGTransform object outside of any document trees. The object is initialized to an identity matrix transform (SVG_TRANSFORM_MATRIX).
  - createSVGTransformFromMatrix
```
SVGTransform createSVGTransformFromMatrix(SVGMatrix matrix)
```
    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 deselectAll()
```
    Unselects any selected objects, including any selections of text strings and type-in bars.
  - forceRedraw
```
void forceRedraw()
```
    In rendering environments supporting interactivity, forces the user agent to immediately redraw all regions of the viewport that require updating.
  - getCurrentTime
```
float 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.
  - getElementById
```
Element getElementById(String elementId)
```
    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.
  - getEnclosureList
```
NodeList getEnclosureList(SVGRect rect,
                          SVGElement referenceElement)
```
    Returns the list 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.
  - getIntersectionList
```
NodeList getIntersectionList(SVGRect rect,
                             SVGElement referenceElement)
```
    Returns the list 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.
  - pauseAnimations
```
void 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.
  - setCurrentTime
```
void setCurrentTime(float seconds)
```
    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
```
int suspendRedraw(int maxWaitMilliseconds)
```
    Takes a time-out value which indicates that redraw shall not occur until:
    1. the corresponding unsuspendRedraw() call has been made,
    2. an unsuspendRedrawAll() call has been made, or
    3. 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 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.
  - unsuspendRedraw
```
void unsuspendRedraw(int suspendHandleId)
```
    Cancels a specified suspendRedraw() by providing a unique suspend handle ID that was returned by a previous suspendRedraw() call.
  - unsuspendRedrawAll
```
void unsuspendRedrawAll()
```
    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.

Interface SVGSVGElement

Field Summary

Fields inherited from interface elemental.dom.Element

Fields inherited from interface elemental.dom.Node

Fields inherited from interface elemental.svg.SVGZoomAndPan

Method Summary

Methods inherited from interface elemental.svg.SVGElement

Methods inherited from interface elemental.dom.Element

Methods inherited from interface elemental.dom.Node

Methods inherited from interface elemental.svg.SVGTests

Methods inherited from interface elemental.svg.SVGLangSpace

Methods inherited from interface elemental.svg.SVGExternalResourcesRequired

Methods inherited from interface elemental.svg.SVGStylable

Methods inherited from interface elemental.svg.SVGLocatable

Methods inherited from interface elemental.svg.SVGFitToViewBox

Methods inherited from interface elemental.svg.SVGZoomAndPan

Method Detail

getContentScriptType

setContentScriptType

getContentStyleType

setContentStyleType

getCurrentScale

setCurrentScale

getCurrentTranslate

getCurrentView

getAnimatedHeight

getPixelUnitToMillimeterX

getPixelUnitToMillimeterY

getScreenPixelToMillimeterX

getScreenPixelToMillimeterY

isUseCurrentView

getViewport

getAnimatedWidth

getX

getY

animationsPaused

checkEnclosure

checkIntersection

createSVGAngle

createSVGLength

createSVGMatrix

createSVGNumber

createSVGPoint

createSVGRect

createSVGTransform

createSVGTransformFromMatrix

deselectAll

forceRedraw

getCurrentTime

getElementById

getEnclosureList

getIntersectionList

pauseAnimations

setCurrentTime

suspendRedraw

unpauseAnimations

unsuspendRedraw

unsuspendRedrawAll