SVGSVGElement Class
Contents
[
Hide
]SVGSVGElement class
A key interface definition is the SVGSVGElement interface, which is the interface that corresponds to the ‘svg’ element. This interface contains various miscellaneous commonly-used utility methods, such as matrix operations and the ability to control the time of redraw on visual rendering devices.
public class SVGSVGElement : SVGGraphicsElement, IDocumentEvent, ISVGFitToViewBox, ISVGZoomAndPan
Properties
| Name | Description |
|---|---|
| getAttributes A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. | |
| getBaseURI The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node. | |
| getChildElementCount Returns the current number of element nodes that are children of this element. 0 if this element has no child nodes that are of nodeType 1. | |
getChildNodes The read-only childNodes property of the Node interface returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments. | |
| getChildren Returns the child elements of current element. | |
| getClassList Returns a live DOMTokenList which contains tokens received from parsing the “class” attribute. | |
| getClassName Corresponds to attribute ‘class’ on the given element. | |
| [getClassName] | |
| [setClassName] The class attribute of the element. This attribute has been renamed due to conflicts with the “class” keyword exposed by many languages. See the class attribute definition in HTML 4.01. | |
| [getCurrentScale] | |
| [setCurrentScale] 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, as described under Magnification and panning. 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). When accessed on an ‘svg’ element that is not an outermost svg element, it is undefined what behavior this attribute has. | |
| getCurrentTranslate On an outermost svg element, the corresponding translation factor that takes into account user “magnification”. When accessed on an ‘svg’ element that is not an outermost svg element, it is undefined what behavior this attribute has. | |
| getFarthestViewportElement The farthest ancestor ‘svg’ element. Null if the current element is the outermost svg element. | |
getFirstChild The read-only firstChild property of the Node interface returns the node’s first child in the tree, or null if the node has no children. | |
| getFirstElementChild Returns the first child element node of this element. null if this element has no child elements. | |
| getHeight Corresponds to attribute ‘height’ on the given ‘svg’ element. | |
| [getId] | |
| [setId] The value of the ‘id’ attribute on the given element, or the empty String if ‘id’ is not present. | |
| [getInnerHTML] | |
| [setInnerHTML] Returns a fragment of HTML or XML that represents the element’s contents. Can be set, to replace the contents of the element with nodes parsed from the given String. | |
getLastChild The read-only lastChild property of the Node interface returns the last child of the node. If its parent is an element, then the child is generally an element node, a text node, or a comment node. It returns null if there are no child elements | |
| getLastElementChild Returns the last child element node of this element. null if this element has no child elements. | |
| getLocalName Returns the local part of the qualified name of this node. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null. | |
| getNamespaceURI The package URI of this node, or null if it is unspecified. | |
| getNearestViewportElement The element which established the current viewport. Often, the nearest ancestor ‘svg’ element. Null if the current element is the outermost svg element. | |
| getNextElementSibling Returns the next sibling element node of this element. null if this element has no element sibling nodes that come after this one in the document tree. | |
getNextSibling The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent’s childNodes, or returns null if the specified node is the last child in the parent element. | |
| getNodeName The name of this node, depending on its type. | |
| getNodeType A code representing the type of the underlying object. | |
| [getNodeValue] | |
[setNodeValue] The nodeValue property of the Node interface returns or sets the value of the current node. | |
| [getOuterHTML] | |
| [setOuterHTML] Returns a fragment of HTML or XML that represents the element and its contents. Can be set, to replace the element with nodes parsed from the given String. | |
| getOwnerDocument The read-only ownerDocument property of the Node interface returns the top-level document object of the node. | |
| getOwnerSVGElement The nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element. | |
getParentElement The read-only parentElement property of Node interface returns the DOM node’s parent Element, or null if the node either has no parent, or its parent isn’t a DOM Element. | |
| getParentNode The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree. | |
| getPrefix The package prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect | |
| getPreserveAspectRatio Corresponds to attribute ‘preserveAspectRatio’ on the given element. | |
| getPreviousElementSibling Returns the previous sibling element node of this element. null if this element has no element sibling nodes that come before this one in the document tree. | |
getPreviousSibling The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent’s childNodes list, or null if the specified node is the first in that list. | |
| getRequiredExtensions Corresponds to attribute ‘requiredExtensions’ on the given element. | |
| getRequiredFeatures Corresponds to attribute ‘requiredFeatures’ on the given element. | |
| getSchemaTypeInfo The type information associated with this element. | |
| getShadowRoot Returns shadowRoot stored on this element or null if it’s closed. | |
| getStyle Corresponds to attribute ‘style’ on the given element. If the user agent does not support styling with CSS, then this attribute must always have the value of null. | |
| getSystemLanguage Corresponds to attribute ‘systemLanguage’ on the given element. | |
| getTagName The name of the element. | |
| [getTextContent] | |
| [setTextContent] This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new String is not empty or null, replaced by a single Text node containing the String this attribute is set to. | |
| getTransform Corresponds to attribute ‘transform’ on the given element. | |
| getViewBox Corresponds to attribute ‘viewBox’ on the given element. | |
| getViewportElement The element which established the current viewport. Often, the nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element. | |
| getWidth Corresponds to attribute ‘width’ on the given ‘svg’ element. | |
| X { get; } | Corresponds to attribute ‘x’ on the given ‘svg’ element. |
| Y { get; } | Corresponds to attribute ‘y’ on the given ‘svg’ element. |
| [getZoomAndPan] | |
| [setZoomAndPan] Corresponds to attribute ‘zoomAndPan’ on the given element. The value must be one of the SVG_ZOOMANDPAN_* constants defined on this interface. |
Methods
| Name | Description |
|---|---|
| addEventListener(String, IEventListener) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| addEventListener(String, DOMEventHandler, bool) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| addEventListener(String, IEventListener, bool) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| animationsPaused() | Returns true if this SVG document fragment is in a paused state. |
| appendChild(Node) | The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, appendChild() moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node). |
| attachShadow(ShadowRootMode) | Creates shadow root and attaches it to current element. |
| cloneNode() | The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not. |
| cloneNode(bool) | The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not. |
| createEvent(String) | Creates an Event of a type supported by the implementation. |
| createSVGAngle() | Creates an SVGAngle object outside of any document trees. The object is initialized to the value 0 degrees (unitless). |
| createSVGLength() | Creates an SVGLength object outside of any document trees. The object is initialized to the value of 0 user units. |
| createSVGMatrix() | Creates an SVGMatrix object outside of any document trees. The object is initialized to the identity matrix. |
| createSVGNumber() | Creates an SVGNumber object outside of any document trees. The object is initialized to a value of zero. |
| 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() | Creates an SVGRect object outside of any document trees. The object is initialized such that all values are set to 0 user units. |
| createSVGTransform() | Creates an SVGTransform object outside of any document trees. The object is initialized to an identity matrix transform (SVG_TRANSFORM_MATRIX). |
| createSVGTransformFromMatrix(SVGMatrix) | 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. |
| dispatchEvent(Event) | Dispatches an Event at the specified EventTarget, (synchronously) invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent(). |
| dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| getAttribute(String) | Retrieves an attribute value by name. |
| getAttributeNode(String) | Retrieves an attribute node by name. |
| getAttributeNodeNS(String, String) | Retrieves an Attr node by local name and package URI. |
| getAttributeNS(String, String) | Retrieves an attribute value by local name and package URI. |
| getBBox() | Returns the tight bounding box in current user space (i.e., after application of the ‘transform’ attribute, if any) on the geometry of all contained graphics elements, exclusive of stroking, clipping, masking and filter effects). Note that getBBox must return the actual bounding box at the time the method was called, even in case the element has not yet been rendered. |
| getCTM() | Returns the transformation matrix from current user units (i.e., after application of the ‘transform’ attribute, if any) to the viewport coordinate system for the nearestViewportElement. |
| 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(String) | 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. |
| getElementsByClassName(String) | Returns HTMLCollection object containing all the elements within element that have all the classes specified in argument. |
| getElementsByTagName(String) | Returns HTMLCollection object containing all elements with a given tag name, in document order. |
| getElementsByTagNameNS(String, String) | Returns HTMLCollection object containing all elements with a given local name and package URI String in document order. |
| getPlatformType() | This method is used to retrieve the ECMAScript object . |
| getScreenCTM() | Returns the transformation matrix from current user units (i.e., after application of the ‘transform’ attribute, if any) to the parent user agent’s notice of a “pixel”. For display devices, ideally this represents a physical screen pixel. For other devices or environments where physical pixel sizes are not known, then an algorithm similar to the CSS2 definition of a “pixel” can be used instead. Note that null is returned if this element is not hooked into the document tree. This method would have been more aptly named as getClientCTM, but the name getScreenCTM is kept for historical reasons. |
| hasAttribute(String) | Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. |
| hasAttributeNS(String, String) | Returns true when an attribute with a given local name and package URI is specified on this element or has a default value, false otherwise. |
| hasAttributes() | Returns whether this node (if it is an element) has any attributes |
| hasChildNodes() | The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not. |
| insertBefore(Node, Node) | The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node. |
| isDefaultNamespace(String) | The isDefaultNamespace() method of the Node interface accepts a package URI as an argument. It returns a boolean value that is true if the package is the default package on the given node and false if not. |
| isEqualNode(Node) | The isEqualNode() method of the Node interface tests whether two nodes are equal. Two nodes are equal when they have the same type, defining characteristics (for elements, this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the nodes. |
| isSameNode(Node) | The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object). |
| lookupNamespaceURI(String) | The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the package URI associated with it on the given node if found (and null if not). |
| lookupPrefix(String) | The lookupPrefix() method of the Node interface returns a String containing the prefix for a given package URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned. |
| normalize() | Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a “normal” form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter “normalize-characters” of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes. |
| 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. |
| querySelector(String) | Returns the first Element in document, which match selector |
| querySelectorAll(String) | Returns a NodeList of all the Elements in document, which match selector |
| remove() | Removes this instance. |
| removeAttribute(String) | Removes an attribute by name. |
| removeAttributeNode(Attr) | Removes the specified attribute node. |
| removeAttributeNS(String, String) | Removes an attribute by local name and package URI. |
| removeChild(Node) | The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node. |
| removeEventListener(String, IEventListener) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| removeEventListener(String, DOMEventHandler, bool) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| removeEventListener(String, IEventListener, bool) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| replaceChild(Node, Node) | Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed. |
| setAttribute(String, String) | Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter |
| setAttributeNode(Attr) | Adds a new attribute node. If an attribute with that name (nodeName) is already present in the element, it is replaced by the new one. |
| setAttributeNodeNS(Attr) | Adds a new attribute. If an attribute with that local name and that package URI is already present in the element, it is replaced by the new one. |
| setAttributeNS(String, String, String) | Adds a new attribute. If an attribute with the same local name and package URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. |
| setCurrentTime(float) | 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. |
| setIdAttribute(String, bool) | If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute. |
| setIdAttributeNode(Attr, bool) | If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute. |
| setIdAttributeNS(String, String, bool) | If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute. |
| toString() | Returns a String that represents this instance. |
| 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. |
See Also
- class SVGGraphicsElement
- interface ISVGFitToViewBox
- interface IDocumentEvent
- interface IViewCSS
- interface IDocumentCSS
- interface ISVGZoomAndPan
- package com.aspose.html.Dom.Svg
- package Aspose.HTML
