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 |
|---|---|
| Attributes { get; } | A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. |
| virtual BaseURI { get; } | The absolute base URI of this node or null if the implementation wasn’t able to obtain an absolute URI. |
| ChildElementCount { get; } | 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. |
| ChildNodes { get; } | A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.. |
| Children { get; } | Returns the child elements of current element. |
| ClassList { get; } | Returns a live DOMTokenList which contains tokens received from parsing the “class” attribute. |
| ClassName { get; } | Corresponds to attribute ‘class’ on the given element. |
| ClassName { get; set; } | 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. |
| CurrentScale { get; set; } | 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. |
| CurrentTranslate { get; } | 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. |
| FarthestViewportElement { get; } | The farthest ancestor ‘svg’ element. Null if the current element is the outermost svg element. |
| FirstChild { get; } | The first child of this node. If there is no such node, this returns null. |
| FirstElementChild { get; } | Returns the first child element node of this element. null if this element has no child elements. |
| Height { get; } | Corresponds to attribute ‘height’ on the given ‘svg’ element. |
| Id { get; set; } | The value of the ‘id’ attribute on the given element, or the empty string if ‘id’ is not present. |
| InnerHTML { get; set; } | 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. |
| LastChild { get; } | The last child of this node. If there is no such node, this returns null. |
| LastElementChild { get; } | Returns the last child element node of this element. null if this element has no child elements. |
| override LocalName { get; } | 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. |
| override NamespaceURI { get; } | The namespace URI of this node, or null if it is unspecified. |
| NearestViewportElement { get; } | The element which established the current viewport. Often, the nearest ancestor ‘svg’ element. Null if the current element is the outermost svg element. |
| NextElementSibling { get; } | 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. |
| NextSibling { get; } | The node immediately following this node. If there is no such node, this returns null. |
| override NodeName { get; } | The name of this node, depending on its type. |
| override NodeType { get; } | A code representing the type of the underlying object. |
| virtual NodeValue { get; set; } | The value of this node, depending on its type. |
| OuterHTML { get; set; } | 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. |
| virtual OwnerDocument { get; } | The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null. |
| OwnerSVGElement { get; } | The nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element. |
| ParentElement { get; } | Gets the parent Element of this node. |
| ParentNode { get; } | The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null. |
| override Prefix { get; } | The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect |
| PreserveAspectRatio { get; } | Corresponds to attribute ‘preserveAspectRatio’ on the given element. |
| PreviousElementSibling { get; } | 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. |
| PreviousSibling { get; } | The node immediately preceding this node. If there is no such node, this returns null. |
| RequiredExtensions { get; } | Corresponds to attribute ‘requiredExtensions’ on the given element. |
| RequiredFeatures { get; } | Corresponds to attribute ‘requiredFeatures’ on the given element. |
| ShadowRoot { get; } | Returns shadowRoot stored on this element or null if it’s closed. |
| Style { get; } | 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. |
| SystemLanguage { get; } | Corresponds to attribute ‘systemLanguage’ on the given element. |
| TagName { get; } | The name of the element. |
| override TextContent { get; set; } | 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. |
| Transform { get; } | Corresponds to attribute ‘transform’ on the given element. |
| ViewBox { get; } | Corresponds to attribute ‘viewBox’ on the given element. |
| ViewportElement { get; } | The element which established the current viewport. Often, the nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element. |
| Width { get; } | 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. |
| ZoomAndPan { get; set; } | 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) | This method allows the registration of event listeners on the event target. |
| AddEventListener(string, DOMEventHandler, bool) | This method allows the registration of event listeners on the event target. |
| AddEventListener(string, IEventListener, bool) | This method allows the registration of event listeners on the event target. |
| AnimationsPaused() | Returns true if this SVG document fragment is in a paused state. |
| AppendChild(Node) | Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed. |
| AttachShadow(ShadowRootMode) | Creates shadow root and attaches it to current element. |
| CloneNode() | Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data. |
| CloneNode(bool) | Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data. |
| 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) | This method allows the dispatch of events into the implementations event model. |
| Dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| GetAttribute(string) | Retrieves an attribute value by name. |
| GetAttributeNames() | Returns the attribute names of the element as an Array of strings. If the element has no attributes it returns an empty array. |
| GetAttributeNode(string) | Retrieves an attribute node by name. |
| GetAttributeNodeNS(string, string) | Retrieves an Attr node by local name and namespace URI. |
| GetAttributeNS(string, string) | Retrieves an attribute value by local name and namespace 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 a live NodeList object containing all the elements in the document that have all the classes specified in argument. http://www.w3.org/TR/dom/ |
| GetElementsByTagName(string) | Returns a NodeList of all descendant Elements with a given tag name, in document order. |
| GetElementsByTagNameNS(string, string) | Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order. |
| virtual GetPlatformType() | This method is used to retrieve ECMAScript object Type. |
| 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 namespace 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() | Returns whether this node has any children. |
| InsertBefore(Node, Node) | Inserts the node before the existing child node child. If child is null, insert node at the end of the list of children. If child is a DocumentFragment object, all of its children are inserted, in the same order, before child. If the child is already in the tree, it is first removed. |
| IsDefaultNamespace(string) | This method checks if the specified namespaceURI is the default namespace or not. |
| IsEqualNode(Node) | Tests whether two nodes are equal. This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true. |
| IsSameNode(Node) | Returns whether this node is the same node as the given one. This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect. |
| LookupNamespaceURI(string) | Look up the namespace URI associated to the given prefix, starting from this node. |
| LookupPrefix(string) | Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method. See Namespace Prefix Lookup for details on the algorithm used by this method. |
| 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 namespace URI. |
| RemoveChild(Node) | Removes the child node indicated by oldChild from the list of children, and returns it. |
| RemoveEventListener(string, IEventListener) | This method allows the removal of event listeners from the event target. If an IEventListener is removed from an EventTarget 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 IEventListener is removed from an EventTarget 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 IEventListener is removed from an EventTarget 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 namespace 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 namespace 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. |
| ToggleAttribute(string) | If force is not given, “toggles” qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. |
| ToggleAttribute(string, bool) | If force is not given, “toggles” qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. |
| override 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
- namespace Aspose.Svg
- assembly Aspose.SVG
