SVGMaskElement class
SVGMaskElement class
The SVGMaskElement interface corresponds to the ‘mask’ element.
Inheritance: SVGMaskElement →
SVGElement →
Element →
Node →
EventTarget →
DOMObject
The SVGMaskElement type exposes the following members:
Properties
| Property | Description |
|---|---|
| node_type | A code representing the type of the underlying object. |
| local_name | 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. |
| namespace_uri | The namespace URI of this node, or null if it is unspecified. |
| prefix | The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect |
| node_name | The name of this node, depending on its type. |
| base_uri | The absolute base URI of this node or null if the implementation wasn’t able to obtain an absolute URI. |
| owner_document | 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. |
| parent_node | 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. |
| parent_element | Gets the parent Element of this node. |
| child_nodes | A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.. |
| first_child | The first child of this node. If there is no such node, this returns null. |
| last_child | The last child of this node. If there is no such node, this returns null. |
| previous_sibling | The node immediately preceding this node. If there is no such node, this returns null. |
| next_sibling | The node immediately following this node. If there is no such node, this returns null. |
| node_value | The value of this node, depending on its type. |
| text_content | 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. |
| ELEMENT_NODE | An element node |
| ATTRIBUTE_NODE | An attribute node |
| TEXT_NODE | A text node |
| CDATA_SECTION_NODE | A cdata section node |
| ENTITY_REFERENCE_NODE | An entity reference node |
| ENTITY_NODE | An entity node |
| PROCESSING_INSTRUCTION_NODE | A processing instruction node |
| COMMENT_NODE | A comment node |
| DOCUMENT_NODE | A document node |
| DOCUMENT_TYPE_NODE | A document type node |
| DOCUMENT_FRAGMENT_NODE | A document fragment node |
| NOTATION_NODE | A notation node |
| class_list | Returns a live DOMTokenList which contains tokens received from parsing the “class” attribute. |
| tag_name | The name of the element. |
| id | The value of the ‘id’ attribute on the given element, or the empty string if ‘id’ is not present. |
| class_name | Corresponds to attribute ‘class’ on the given element. |
| attributes | A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. |
| first_element_child | Returns the first child element node of this element. null if this element has no child elements. |
| last_element_child | Returns the last child element node of this element. null if this element has no child elements. |
| previous_element_sibling | 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. |
| next_element_sibling | 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. |
| child_element_count | 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. |
| children | Returns the child elements of current element. |
| inner_html | 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. |
| outer_html | 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. |
| shadow_root | Returns shadowRoot stored on this element or null if it’s closed. |
| owner_svg_element | The nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element. |
| viewport_element | The element which established the current viewport. Often, the nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element. |
| style | 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. |
| required_features | Corresponds to attribute ‘requiredFeatures’ on the given element. |
| required_extensions | Corresponds to attribute ‘requiredExtensions’ on the given element. |
| system_language | Corresponds to attribute ‘systemLanguage’ on the given element. |
| mask_units | Corresponds to attribute ‘maskUnits’ on the given ‘mask’ element. Takes one of the constants defined in SVGUnitTypes. |
| mask_content_units | Corresponds to attribute ‘maskContentUnits’ on the given ‘mask’ element. Takes one of the constants defined in SVGUnitTypes. |
| x | Corresponds to attribute ‘x’ on the given ‘mask’ element. Takes one of the constants defined in SVGUnitTypes. |
| y | Corresponds to attribute ‘y’ on the given ‘mask’ element. Takes one of the constants defined in SVGUnitTypes. |
| width | Corresponds to attribute ‘width’ on the given ‘mask’ element. Takes one of the constants defined in SVGUnitTypes. |
| height | Corresponds to attribute ‘height’ on the given ‘mask’ element. Takes one of the constants defined in SVGUnitTypes. |
Methods
| Method | Description |
|---|---|
| add_event_listener | This method allows the registration of event listeners on the event target. |
| add_event_listener | This method allows the registration of event listeners on the event target. |
| remove_event_listener | 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. |
| remove_event_listener | 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. |
| clone_node | 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. |
| clone_node | 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. |
| toggle_attribute | 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. |
| toggle_attribute | 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. |
| get_platform_type | This method is used to retrieve ECMAScript object Type. |
| dispatch_event | This method allows the dispatch of events into the implementations event model. |
| has_child_nodes | Returns whether this node has any children. |
| 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. |
| is_equal_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. |
| is_same_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. |
| lookup_prefix | 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. |
| lookup_namespace_uri | Look up the namespace URI associated to the given prefix, starting from this node. |
| is_default_namespace | This method checks if the specified namespaceURI is the default namespace or not. |
| insert_before | 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. |
| replace_child | 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. |
| remove_child | Removes the child node indicated by oldChild from the list of children, and returns it. |
| append_child | 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. |
| get_attribute_names | Returns the attribute names of the element as an Array of strings. If the element has no attributes it returns an empty array. |
| has_attributes | Returns whether this node (if it is an element) has any attributes |
| get_attribute | Retrieves an attribute value by name. |
| get_attribute_ns | Retrieves an attribute value by local name and namespace URI. |
| set_attribute | 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 |
| set_attribute_ns | 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. |
| remove_attribute | Removes an attribute by name. |
| remove_attribute_ns | Removes an attribute by local name and namespace URI. |
| has_attribute | Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. |
| has_attribute_ns | 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. |
| get_attribute_node | Retrieves an attribute node by name. |
| set_attribute_node | 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. |
| remove_attribute_node | Removes the specified attribute node. |
| get_attribute_node_ns | Retrieves an Attr node by local name and namespace URI. |
| set_attribute_node_ns | 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. |
| get_elements_by_tag_name | Returns a NodeList of all descendant Elements with a given tag name, in document order. |
| get_elements_by_tag_name_ns | Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order. |
| remove | Removes this instance. |
| query_selector_all | Returns a NodeList of all the Elements in document, which match selector |
| query_selector | Returns the first Element in document, which match selector |
| attach_shadow | Creates shadow root and attaches it to current element. |
| get_elements_by_class_name | 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/ |
See Also
- module
aspose.svg - class
DOMObject - class
Element - class
EventTarget - class
IEventListener - class
Node - class
SVGElement - class
SVGMaskElement
