This appendix is normative.
During the later stages of development of the SVG Mobile 1.1 specification [SVGM11] it became obvious that there was a requirement to subset the SVG and XML DOM in order to reduce the burden on implementations. SVG Tiny 1.2 adds new features to the uDOM, allowing for as much necessary functionality as possible, still being suitable for SVG Tiny implementations.
Furthermore, it should be possible to implement the uDOM on devices that support SVG Tiny 1.1 although, in this case, the scripting would be external to the SVG document (since SVG Tiny 1.1 does not support inline scripting).
The goal of the uDOM definition is to provide an API that allows access to initial and computed attribute and property values, to reduce the number of interfaces compared to the traditional SVG DOM, to reduce run-time memory footprint using necessary features of the core XML DOM, as well as the most useful SVG features (such as transformation matrices). A subset of the uDOM (corresponding to SVG Tiny 1.1) is already successfully implemented by various implementations ofJSR 226: Scalable 2D Vector Graphics API for J2ME, compatibility with which is another goal of the uDOM [JSR226].
The uDOM makes normative reference to DOM Level 2 Events [DOM2EVENTS], and informative reference to DOM Level 3 Events [DOM3EVENTS]. A minimal subset of DOM Level 3 Events was included in the uDOM to specify functionality as currently implemented on mobile devices, since DOM Level 3 Events was not yet a Recommendation at the time of publication. It is anticipated that DOM Level 3 Events may change to reflect the needs of the current Web environment, and any conflicting changes will supersede the functionality specified here for later SVG specifications.
TheIDL definition for the uDOM is provided.
This appendix consists of the following parts:
Overview of the SVG uDOM — an informative introduction to the uDOM, including a summary of supported features and descriptions by topic of the key features and constraints together with examples.
Conforming to the SVG uDOM — a normative section that states conformance criteria for the SVG uDOM as well as descriptions of key features.
A normative definition of all the interfaces in the SVG uDOM (DOM Core APIs,DOM Views APIs,SMIL DOM APIs,DOM Events APIs andSVG DOM APIs).
The following sections provides an informative overview of the SVG uDOM's key features and constraints.
Note: Like other W3C DOM definitions, the SVG uDOM is programming-language independent. Although this appendix only contains ECMAScript and Java language examples, the SVG uDOM is compatible with other programming languages.
The SVG uDOM offers access to aDocument object which is the root for accessing other features. The way theDocument object becomes available depends on the usage context. In some languages, such as Java, theDocument object can be obtained by implementing theEventListenerInitializer2 interface. TheSVG user agent will invoke the implementation'sinitializeEventListeners method once the script has been loaded and is ready to bind to the document. TheDocument object is sometimes accessible through other means, for example through theAbstractView::document member which is available on the global object in ECMAScript.
The SVG uDOM only allows navigation of the document node and the element nodes in the DOM tree. Two options are available for navigating the hierarchy of elements:
getElementById method on theDocument interface.parentNode attribute on theNode interface. TheElementTraversal interface providesfirstElementChild,lastElementChild,previousElementSibling andnextElementSibling, which are particularly suitable for constrained devices [ET]. These traversal mechanisms skip over intervening nodes between element nodes, such as text nodes which might only contain white space.
The SVG uDOM allows the creation of new elements using thecreateElementNS method of theDocument interface.
String svgNS = "http://www.w3.org/2000/svg";Element myRect = document.createElementNS(svgNS, "rect");
Elements can be inserted into the document tree by calling theappendChild orinsertBefore methods on theNode that is to be the parent.
var svgNS = "http://www.w3.org/2000/svg";// Create a new <rect> elementvar myRect = document.createElementNS(svgNS, "rect");// Set the various <rect> properties before appending...// Add element to the root of the documentvar svgRoot = document.documentElement;svgRoot.appendChild(myRect);// Create a new <ellipse> elementvar myEllipse = document.createElementNS(svgNS, "ellipse");// Set the various <ellipse> properties before insertion...// Insert the ellipse before the rectanglesvgRoot.insertBefore(myEllipse, myRect);
An element can be removed from the document tree by calling theremoveChild method on its parentNode.
var myRect = ...;var myGroup = document.getElementById("myGroup");myGroup.appendChild(myRect);...myGroup.removeChild(myRect); The SVG Tiny 1.2 uDOM supports two ways of accessing XML attributes and CSS properties; the standard way viagetAttributeNS andsetAttributeNS on theElement interface, and via a new concept calledtraits.
A trait is the typed value (e.g. a number, not just a string), associated with an element by an XML attribute or a CSS property. The trait facilities in the SVG uDOM allow for strongly-typed access to certain attribute and property values. For example, there is agetFloatTrait method for getting an attribute or property value directly as afloat, in contrast with thegetAttributeNS method which always returns a string. The trait facilities in the SVG uDOM are available on theTraitAccess interface, which is implemented by all DOM objects representingSVG elements.
float width = myRect.getFloatTrait("width");width += 10;myRect.setFloatTrait("width", width); An important difference betweengetTraitNS (along with all other trait getter methods) andgetAttributeNS is thatgetTraitNS returns the computed attribute value butgetAttributeNS returns the specified attribute value (which might not exactly match the original specified value due to the possibility of user agent value normalization as described inAttribute/property normalization).
getTraitNS andgetAttributeNS<g fill="red"> <rect x="1" y="1" width="5" height="5"/> <rect fill="inherit" x="1" y="1" width="5" height="5"/></g>
In the above example:
r1.getTraitNS(null, "fill") returns"red" (or an equivalent normalized form, seeAttribute/property normalization).r2.getTraitNS(null, "fill") returns"red" (or an equivalent normalized form, seeAttribute/property normalization).r1.getAttributeNS(null, "fill") returns"".r2.getAttributeNS(null, "fill") returns"inherit". Traits may also be animated, by animating the underlying XML attribute orproperty. To access the animated value of a trait, thegetPresentationTrait, along with the other similarly named presentation trait getter methods on theTraitAccess interface, can be used.
The SVG uDOM utilizes DOM Level 2 Events, using theEventTarget interface, to support the ability to add and remove event listeners to nodes in a document.
class MyEventListener implements EventListener { public void handleEvent(Event evt) { // Do whatever is needed here }}...// Create a listenerEventListener listen1 = new MyEventListener();// Listen to click events, during the bubbling phaseSVGElement myRect = (SVGElement)document.getElementById("myRect");myRect.addEventListener("click", listen1, false);...// Remove the click listenermyRect.removeEventListener("click", listen1, false);Animation elements can be started and stopped using the methods available on theElementTimeControl interface.
var animateColor = document.getElementById("myAnimation");// Start the animation 2.5 seconds from now.animateColor.beginElementAt(2.5);Control of multimedia elements, such as the'audio','video', and'animation' elements is available through a combination of theElementTimeControl andSVGTimedElement interfaces. Some common controls, and the interface methods to access them, are listed below:
Note that SVG 1.2 Tiny does not define controlling the rate of playback (such as fast-forward or reverse) for time container elements. This functionality may be included in a future specification.
The SVG uDOM uses the same Java package names as the upcoming SVG 1.2 Full DOM (e.g.org.w3c.dom,org.w3c.dom.events,org.w3c.dom.svg). This allows Java applications which restrict themselves to the features in the SVG uDOM to also run in implementations that support the SVG 1.2 Full DOM.
The SVG uDOM uses IEEE-754 single precision floating point values to representfloat values in the IDL [IEEE-754]. While such values support a number of non-finite values — a set of NaN (Not a Number) values and positive & negative infinity — these values are never used by the uDOM. Thus, unless otherwise specified in the prose for an operation or attribute, aDOMException with error code NOT_SUPPORTED_ERR must be thrown if a non-finite value is passed as an operation argument, or assigned to an attribute, whose type isfloat, or if a list of floating point values containing a non-finite value is passed as an operation argument, or assigned to an attribute, whose type issequence<float>.
In addition, none of the operations or attributes in the uDOM distinguish between positive and negative zero. A negative zero must be treated as a positive zero when passed as an operation argument, or assigned to an attribute, whose type isfloat orsequence<float>.
Operations and attributes in the uDOM will never return a non-finite or negative zero value from an operation or attribute.
A viewer implementing the uDOM is allowed to returnnormalized attribute values ([DOM3], section 1.4) fromgetAttributeNS and the various trait getter methods (getTrait,getTraitNS,getFloatTrait, etc.) and trait presentation value getter methods (getPresentationTrait,getPresentationTraitNS,getFloatPresentationTrait, etc.). The following is a list of possible attribute normalizations:
In the SVG uDOM, there are two alternative ways to access an element's textual content. Text access via theTraitAccess interface is available on allSVGElements. This was available in the SVG Tiny 1.1 uDOM (used in theJSR 226 specification [JSR226]) and is still available in order to keep backward compability. The SVG Tiny 1.2 uDOM specification introduces thetextContent attribute on theNode interface as a more generic text access mechanism.
To access or set the text string value for an element via traits youinvokegetTrait() orsetTrait() on that element and pass#text asthe name of the trait you want to get or set. For example,MyTextElement.setTrait("#text", "Hello");Text access via the#text mechanism must be supported ontext content,'desc','title'and'metadata' elements. Text accessto other elements defined within this specification (seelist of elements) is notsupported and an implementation should ignore any text on these elements.
The result of getting and setting text content via the#text mechanism is exactly the sameas when using thetextContent attribute. Therefore the user shouldbe aware of the fact that styling by child'tspan' elements (i.e.'tspan' elements that are children of the element which text content is retrieved) will be lost if a text string is retrieved from an element and then set back again.
The#text trait is included for compatibility with theJSR 226 specification [JSR226]. It is recommended that where compatibility with JSR 226 implementations is not required content developers usetextContent instead as it is more generally applicable and supports better compatibility with DOM Level 3 Core [DOM3].
INUSE_ATTRIBUTE_ERR,andVALIDATION_ERR).However, in the interest of facilitating implementations that support both theuDOM and the complete DOM Level 3 Core, none of the exception codes are removed.exception DOMException{unsigned short code;};// ExceptionCodeconst unsigned short INDEX_SIZE_ERR = 1;const unsigned short DOMSTRING_SIZE_ERR = 2;const unsigned short HIERARCHY_REQUEST_ERR = 3;const unsigned short WRONG_DOCUMENT_ERR = 4;const unsigned short INVALID_CHARACTER_ERR = 5;const unsigned short NO_DATA_ALLOWED_ERR = 6;const unsigned short NO_MODIFICATION_ALLOWED_ERR = 7;const unsigned short NOT_FOUND_ERR = 8;const unsigned short NOT_SUPPORTED_ERR = 9;const unsigned short INUSE_ATTRIBUTE_ERR = 10;const unsigned short INVALID_STATE_ERR = 11;const unsigned short SYNTAX_ERR = 12;const unsigned short INVALID_MODIFICATION_ERR = 13;const unsigned short NAMESPACE_ERR = 14;const unsigned short INVALID_ACCESS_ERR = 15;const unsigned short VALIDATION_ERR = 16;const unsigned short TYPE_MISMATCH_ERR = 17;INDEX_SIZE_ERR.DOMSTRING_SIZE_ERR.HIERARCHY_REQUEST_ERR.WRONG_DOCUMENT_ERR.INVALID_CHARACTER_ERR.NO_DATA_ALLOWED_ERR.NO_MODIFICATION_ALLOWED_ERR.NOT_FOUND_ERR.NOT_SUPPORTED_ERR.INUSE_ATTRIBUTE_ERR.INVALID_STATE_ERR.SYNTAX_ERR.INVALID_MODIFICATION_ERR.NAMESPACE_ERR.INVALID_ACCESS_ERR.VALIDATION_ERR.TYPE_MISMATCH_ERR.This interface is a subset of theNode interface defined inDOM Level 3 Core ([DOM3], section 1.4). Node types that must be supported in the uDOM areElement nodes andDocument nodes.
This subset does not support the NodeType and DocumentPosition definition groups, since thenodeType field and thecompareDocumentPosition method are not members of the subsetted interface.
ConcerningtextContent, there is no requirement to create a Text node on setting since this subset has no interface representing Text nodes. However, the behaviour oftextContent must be as if the Text node described in thethe definition of textContent had indeed been created.
An alternate way of accessing text content on elements defined within the SVG specification is with the use ofthe#text trait.
interface Node{readonly attribute DOMString namespaceURI;readonly attribute DOMString localName;readonly attribute Node parentNode;readonly attribute Document ownerDocument;attribute DOMString textContent;Node appendChild(in Node newChild) raises(DOMException);Node insertBefore(in Node newChild, in Node refChild) raises(DOMException);Node removeChild(in Node oldChild) raises(DOMException);Node cloneNode(in boolean deep);};namespaceURI.localName.parentNode.ownerDocument.textContent.appendChild.insertBefore.removeChild.cloneNode.This interface is a subset of theElement interface defined inDOM Level 3 Core ([DOM3], section 1.4).
ConcerningsetAttributeNS, there is no requirement to take theprefix into account since neither theprefix field nor theAttr interface are supported.
interface Element : Node, ElementTraversal{DOMString getAttributeNS(in DOMString namespaceURI, in DOMString localName) raises(DOMException);void setAttributeNS(in DOMString namespaceURI, in DOMString qualifiedName, in DOMString value) raises(DOMException);DOMString getAttribute(in DOMString name);void setAttribute(in DOMString name, in DOMString value) raises(DOMException);};getAttributeNS.setAttributeNS.getAttribute.setAttribute.This interface is a subset of theDocument interface defined inDOM Level 3 Core ([DOM3], section 1.4).
interface Document : Node{Element createElementNS(in DOMString namespaceURI, in DOMString qualifiedName) raises(DOMException);readonly attribute Element documentElement;Element getElementById(in DOMString elementId);};documentElement.createElementNS.getElementById.interface ElementTraversal{readonly attribute Element firstElementChild;readonly attribute Element lastElementChild;readonly attribute Element nextElementSibling;readonly attribute Element previousElementSibling;readonly attribute unsigned long childElementCount;};firstElementChild.lastElementChild.nextElementSibling.previousElementSibling.childElementCount.Location objects provide a representation of their document's address.
interface Location{void assign(in DOMString iri);void reload();}; When this method is invoked, the user agent must navigate to the givenIRI. The result of the traversal must be identical to the traversal caused by an'a' hyperlink with the'target' attribute set to'_replace'. The difference is that the'a' hyperlink is activated on user interaction butassign is activated from script.The current document location is the IRI of theDocument object pointed to by theAbstractView.document field.RelativeIRI references are resolved based on the base IRI of the current document. If the base IRI differs from that of the current document, the current document is discarded, and loading and parsing of the document at the specified IRI then begins. If the previous step resulted in loading of a new document, the timeline is restarted and a new load event is fired.Note: For HTTP, apragma:no-cache ([RFC2616], section 14.32) is not issued and thus a fresh copy from the server is not forced if there is a cache.
When this method is invoked, the user agent is forced to reload the resource identified by theLocation. The current document location is theIRI of theDocument object pointed to by theAbstractView.document field.
This is a subset of the de facto standard Window interface that many browsers implement. SeeWindow Object 1.0 andThe default view inHTML 5 for ongoing standardization efforts in this area at the time of writing [WINDOW,HTML5].
TheWindow interface must be implemented by the object that represents thedefault view of the document ([DOM2VIEWS], section 1.1). This object also implementsAbstractView. Thus, in the ECMAScript language binding, the global script object implementsWindow. TheWindow object for a document can also be obtained throughDocumentView::defaultView.
interface Window{readonly attribute Window parent;readonly attribute Location location;}; TheWindow object that is the parent view of this document's default view. If theWindow has no notion of parent (e.g. if the document is displayed as the top level document in a viewer), then the value of this attribute isnull.
TheLocation object that is for that Window object's active document.
SVG Tiny 1.2 requires completeDOM Level 2 Views support, which includes theAbstractView andDocumentView interfaces [DOM2VIEWS].
The SVG Tiny 1.2 uDOM does not provide access to any views of the document other than the default view. The default view is accessible throughDocumentView::defaultView. Note that the default view is required to also implement theSVGGlobal interface. In the ECMAScript language binding, the global script object must also be the object that represents the default view.
This interface is a copy of theAbstractView interface fromDOM Level 2 Views ([DOM2VIEWS], section 1.2), and must be implemented by the object that represents the thedefault view of the document. In the ECMAScript language binding, the global script object must implement this interface.
interface AbstractView{readonly attribute DocumentView document;};AbstractView::document inDOM Level 2 Views ([DOM2VIEWS], section 1.2).This interface is a copy of theDocumentView interface fromDOM Level 2 Views ([DOM2VIEWS], section 1.2), and must be implemented by allDocument objects.
interface DocumentView{readonly attribute AbstractView defaultView;};null if none available.The value of this attribute is theSVGGlobal object associated with the document.SeeDocumentView::defaultView inDOM Level 2 Views ([DOM2VIEWS], section 1.2).This interface is a subset of theEventTarget interface defined inDOM Level 2 Events ([DOM2EVENTS], section 1.3.1).
Please note that SVG Tiny 1.2 user agents are not required to support the capture phase, and conformant SVG Tiny 1.2 content must not make use of it. If an attempt to specify event operations on the capture phase is made an SVG Tiny user agent that does not support it must ignore them as ifaddEventListener had not been called. (SeeEvent flow for details.)
As indicated in theDOM Level 2 Events definition forEventTarget, this interface is implemented by allNodes.
Refer to theDOM Events Level 2 specification [DOM2EVENTS] or theXML Events [XML-EVENTS] specification introduction for an explanation of the SVG event flow and the meaning of event targets, event current target, bubble and capture.
interface EventTarget{void addEventListener(in DOMString type, in EventListener listener, in boolean useCapture);void removeEventListener(in DOMString type, in EventListener listener, in boolean useCapture);};addEventListener.removeEventListener. TheEventListener interface is implemented by script to handle an event. The interface can be implemented in ECMAScript by using a Function object (or by using an object with ahandleEvent property), and in Java by implementing the interface directly. TheEventListener object can then be registered as a listener usingEventTarget::addEventListener.
This interface is identical to theEventListener interface defined inDOM Level 2 Events ([DOM2EVENTS], section 1.3.1).
interface EventListener{void handleEvent(in Event evt);};handleEvent. This interface is a subset of theEvent interface defined inDOM Level 2 Events ([DOM2EVENTS, section 1.4), with one addition: thedefaultPrevented attribute. This subset does not support the PhaseType definition group.
For a list of supported event types see theComplete list of supported events section of the Interactivity chapter.
interface Event{readonly attribute EventTarget target;readonly attribute EventTarget currentTarget;readonly attribute DOMString type;readonly attribute boolean cancelable;readonly attribute boolean defaultPrevented;void stopPropagation();void preventDefault();};target.currentTarget.type.cancelable.Event.preventDefault() has been called for this event.stopPropagation.preventDefault.Event types that areMouseEvents:click,mousedown,mouseup,mouseover,mousemove,mouseout.
This interface is a subset of theMouseEvent interface defined inDOM Level 2 Events ([DOM2EVENTS, section 1.6.2).
interface MouseEvent : UIEvent{readonly attribute long screenX;readonly attribute long screenY;readonly attribute long clientX;readonly attribute long clientY;readonly attribute unsigned short button;};Event types that areMouseWheelEvents:mousewheel.
This interface is a subset of theMouseWheelEvent interface defined inDOM Level 3 Events ([DOM3EVENTS], section 1.7.6), and inherits attributes from theMouseEvent interface defined inDOM Level 2 Events ([DOM2EVENTS], section 1.6.2).
interface MouseWheelEvent : MouseEvent{readonly attribute long wheelDelta;};textInput.This interface is a subset of theTextEvent interface defined inDOM Level 3 Events ([DOM3EVENTS], section 1.7.2).
interface TextEvent : UIEvent{readonly attribute DOMString data;};data holds the value of the characters generated by the character device. This may be a single Unicode character or a non-empty sequence of Unicode characters [UNICODE]. Characters should be normalized to Unicode normalization formNFC, defined inUnicode Normalization Forms [UAX15]. This attribute will not benull or contain an empty string.Event types that areKeyboardEvents:keydown,keyup.
This interface is a subset of theKeyboardEvent interface defined inDOM Level 3 Events ([DOM3EVENTS], section 1.7.3).
interface KeyboardEvent : UIEvent{readonly attribute DOMString keyIdentifier;};keyIdentifier holds the identifier of the key. The key identifiers are defined in theKey identifiers set, below. Implementations that are unable to identify a key must use the key identifier"Unidentified".This is a subset of thekey identifiers defined inDOM Level 3 Events, and defines a snapshot of functionality currently implemented on mobile devices ([DOM3EVENTS], section A.2).
The list of key identifiers contained in this section is not exhaustive and input devices may have to define their own key identifiers. It is expected that DOM Level 3 Events will define an algorithm to determine which key identifier to use. Future SVG specifications will defer to DOM Level 3 Events for a definitive treatment of keyboard events and key identifiers.
"U+0000","U+0001", ...,"U+10FFFF" are Unicode-based key identifiers [UNICODE]. A user agent may treat string literal characters in content as Unicode codepoints for the purpose of key identification.
Event types that areUIEvents:DOMFocusIn,DOMFocusOut,DOMActivate,MouseEvent,TextEvent,KeyboardEvent,
This interface is a subset of theUIEvent interface defined inDOM Level 2 Events ([DOM2EVENTS, section 1.6.1).
interface UIEvent : Event{readonly attribute long detail;};detail.The progress events defined here are intended to be a subset of those defined inProgress Events 1.0 [PROGRESSEVENTS].
Many resources, such as raster images, movies and complex SVG content can take a substantial amount of time to download. In some use cases the author would prefer to delay the display of content or the beginning of an animation until the entire content of a file has been downloaded. In other cases, the author may wish to give the viewer some feedback that a download is in progress (e.g. a loading progress screen).
TheProgressEvent occurs when the user agent makes progress loading a resource (external) referenced by an'xlink:href' attribute.
The user agent must dispatch aProgressEvent at the beginning of a load operation (i.e. just before starting to access the resource). This event is of typeloadstart.
The user agent must dispatch aProgressEvent at the end of a load operation (i.e. after load is complete and the user agent is ready to render the corresponding resource). This event is of typeloadend.
The user agent may dispatchProgressEvents between theloadstart event and theloadend events. Such events are of typeprogress.
Event types that areProgressEvents:progress,loadstart,loadend.
interface ProgressEvent : Event{readonly attribute boolean lengthComputable;readonly attribute unsigned long loaded;readonly attribute unsigned long total;};loadstartorloadend event.progress event,it should specify the total number of bytes expected.<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ev="http://www.w3.org/2001/xml-events" version="1.2" baseProfile="tiny" width="300" height="430"> <script><![CDATA[ function showImage(imageHref) { var image = document.getElementById('myImage'); image.setTraitNS("http://www.w3.org/1999/xlink", "href", imageHref); } function imageLoadStart(evt) { var progressBar = document.getElementById('progressBar'); var loadingAnimation = document.getElementById('loadingAnimation'); progressBar.setFloatTrait("width", 0); loadingAnimation.beginElement(); } function imageLoadProgress(evt) { if (evt.lengthComputable) { var progressBar = document.getElementById('progressBar'); progressBar.setFloatTrait("width", 100 * (evt.loaded / evt.total)); progressBar.setTrait("display", "inline"); } } function imageLoadComplete(evt) { var progressBar = document.getElementById('progressBar'); var loadingAnimation = document.getElementById('loadingAnimation'); progressBar.setTrait("display", "none"); loadingAnimation.endElement(); } ]]></script> <image xml:id="myImage" xlink:href="imageA.png" width="300" height="400"> <handler ev:event="loadstart"> imageLoadStart(evt); </handler> <handler ev:event="progress"> imageLoadProgress(evt); </handler> <handler ev:event="loadend"> imageLoadComplete(evt); </handler> </image> <rect rx="4" x="50" y="400" width="200" height="30" cursor="pointer"> <handler ev:event="click"> showImage('imageB.png'); </handler> </rect> <text x="150" y="420" font-size="15" fill="white" text-anchor="middle" text-decoration="underline" pointer-events="none"> Load other image </text> <g display="none"> <rect x="100" y="300" height="10" width="100" fill="black"/> <rect xml:id="progressBar" x="100" y="300" width="50" height="10" fill="lime"/> </g> <text x="150" y="330" font-size="15" text-anchor="middle" display="none"> Loading... <animate xml:id="loadingAnimation" attributeName="display" begin="indefinite" dur="2s" repeatDur="indefinite" calcMode="discrete" values="inline; none"/> </text></svg>This interface defines common methods for elements which define animation behaviors compatible with SMIL (timed elements and the'svg' element).
This interface is a subset of theElementTimeControl interface defined inSMIL Animation [SMILANIM].
Note: See theSVGTimedElement interface for pause functionality.interface ElementTimeControl{void beginElementAt(in float offset);void beginElement();void endElementAt(in float offset);void endElement();};| infloatoffset | The offset in seconds at which to begin the element. |
beginElementAt(0).| infloatoffset | The offset in seconds at which to end the element. |
endElementAt(0).TimeEvent is an interface used to provide contextual information for events fired by animations in the document. It is a subset of theTimeEvent interface defined inSMIL Animation ([SMILANIM], section 6.2).
Event that is fired by alltimed elements.
Event types that areTimeEvents:beginEvent,endEvent,repeatEvent.
interface TimeEvent : Event{readonly attribute long detail;};beginEvent andendEvent thedetail field is not used. ForrepeatEvent thedetail field contains the current repeat iteration.This interface is identical toSVGException interface defined inSVG 1.1 ([SVG11], section B.3).
exception SVGException{unsigned short code;};// ExceptionCodeconst unsigned short SVG_WRONG_TYPE_ERR = 0;const unsigned short SVG_INVALID_VALUE_ERR = 1;const unsigned short SVG_MATRIX_NOT_INVERTABLE = 2;interface SVGDocument : Document, EventTarget{};interface SVGUseElement : SVGLocatableElement{};This interface is a subset of theSVGElementInstance interface defined inSVG 1.1 ([SVG11], section 5.17).
interface SVGElementInstance : EventTarget{readonly attribute SVGElement correspondingElement;readonly attribute SVGUseElement correspondingUseElement;};correspondingElement.correspondingUseElement. In the example below, three'use' elements use the same'rect' element. Each'use' has different'fill' properties that are inherited down to the used'rect'. The result is three'rect' elements with different'fill' colors. Clicking one of these three'rect' elements will cause a fourth'rect' to change color to match the clicked one. Worth noticing is that if the original'rect' had not been in the'defs' element the script would throw an exception when the original'rect' is clicked. This is because thecurrentTarget attribute would return anSVGElement that doesn't have thecorrespondingUseElement attribute.
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ev="http://www.w3.org/2001/xml-events" version="1.2" baseProfile="tiny" width="640" height="480" viewBox="0 0 640 480"> <defs> <rect xml:id="r1" width="90" height="65"/> </defs> <use xlink:href="#r1" x="50" y="200" fill="red"/> <use xlink:href="#r1" x="250" y="200" fill="blue"/> <use xlink:href="#r1" x="450" y="200" fill="green"/> <rect xml:id="r2" x="250" y="50" width="90" height="65"/> <ev:listener observer="r1" event="ev:click" handler="#handler"/> <handler xml:id="handler" type="application/ecmascript">changeColor(evt);</handler> <script type="application/ecmascript"> var target = document.getElementById("r2"); function changeColor(evt) { var useElement = evt.currentTarget.correspondingUseElement; target.setRGBColorTrait("fill", useElement.getRGBColorTrait("fill")); } </script></svg>This interface represents the'svg' element in the SVG document tree.
The uDOM attributescurrentScale,currentRotate andcurrentTranslate are combined to form a user agent transformation which is applied at the outermost level on the SVG document (i.e. outside the'svg' element). Their values can potentially be modified through user agent specific UI, if "magnification" is enabled (i.e.,'zoomAndPan' attribute is set tomagnify). User agent transformation can be obtained by multiplying the matrix
[currentScale 0 currentTranslate.x] [cos(currentRotate) -sin(currentRotate 0] [ 0 currentScale currentTranslate.y] by [sin(currentRotate) cos(currentRotate) 0] [ 0 0 1 ] [ 0 0 1]
That is, translate, then scale, then rotate the coordinate system. The reference point for scale and rotate operations is the origin (0, 0).
interface SVGSVGElement : SVGLocatableElement, SVGTimedElement{const unsigned short NAV_AUTO = 1;const unsigned short NAV_NEXT = 2;const unsigned short NAV_PREV = 3;const unsigned short NAV_UP = 4;const unsigned short NAV_UP_RIGHT = 5;const unsigned short NAV_RIGHT = 6;const unsigned short NAV_DOWN_RIGHT = 7;const unsigned short NAV_DOWN = 8;const unsigned short NAV_DOWN_LEFT = 9;const unsigned short NAV_LEFT = 10;const unsigned short NAV_UP_LEFT = 11;attribute float currentScale;attribute float currentRotate;readonly attribute SVGPoint currentTranslate;readonly attribute SVGRect viewport;float getCurrentTime();void setCurrentTime(in float seconds);SVGMatrix createSVGMatrixComponents(in float a, in float b, in float c, in float d, in float e, in float f);SVGRect createSVGRect();SVGPoint createSVGPoint();SVGPath createSVGPath();SVGRGBColor createSVGRGBColor(in float red, in float green, in float blue) raises(SVGException);void moveFocus(in unsigned short motionType) raises(DOMException);void setFocus(in EventTarget theObject) raises(DOMException);EventTarget getCurrentFocusedObject();};currentScale is 1.currentRotate is 0.x andy components will change the useragent's translation. The initial forcurrentTranslateis anSVGPoint objectwith the value (0, 0).The position and size of theviewport (implicit or explicit) that corresponds to this'svg' element. When the user agent is actually rendering the content, then the position and size values represent the actual values when rendering.
If this SVG document is embedded as part of another document (e.g., via the HTML'object' element), then the positionand 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, as described in theCSS 2 specification.)If the parent element does not have a coordinate system, then the user agent should provide reasonable default valuesfor this attribute.
For stand-alone SVG documents, both'x' and'y' must be zero, the'width' must be the width of the viewport which the host environment provides to theSVG user agent into which it can render its content, and the'height' must be the height of the viewport, with all values expressed in the pixel coordinate system from the host environment, preferably such that this pixel coordinate system matches the same pixel coordinate system presented to HTML and matches the model for pixel coordinates described in theCSS 2 specification. Note that "pixel coordinate systems" are host-specific. Two possible approaches that hosts might use for pixel coordinate systems are actual device pixels or (particularly for high-resolution devices) pseudo device pixels which exactly match SVG and CSS's "px" coordinates.
The object itself and its contents are both readonly. ADOMException with error code NO_MODIFICATION_ALLOWED_ERRis raised if an attempt is made to modify it. The returnedSVGRect object is "live", i.e. itsx,y,width andheight attributes areautomatically updated if the viewport size or position changes.
Returns thedocument time in seconds.
IfgetCurrentTime is called before the document timeline has begun (for example, by script running in a'script' element before therootmost 'svg' element'sload event is dispatched, when'playbackOrder' is set to'onLoad'), then 0 is returned.
| float | The currentdocument time, in seconds, or 0 if the document timeline has not yet begun. |
Sets thedocument time (in seconds). This API is required to support seeking forwards and backwards in the timeline. After a seek, animation continues to play (forwards) from the new time. Ifseconds is negative, then the document will seek to time 0s.
IfsetCurrentTime is called before the document timeline has begun (for example, by script running in a'script' element before therootmost 'svg' element'sload event is dispatched, when'playbackOrder' is set to'onLoad'), then the value ofseconds in the most recent invocation of the method gives the time that the document time will be seeked to once the document timeline has begun.
| infloatseconds | Thedocument time to seek to, in seconds. |
setMatrixTrait method. The internal representation of the matrix is as follows:[ a c e ] [ b d f ] [ 0 0 1 ]
| infloata | Thea component of the matrix to be set. |
| infloatb | Theb component of the matrix to be set. |
| infloatc | Thec component of the matrix to be set. |
| infloatd | Thed component of the matrix to be set. |
| infloate | Thee component of the matrix to be set. |
| infloatf | Thef component of the matrix to be set. |
setRectTrait method. The initial values forx,y,width andheight of this newSVGRect are zero.x andy of this newSVGPoint are zero.setPathTrait method.setRGBColorTrait method. The parameters are floats, one per color component. 0.0 represents zero intensity and 255.0 represents full intensity of a given color component. Colors originally in the rgb(%,%,%) syntax may have fractional components. Out of gamut colors may have component values less than 0.0 or greater than 255.0.| infloatred | The red component of theSVGRGBColor. |
| infloatgreen | The green component of theSVGRGBColor. |
| infloatblue | The blue component of theSVGRGBColor. |
| SVGRGBColor | The createdSVGRGBColor. |
If this method succeeds:
DOMFocusOut event must be dispatched which has the previously focused object as the event target.DOMFocusIn event must dispatched which has the the new focused object as the event target.A reference to the new focused object can be obtained using theEventTarget interface of the generatedDOMFocusIn event.
Refer to thenavigation section for a description of how navigation is managed. The behavior for this method must be the same as if anequivalent move was done by the end user (for example by using a joystick or pressing the Tab key) and not by scripting.
Whenever the method fails (that is, when aDOMException is raised), focus must stay on the currently focused object and noDOMFocusOut/DOMFocusIn event is dispatched.
Note: For stand-alone SVG documents, the user agent must always have a currently focused object. At the beginning, theSVGDocument has focus.
| inshortmotionType | The type of motion. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested motion type is not supported (i.e. not one of the interface constants). | |
| DOMException | INVALID_ACCESS_ERR: Raised if the currently focused object doesn't have anavigation attribute value corresponding to the requested motion type. For instance, if a moveFocus(NAV_UP) is called on an element which has no'nav-up' attribute. | |
| DOMException | INVALID_STATE_ERR: Raised if the currently focused object has anavigation attribute value corresponding to the requested motion type but the target indicated in this attribute can not be found or is not a focusable object. For instance, if a moveFocus(NAV_UP) is called on an object which has a'nav-up' attribute but the value of this attribute references an element which is not focusable. |
If this method succeeds:
DOMFocusOut event must be dispatched which has the previously focused object as the event target.DOMFocusIn event must be dispatched which has the the new focused object as the event target.A reference to the newly focused object can be obtained using theEventTarget interface of the generatedDOMFocusIn event.
Whenever the method fails (that is, when aDOMException is raised), focus must stay on the currently focused object and noDOMFocusOut orDOMFocusIn event is dispatched.
Note: For stand-alone SVG documents, the user agent must always have a currently focused object. At the beginning, theSVGDocument has focus.
| inEventTargettheObject | The object which should receive focus. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the in parameter is not aNode orSVGElementInstance, or if the requested element is not focusable (i.e. its'focusable' attribute indicates that the element is not focusable). |
| EventTarget | object | The currently focused object. |
getRGBColorTrait) such as'fill','stroke', and'color'.interface SVGRGBColor{attribute unsigned long red;attribute unsigned long green;attribute unsigned long blue;};This interface is identical toSVGRect interface defined inSVG 1.1 ([SVG11], section 4.3).
interface SVGRect{attribute float x;attribute float y;attribute float width;attribute float height;};This interface is identical toSVGPoint interface defined inSVG 1.1 ([SVG11], section 4.3).
interface SVGPoint{attribute float x;attribute float y;SVGPoint matrixTransform(in SVGMatrix matrix);};matrixTransform.Path data created or modified using this interface must be normalized as per the rules given inPath Normalization. However, path data that is just queried need not be normalized.
interface SVGPath{const unsigned short MOVE_TO = 77;const unsigned short LINE_TO = 76;const unsigned short CURVE_TO = 67;const unsigned short QUAD_TO = 81;const unsigned short CLOSE = 90;readonly attribute unsigned long numberOfSegments;unsigned short getSegment(in unsigned long cmdIndex) raises(DOMException);float getSegmentParam(in unsigned long cmdIndex, in unsigned long paramIndex) raises(DOMException);void moveTo(in float x, in float y);void lineTo(in float x, in float y);void quadTo(in float x1, in float y1, in float x2, in float y2);void curveTo(in float x1, in float y1, in float x2, in float y2, in float x3, in float y3);void close();};| inunsigned longcmdIndex | The command index for the segment command to retrieve. |
| DOMException | INDEX_SIZE_ERR: Raised if the segment index is out of bounds. |
| inunsigned longcmdIndex | The command index for the segment command. |
| inunsigned longparamIndex | The parameter index to retrieve. |
| float | The segment parameter. |
| DOMException | INDEX_SIZE_ERR: Raised if the segment index is out of bounds, or the parameter index is out of bounds for the specified segment's type. |
| infloatx | The x-axis coordinate for the specified point. |
| infloaty | The y-axis coordinate for the specified point. |
| infloatx | The x-axis coordinate for the specified point. |
| infloaty | The y-axis coordinate for the specified point. |
| infloatx1 | The x-axis coordinate of the first control point. |
| infloaty1 | The y-axis coordinate of the first control point. |
| infloatx2 | The x-axis coordinate of the final end point. |
| infloaty2 | The y-axis coordinate of the final end point. |
| infloatx1 | The x-axis coordinate of the first control point. |
| infloaty1 | The y-axis coordinate of the first control point. |
| infloatx2 | The x-axis coordinate of the second end point. |
| infloaty2 | The y-axis coordinate of the second end point. |
| infloatx3 | The x-axis coordinate of the final end point. |
| infloaty3 | The y-axis coordinate of the final end point. |
Note: ThemTranslate,inverse,mMultiply,mScale andmRotate methods in this interface mutate theSVGMatrix object and return a reference to theSVGMatrix instance itself, after performing the necessary matrix operation.
This matrix transforms source coordinates (x, y) into destination coordinates (x', y') by considering them to be a column vector and multiplying the coordinate vector by the matrix according to the following process:
[ x' ] [ a c e ] [ x ] [ a.x + c.y + e ] [ y' ] = [ b d f ] [ y ] = [ b.x + d.y + f ] [ 1 ] [ 0 0 1 ] [ 1 ] [ 1 ]
interface SVGMatrix{float getComponent(in unsigned long index) raises(DOMException);SVGMatrix mMultiply(in SVGMatrix secondMatrix);SVGMatrix inverse() raises(SVGException);SVGMatrix mTranslate(in float x, in float y);SVGMatrix mScale(in float scaleFactor);SVGMatrix mRotate(in float angle);};getComponent(0) isa,getComponent(1) isb, etc.| inunsigned longindex | The index of the matrix component to retrieve. |
| float | The matrix component. |
| DOMException | INDEX_SIZE_ERR: Raised if the index is invalid (i.e., outside the range [0, 5]). |
| inSVGMatrixsecondMatrix | The matrix to post-multiply with. |
| SVGMatrix | The resulting current matrix. |
| SVGMatrix | The inverse of the current matrix. |
| SVGException | SVG_MATRIX_NOT_INVERTABLE: Raised when the determinant of this matrix is zero. |
mMultiply(T), whereT is anSVGMatrix object represented by the following matrix:[ 1 0 x ] [ 0 1 y ] [ 0 0 1 ]
| infloatx | The distance by which coordinates are translated in thex-axis direction. |
| infloaty | The distance by which coordinates are translated in they-axis direction. |
| SVGMatrix | The resulting current matrix. |
mMultiply(S), whereS is anSVGMatrix object represented by the following matrix:[ scaleFactor 0 0 ] [ 0 scaleFactor 0 ] [ 0 0 1 ]
| infloatscaleFactor | The factor by which coordinates are scaled along thex- andy-axis. |
| SVGMatrix | The resulting current matrix. |
mMultiply(R), whereR is anSVGMatrix object represented by the following matrix:[ cos(angle) -sin(angle) 0 ] [ sin(angle) cos(angle) 0 ] [ 0 0 1 ]
| infloatangle | The angle of rotation in degrees. |
| SVGMatrix | The resulting current matrix. |
interface SVGLocatable{SVGRect getBBox();SVGMatrix getScreenCTM();SVGRect getScreenBBox();};| SVGRect | Thebounding box. The returned object is a copy of the current bounding box value and will not change if the corresponding bounding box changes. |
clientX andclientY coordinates of aMouseEvent are in the initial viewport coordinate system. Note thatnull is returned if this element is not hooked into the document tree. This method would have been more aptly named asgetClientCTM, but the namegetScreenCTM is kept for historical reasons. Also note thatgetScreenCTM reflects a snapshot of the current animated state, i.e. if one or several transforms that affect the element thatgetScreenCTM is called upon are animated then the returned transformation matrix reflects the current state of each such animated transform when calculating the returned matrix.| SVGMatrix | The transformation matrix. The returned object is a copy of the current screen CTM value and will not change if the corresponding screen CTM changes. |
SVGLocatable::getScreenCTM method.| SVGRect | Thebounding box in screen coordinate space. The returned object is a copy of the current screen bounding box value and will not change if the corresponding screen bounding box changes. |
The following examples further clarify the behavior of thegetBBox()method. The examples have a short explanation, an SVG fragment and arefollowed by a set of bounding box values which have the followingformat:
[elementId] : {x, y, width, height} | {null}
wherex,y,width andheight define the values of theSVGRect objectsreturned from agetBBox call on the element with the specified ID.There are a few cases where the bounding box may benull (see example6).
getBBox method for various simplebasic shapes and groups. In particular, it shows that the transform, on an element, does not change the value of its userspace bounding box.<g xml:id="group1" transform="translate(10, 20)" fill="red"> <rect xml:id="rect1" transform="scale(2)" x="10" y="10" width="50" height="50"/> <rect xml:id="rect2" x="10" y="10" width="100" height="100"/> <g xml:id="group2" transform="translate(10, 20)"> <rect xml:id="rect3" x="0" y="10" width="150" height="50"/> <circle xml:id="circle1" cx="20" cy="20" r="100" /> </g></g>
Result:[group1] : {-70.0, -60.0, 230.0, 200.0}
[rect1] : {10.0, 10.0, 50.0, 50.0}
[rect2] : {10.0, 10.0, 100.0, 100.0}
[group2] : {-80.0, -80.0, 230.0, 200.0}
[rect3] : {0.0, 10.0, 150.0, 50.0}
[circle1] : {-80.0, -80.0, 200.0, 200.0}
<g xml:id="group1" transform="translate(10, 20)" fill="red"> <rect xml:id="rect2" x="10" y="10" width="400" height="0"/> <g xml:id="group2" transform="translate(10, 20)"> <rect xml:id="rect3" x="0" y="10" width="150" height="50"/> </g></g>
Result:[group1] : {10.0, 10.0, 400.0, 70.0}
[rect2] : {10.0, 10.0, 400.0, 0.0}
[group2] : {0.0, 10.0, 150.0, 50.0}
[rect3] : {0.0, 10.0, 150.0, 50.0}
<svg xml:id="mySVG" version="1.2" baseProfile="tiny" width="10" height="20"> <g xml:id="group1" transform="translate(10, 20)" fill="red"> <rect xml:id="rect1" x="10" y="10" width="100" height="100"/> <ellipse xml:id="ellipse1" cx="20" cy="20" rx="0" ry="70" /> </g></svg>
Result:[mySVG] : {20.0, -30.0, 100.0, 160.0}
[group1] : {10.0, -50.0, 100.0, 160.0}
[rect1] : {10.0, 10.0, 100.0, 100.0}
[ellipse1] : {20.0, -50.0, 0.0, 140.0}
<svg xml:id="mySVG" version="1.2" baseProfile="tiny" width="0" height="50"> <g xml:id="group1" transform="translate(10, 20)" fill="red" > <rect xml:id="rect1" x="10" y="10" width="50" height="50"/> <g xml:id="group2" transform="translate(10, 20)"> <rect xml:id="rect2" x="0" y="10" width="150" height="0"/> <circle xml:id="circle1" cx="20" cy="20" r="500"/> </g> </g></svg>
Result:[mySVG] : {-460.0, -440.0, 1000.0, 1000.0}
[group1] : {-470.0, -460.0, 1000.0, 1000.0}
[rect1] : {10.0, 10.0, 50.0, 50.0}
[group2] : {-480.0, -480.0, 1000.0, 1000.0}
[rect2] : {0.0, 10.0, 150.0, 0.0}
[circle1] : {-480.0, -480.0, 1000.0, 1000.0}
<svg version="1.2" baseProfile="tiny"> <defs> <rect xml:id="myRect" x="0" y="0" width="60" height="40"/> </defs> <use xml:id="myUse" xlink:href="#myRect" x="-30" y="-20"/></svg>
Result:[myRect] : {0.0, 0.0, 60.0, 40.0}
[myUse] : {-30.0, -20.0, 60.0, 40.0}
null. By the same token, the bounding box of a'path' with an emptySVGPath (i.e. one with no path commands, which may happen after creating a new'path' element with acreateElementNScall) is alsonull.<g xml:id="emptyG"/>
Result:[emptyG] : {null}
<g xml:id="g1"> <g xml:id="g1.1.display.none" display="none"> <rect xml:id="rect1" x="10" y="10" width="40" height="40"/> </g> <rect xml:id="rect2.visibility.hidden" visibility="hidden" x="30" y="60" width="10" height="20"/></g>
Result:[g1] : {30.0, 60.0, 10.0, 20.0}
[g1.1.display.none] : {10.0, 10.0, 40.0, 40.0}
[rect1] : {10.0, 10.0, 40.0, 40.0}
[rect2.visibility.hidden] : {30.0, 60.0, 10.0, 20.0}
<g xml:id="g1"> <line xml:id="line1" x2="100" y2="100" transform="rotate(-45)"/></g>
Result: [g1] : {0.0, 0.0, 141.42136, 0}
[line1] : {0.0, 0.0, 100.0, 100.0}
<g> <line xml:id="thickLine" stroke-width="10" x2="100" y2="0"/></g>
Result:[thickLine] : {0.0, 0.0, 100.0, 0.0}
<svg xml:id="rootSvg" version="1.2" baseProfile="tiny" width="500" height="300" viewBox="0 0 200 100"> <rect x="-100" y="-200" width="500" height="100"/></svg>
Result:[rootSVG] : {-100, -200, 500, 100}
<g xml:id="g1"> <linearGradient xml:id="MyGradient"/> <stop offset="0.05" stop-color="#F60"/> <stop offset="0.95" stop-color="#FF6"/> </linearGradient> </g>
Result:[g1] : {null}
This interface represents an element that has a physical location on the screen.
This interface is implemented by:'rect','circle','ellipse','line','path','use','image','text','textArea','tspan','svg','a','video','animation','switch','foreignObject','polygon','polyline' and'g'.
interface SVGLocatableElement : SVGElement, SVGLocatable{};Trait manipulation interface. This interface is used to read and manipulate the value of "traits" associated with anSVGElement. Eachtrait corresponds to an attribute or property, which is parsed and understood by the element and in most cases animatable. Unlike attributes, each element has a well-defined set of traits and attempting to access an unsupported trait must throw an exception. Also, unlike attributes, traits are typed and their values are normalized; for instance path data specified on a'path' element is parsed and all path commands are converted to their absolute variants, and it is not possible to determine from the value of the trait if a path command was absolute or relative. When getting and setting trait values, an accessor of the correct type must be used or an exception will be thrown.
For a trait corresponding to a property, the computed value is used: if the value of a given property is not specified on that element, then for inherited properties the value on the parent is used. For non-inherited values, or on the root element, the initial value of the property is used.
For a trait corresponding to a non-property attribute, if the attribute is inherited (such as'xml:lang') the value of the parent is used. If the attribute is not inherited, or on the root element, thelacuna value for the attribute is used, if known. If not known (for example, for an unknown attribute, or a known attribute with no specified default),null is returned.
Note that when using theTraitAccess interface for getting traits on elements outside of the tree, for example on elements just created or removed, what values are returned is user agent dependent.
The trait getter methods (getTrait,getTraitNS,getFloatTrait, etc.) return base values (i.e., before animation is applied), and this is true for both static and animated content. Note however that if the attribute isinherited from an animated parent value, it will inherit the animated value. The trait presentation value getter methods (getPresentationTrait,getPresentationTraitNS,getFloatPresentationTrait, etc.) return either the current animated value if the given trait is currently being animated or the base value if the given trait is not currently being animated. Not all attributes are accessible by traits — see thetable of supported attributes for details.
Setting a trait value has the same effect as changing a corresponding attribute, but trait setters can operate on typed values. The value which is modified is always a base value. For inheritable traits corresponding to properties, the trait value can always be set toinherit (but querying the value will always return the actual inherited value as explained above).
Note about invalid/unsupported trait values: There are two situations where the various trait setter methods (such as thesetTrait,setFloatTrait andsetPathTrait methods) consider a value invalid and throw aDOMException with the INVALID_ACCESS_ERR code. The first situation is when the trait value is invalid with regards to its definition. (For example, trying to set the'stroke-linejoin' trait to'foo' would result in this exception being thrown). The trait methods will consider the value to be invalid if it is anunsupported value. However, if the trait value being set is anIRI reference, such as when setting a<FuncIRI> value on the'fill' property or when setting the'xlink:href' attribute on an'image' element, anSVG user agent must not consider that trait value invalid if it is syntactically correct but is otherwise aninvalid IRI reference. Thus, theDOMException with code INVALID_ACCESS_ERR must not be thrown in this case. This obviates the need for anSVG user agent to fetch theIRI upon setting the trait solely to determine whether it is aninvalid IRI reference.
The second situation is when the trait value is invalidwith regards to animations currently applied to the trait. The value isconsidered invalid because it would put the animation, and therefore thedocument, in an error state. For example, if a'path' element hasanimations on its'd' attribute, trying to change the'd' attribute to avalue incompatible with the animations will cause the exception to happen.
interface TraitAccess{DOMString getTrait(in DOMString name) raises(DOMException);DOMString getTraitNS(in DOMString namespaceURI, in DOMString name) raises(DOMException);float getFloatTrait(in DOMString name) raises(DOMException);sequence<float> getFloatListTrait(in DOMString name) raises(DOMException);SVGMatrix getMatrixTrait(in DOMString name) raises(DOMException);SVGRect getRectTrait(in DOMString name) raises(DOMException);SVGPath getPathTrait(in DOMString name) raises(DOMException);SVGRGBColor getRGBColorTrait(in DOMString name) raises(DOMException);DOMString getPresentationTrait(in DOMString name) raises(DOMException);DOMString getPresentationTraitNS(in DOMString namespaceURI, in DOMString name) raises(DOMException);float getFloatPresentationTrait(in DOMString name) raises(DOMException);sequence<float> getFloatListPresentationTrait(in DOMString name) raises(DOMException);SVGMatrix getMatrixPresentationTrait(in DOMString name) raises(DOMException);SVGRect getRectPresentationTrait(in DOMString name) raises(DOMException);SVGPath getPathPresentationTrait(in DOMString name) raises(DOMException);SVGRGBColor getRGBColorPresentationTrait(in DOMString name) raises(DOMException);void setTrait(in DOMString name, in DOMString value) raises(DOMException);void setTraitNS(in DOMString namespaceURI, in DOMString name, in DOMString value) raises(DOMException);void setFloatTrait(in DOMString name, in float value) raises(DOMException);void setFloatListTrait(in DOMString name, in sequence<float> value) raises(DOMException);void setMatrixTrait(in DOMString name, in SVGMatrix matrix) raises(DOMException);void setRectTrait(in DOMString name, in SVGRect rect) raises(DOMException);void setPathTrait(in DOMString name, in SVGPath path) raises(DOMException);void setRGBColorTrait(in DOMString name, in SVGRGBColor color) raises(DOMException);};getTraitNS withnamespaceURI set tonull.| inDOMStringname | The name of the trait to retrieve. |
| DOMString | The trait value. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to aDOMString (SVG Tiny only). |
getTrait, but for namespaced traits. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringnamespaceURI | The namespace of the trait to retrieve. |
| inDOMStringname | The name of the trait to retrieve. |
| DOMString | The trait value. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to aDOMString (SVG Tiny only). |
float. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to retrieve. |
float | The trait value as afloat. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value is a non-numeric float (for example, when callinggetFloatTrait("width") on therootmost 'svg' element whose width attribute uses a percentage). |
sequence<float>. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to retrieve. |
sequence<float> | The trait value as asequence<float>. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to a sequence<float>. |
| inDOMStringname | The name of the trait to retrieve. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to anSVGMatrix. |
null. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to retrieve. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to anSVGRect. |
| inDOMStringname | The name of the trait to retrieve. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to anSVGPath. |
null.Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to retrieve. |
| SVGRGBColor | The trait value as anSVGRGBColor. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to anSVGRGBColor. |
getPresentationTraitNS withnamespaceURI set tonull.| inDOMStringname | The name of the trait to retrieve. |
| DOMString | The trait presentation value. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to aDOMString (SVG Tiny only). |
getPresentationTrait, but for namespaced traits. The parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringnamespaceURI | The namespace of the trait to retrieve. |
| inDOMStringname | The name of the trait to retrieve. |
| DOMString | The trait presentation value. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to aDOMString (SVG Tiny only). |
float. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to retrieve. |
float | The trait presentation value as afloat. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value is a non-numeric float (for example, when callinggetFloatTrait("width") on therootmost 'svg' element whose width attribute uses a percentage). |
sequence<float>. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to retrieve. |
sequence<float> | The trait presentation value as asequence<float>. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to a sequence<float>. |
| inDOMStringname | The name of the trait to retrieve. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to anSVGMatrix. |
null. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to retrieve. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to anSVGRect. |
| inDOMStringname | The name of the trait to retrieve. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to anSVGPath. |
null.Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to retrieve. |
| SVGRGBColor | The trait presentation value as anSVGRGBColor. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element or null. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if requested trait's computed value cannot be converted to anSVGRGBColor. |
setTraitNS with thenamespaceURI attribute set tonull.| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if the requested trait's value cannot be specified as aDOMString. | |
| DOMException | INVALID_ACCESS_ERR: Raised if the input value is an invalid value for the given trait or null is specified. | |
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if attempt is made to change a readonly trait. |
setTrait, but for namespaced traits. The parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringnamespaceURI | The namespace of the trait to be set. |
| inDOMStringname | The name of the trait to be set. |
| inDOMStringvalue | The value of the trait. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if the requested trait's value cannot be specified as aDOMString. | |
| DOMException | INVALID_ACCESS_ERR: Raised if the input value is an invalid value for the given trait or null is specified. | |
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if attempt is made to change a readonly trait. |
float. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to be set. |
infloatvalue | The value of the trait. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if the requested trait's value cannot be specified as a numeric float (e.g.NaN). | |
| DOMException | INVALID_ACCESS_ERR: Raised if the input value is an invalid value for the given trait or null is specified. |
sequence<float>. Parameter name must be a non-qualified trait name, i.e. without prefix.| inDOMStringname | The name of the trait to be set. |
insequence<float>value | The value of the trait. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if the requested trait's value cannot be specified as a sequence<float>). | |
| DOMException | INVALID_ACCESS_ERR: Raised if the input value is an invalid value for the given trait or null is specified. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if the requested trait's value cannot be specified as anSVGMatrix. | |
| DOMException | INVALID_ACCESS_ERR: Raised if the input value is null. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if the requested trait's value cannot be specified as anSVGRect. | |
| DOMException | INVALID_ACCESS_ERR: Raised if the input value is an invalid value for the given trait or null is specified. AnSVGRect is invalid if the width or height values are set to negative. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if the requested trait's value cannot be specified as anSVGPath. | |
| DOMException |
| inDOMStringname | The name of the trait to be set. |
| inSVGRGBColorvalue | The value of the trait. |
| DOMException | NOT_SUPPORTED_ERR: Raised if the requested trait is not supported on this element. | |
| DOMException | TYPE_MISMATCH_ERR: Raised if the requested trait's value cannot be specified as anSVGRGBColor. | |
| DOMException | INVALID_ACCESS_ERR: Raised if the input value is null. |
Trait access is not required on all of theSVG Tiny 1.2 attributes and properties. The table below showsthe attributes and properties that SVG Tiny 1.2 uDOM implementations must support trait access to.Each attribute row lists the allowed getters and setters. The "Lacuna Value" column specifies thelacuna value that must be used for each attribute or property. If a "Lacuna Value" column entry is empty, there is nolacuna value. Unless explicitly stated in the "Comments" column, a supported attribute is accessible on all elements it can belong to. See theattribute table for a list ofattributes and which elements they belong to.
Implementations that support multiple versions of SVG mustallow trait access to the most extensive set and support the typessupported by each trait in the most extensive set. However, content relying ontraits or trait types available in future versions may not work in allconformant SVG Tiny 1.2 uDOM implementations.
The user agent must raise a NOT_SUPPORTED_ERR whenever there is an attempt to use trait methods for traits which are not supported by the user agent.
For some of the attributes and data typesadditional rules apply. These rules are defined below the table.
Note: In the table below:
getTrait method, it must also support thegetTraitNS,getPresentationTrait, andgetPresentationTraitNS methods.getTraitNS method, it must also support thegetPresentationTraitNS method.getFloatTrait), it must also support the corresponding trait presentation getter method (e.g.,getFloatPresentationTrait).setTrait method, it must also support thesetTraitNS method.| Trait Target | Trait Getter [Return Value] | Trait Setter [Argument Value] | Lacuna Value | Comments |
|---|---|---|---|---|
| Element text content | getTrait("#text")[The element text content] | setTrait("#text", ...)[New element text content] | SeeText Content Access. | |
| accumulate, attribute | getTrait("accumulate")[none | sum] | setTrait("accumulate", ...)[none | sum] | "none" | |
| additive, attribute | getTrait("additive")[replace | sum] | setTrait("additive", ...)[replace | sum] | "replace" | |
| attributeName, attribute | getTrait("attributeName") | setTrait("attributeName", ...) | ||
| audio-level, property | getFloatTrait("audio-level")[0 ≤value ≤ 1] | setFloatTrait("audio-level", ...)[0 ≤value ≤ 1] setTrait("audio-level", ...)[inherit] | 1.0 | |
| baseProfile, attribute | getTrait("baseProfile") | setTrait("baseProfile", ...) | "none" | |
| begin, attribute | N/A | setTrait("begin", ...) | ||
| calcMode, attribute | getTrait("calcMode")[discrete | linear | paced | spline] | setTrait("calcMode", ...)[discrete | linear | paced | spline] | "paced" when accessed on an'animateMotion' element,"linear" otherwise | |
| color, property | getRGBColorTrait("color")[null,SVGRGBColor] | setRGBColorTrait("color, ...")setTrait("color", ...)[inherit |<color>] | rgb(0,0,0) | |
| cx, attribute | getFloatTrait("cx") | setFloatTrait("cx", ...) | 0.5 when accessed on a'radialGradient' element, 0.0 otherwise | |
| cy, attribute | getFloatTrait("cy") | setFloatTrait("cy", ...) | 0.5 when accessed on a'radialGradient' element, 0.0 otherwise | |
| d, attribute | getPathTrait("d")[SVGPath] | setPathTrait("d", ...)[SVGPath] | AnSVGPath object with no path segments | SeeAccessing rules for path attributes. |
| display, property | getTrait("display")[inline | none] | setTrait("display", ...)[inline | none | inherit] | "inline" | SeeAccessing rules for'display' property. |
| dur, attribute | N/A | setTrait("dur", ...) | ||
| editable, attribute | getTrait("editable")[simple | none] | setTrait("editable, ...)[simple | none] | "none" | |
| end, attribute | N/A | setTrait("end", ...) | ||
| fill, property | getRGBColorTrait("fill")[null,SVGRGBColor] getTrait("fill") | setRGBColorTrait("fill", ...)setTrait("fill", ...) | rgb(0,0,0) | There are no trait accessors for the animation element'fill' attribute. |
| fill-opacity, property | getFloatTrait("fill-opacity")[0 ≤value ≤ 1] | setFloatTrait("fill-opacity", ...)[0 ≤value ≤ 1] setTrait("fill-opacity", ...)[inherit] | 1.0 | |
| fill-rule, property | getTrait("fill-rule")[nonzero | evenodd] | setTrait("fill-rule", ...)[nonzero | evenodd | inherit] | "nonzero" | |
| focusable, attribute | getTrait("focusable")[true | false] | setTrait("focusable", ...)[true | false | auto] | "auto" | |
| focusHighlight, attribute | getTrait("focusHighlight")[auto | none] | setTrait("focusHighlight", ...)[auto | none] | "auto" | |
| font-family, property | getTrait("font-family") | setTrait("font-family", ...)[<font-family-value> | inherit] | User agent specific | SeeAccessing rules for font properties. |
| font-size, property | getFloatTrait("font-size")[value ≥ 0] | setFloatTrait("font-size", ...)[value ≥ 0] setTrait("font-size", ...)[xx-small | x-small | small | medium | large | x-large | xx-large | larger | smaller | inherit] | User agent specific | |
| font-style, property | getTrait("font-style")[normal | italic | oblique] | setTrait("font-style", ...)[normal | italic | oblique | inherit] | "normal" | SeeAccessing rules for font properties. |
| font-weight, property | getTrait("font-weight")[100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900] | setTrait("font-weight", ...)[normal | bold | bolder | lighter | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 | inherit] | "normal" | SeeAccessing rules for font properties. |
| from, attribute | N/A | setTrait("from", ...) | ||
| gradientUnits, attribute | getTrait("gradientUnits")[userSpaceOnUse | objectBoundingBox] | setTrait("gradientUnits", ...)[userSpaceOnUse | objectBoundingBox] | "objectBoundingBox" | |
| height, attribute | getFloatTrait("height")[value ≥ 0] getTrait("height")["auto"] | setFloatTrait("height", ...)[value ≥ 0] setTrait("height", ...)["auto"] | "auto" when accessed on a'textArea' element, 0.0 otherwise | SeeAccessing rules for'width' and'height' attributes. |
| id, attribute | getTrait("id") | setTrait("id", ...) | ||
| keyPoints, attribute | N/A | setTrait("keyPoints", ...) | ||
| keySplines, attribute | N/A | setTrait("keySplines", ...) | ||
| keyTimes, attribute | N/A | setTrait("keyTimes", ...) | ||
| max, attribute | N/A | setTrait("max", ...) | ||
| min, attribute | N/A | setTrait("min", ...) | ||
| nav-right, attribute | getTrait("nav-right")[auto | self |<FuncIRI>] | setTrait("nav-right", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-next, attribute | getTrait("nav-next")[auto | self |<FuncIRI>] | setTrait("nav-next", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-up, attribute | getTrait("nav-up")[auto | self |<FuncIRI>] | setTrait("nav-up", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-up-right, attribute | getTrait("nav-up-right")[auto | self |<FuncIRI>] | setTrait("nav-up-right", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-up-left, attribute | getTrait("nav-up-left")[auto | self |<FuncIRI>] | setTrait("nav-up-left", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-prev, attribute | getTrait("nav-prev")[auto | self |<FuncIRI>] | setTrait("nav-prev", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-down, attribute | getTrait("nav-down")[auto | self |<FuncIRI>] | setTrait("nav-down", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-down-right, attribute | getTrait("nav-down-right")[auto | self |<FuncIRI>] | setTrait("nav-down-right", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-down-left, attribute | getTrait("nav-down-left")[auto | self |<FuncIRI>] | setTrait("nav-down-left", ...)[auto | self |<FuncIRI>] | "auto" | |
| nav-left, attribute | getTrait("nav-left")[auto | self |<FuncIRI>] | setTrait("nav-left", ...)[auto | self |<FuncIRI>] | "auto" | |
| offset, attribute | getFloatTrait("offset")[0 ≤value ≤ 1] | setFloatTrait("offset", ...)[0 ≤value ≤ 1] | 0.0 | |
| opacity, property | getFloatTrait("opacity")[0 ≤value ≤ 1] | setFloatTrait("opacity", ...)[0 ≤value ≤ 1] setTrait("opacity", ...)[inherit] | 1.0 | |
| path, attribute | getPathTrait("path")[SVGPath] | setPathTrait("path", ...)[SVGPath] | AnSVGPath object with no path segments | SeeAccessing rules for path attributes. |
| points, attribute | getFloatListTrait("points") | setFloatListTrait("points", ...) | ||
| r, attribute | getFloatTrait("r")[value ≥ 0] | setFloatTrait("r", ...)[value ≥ 0] | 0.5 when accessed on a'radialGradient' element, 0.0 otherwise | |
| repeatCount, attribute | N/A | setTrait("repeatCount", ...) | ||
| repeatDur, attribute | N/A | setTrait("repeatDur", ...) | ||
| restart, attribute | getTrait("restart")[always | whenNotActive | never] | setTrait("restart", ...)[always | whenNotActive | never] | "always" | |
| rx, attribute | getFloatTrait("rx")[value ≥ 0] | setFloatTrait("rx", ...)[value ≥ 0] | 0.0 | |
| ry, attribute | getFloatTrait("ry")[value ≥ 0] | setFloatTrait("ry", ...)[value ≥ 0] | 0.0 | |
| snapshotTime, attribute | getFloatTrait("snapshotTime")[value ≥ 0] | setFloatTrait("snapshotTime", ...)[value ≥ 0] | 0.0 | |
| solid-color, property | getRGBColorTrait("solid-color")[null,SVGRGBColor] | setRGBColorTrait("solid-color", ...)setTrait("solid-color", ...)[<color> | inherit] | rgb(0,0,0) | |
| solid-opacity, property | getFloatTrait("solid-opacity")[0 ≤value ≤ 1] | setFloatTrait("solid-opacity", ...)[0 ≤value ≤ 1] setTrait("solid-opacity")[inherit] | 1.0 | |
| stop-color, property | getRGBColorTrait("stop-color")[null,SVGRGBColor] getTrait("stop-color")[none |<color>] | setRGBColorTrait("stop-color", ...)setTrait("stop-color")[none | currentColor |<color> | inherit] | rgb(0,0,0) | |
| stop-opacity, property | getFloatTrait("stop-opacity")[0 ≤value ≤ 1] | setFloatTrait("stop-opacity", ...)[0 ≤value ≤ 1] setTrait("stop-opacity", ...)[inherit] | 1.0 | |
| stroke, property | getRGBColorTrait("stroke")[null,SVGRGBColor] getTrait("stroke") | setRGBColorTrait("stroke", ...)setTrait("stroke", ...) | "none" | |
| stroke-dasharray, property | getFloatListTrait("stroke-dasharray")getTrait("stroke-dasharray")[none, inherit] | setFloatListTrait("stroke-dasharray", ...)setTrait("stroke-dasharray", ...)[none, inherit] | "none" | |
| stroke-dashoffset, property | getFloatTrait("stroke-dashoffset") | setFloatTrait("stroke-dashoffset", ...)setTrait("stroke-dashoffset", ...)[inherit] | 0.0 | |
| stroke-linecap, property | getTrait("stroke-linecap")[butt | round | square] | setTrait("stroke-linecap", ...)[butt | round | square | inherit] | "butt" | |
| stroke-linejoin, property | getTrait("stroke-linejoin")[miter | round | bevel] | setTrait("stroke-linejoin", ...)[miter | round | bevel | inherit] | "miter" | |
| stroke-miterlimit, property | getFloatTrait("stroke-miterlimit")[value ≥ 1] | setFloatTrait("stroke-miterlimit")[value ≥ 1] setTrait("stroke-miterlimit", ...)[inherit] | 4.0 | |
| stroke-opacity, property | getFloatTrait("stroke-opacity")[0 ≤value ≤ 1] | setFloatTrait("stroke-opacity", ...)[0 ≤value ≤ 1] setTrait("stroke-opacity", ...)[inherit] | 1.0 | |
| stroke-width, property | getFloatTrait("stroke-width")[value ≥ 0] | setFloatTrait("stroke-width", ...)[value ≥ 0] setTrait("stroke-width", ...)[inherit] | 1.0 | |
| target, attribute | getTrait("target") | setTrait("target", ...) | "_self" | |
| text-anchor, property | getTrait("text-anchor")[start | middle | end] | setTrait("text-anchor", ...)[start | middle | end | inherit] | "start" | |
| to, attribute | N/A | setTrait("to", ...) | ||
| transform, attribute | getMatrixTrait("transform")getTrait("transform") | setMatrixTrait("transform", ...)setTrait("transform", ...)[<transform-list> |<transform-ref> | none] | Identity matrix (1,0,0,1,0,0) | SeeAccessing rules for'transform' attribute. |
| type, attribute | getTrait("type")[translate | scale | rotate | skewX | skewY] | setTrait("type", ...)[translate | scale | rotate | skewX | skewY] | These are the trait accessors for the'type'attribute on the'animateTransform' element.There are no trait accessors for the'type' attributeon the'audio','handler','image','script' and'video' elements. | |
| values, attribute | N/A | setTrait("values", ...) | ||
| vector-effect, property | getTrait("vector-effect")[none | non-scaling-stroke] | setTrait("vector-effect", ...)[none | non-scaling-stroke | inherit] | "none" | |
| version, attribute | getTrait("version") | setTrait("version", ...) | User agent specific | |
| viewBox, attribute | getRectTrait("viewBox")[ null |SVGRect] | setRectTrait("viewBox", ...)[SVGRect] setTrait("viewBox", ...)[none] | null | If the'viewBox' attribute has the value'none',thegetRectTrait method will returnnull. |
| viewport-fill, property | getRGBColorTrait("viewport-fill")[null,SVGRGBColor] getTrait("viewport-fill")[none |<color>] | setRGBColorTrait("viewport-fill", ...)setTrait("viewport-fill", ...)[none | currentColor |<color> | inherit] | "none" | |
| viewport-fill-opacity, property | getFloatTrait("viewport-fill-opacity")[0 ≤value ≤ 1] | setFloatTrait("viewport-fill-opacity", ...)[0 ≤value ≤ 1] setTrait("viewport-fill-opacity", ...)[inherit] | 1.0 | |
| visibility, property | getTrait("visibility")[visible | hidden] | setTrait("visibility", ...)[visible | hidden | inherit] | "visible" | |
| width, attribute | getFloatTrait("width")[value ≥ 0] getTrait("width")["auto"] | setFloatTrait("width", ...)[value ≥ 0] setTrait("width", ...)["auto" ] | "auto" when accessed on a'textArea' element, 0.0 otherwise | SeeAccessing rules for'width' and'height' attributes. |
| x, attribute | getFloatTrait("x")getFloatListTrait("x") | setFloatTrait("x", ...)setFloatListTrait("x", ...) | 0.0 | SeeAccessing rules for'x' and'y' attributes. |
| x1, attribute | getFloatTrait("x1") | setFloatTrait("x1", ...) | 0.0 | |
| x2, attribute | getFloatTrait("x2") | setFloatTrait("x2", ...) | 1.0 when accessed on a'linearGradient' element, 0.0 otherwise | |
| xlink:href, attribute | getTraitNS("http://www.w3.org/1999/xlink", "href")[absolute IRI] | setTraitNS("http://www.w3.org/1999/xlink", "href", ...) | "" | |
| y, attribute | getFloatTrait("y")getFloatListTrait("y") | setFloatTrait("y", ...)setFloatListTrait("y", ...) | 0.0 | SeeAccessing rules for'x' and'y' attributes. |
| y1, attribute | getFloatTrait("y1") | setFloatTrait("y1", ...) | 0.0 | |
| y2, attribute | getFloatTrait("y2") | setFloatTrait("y2", ...) | 0.0 | |
| zoomAndPan, attribute | getTrait("zoomAndPan")[disable | magnify] | setTrait("zoomAndPan", ...)[disable | magnify] | "magnify" |
The'transform' attribute in SVG Tiny 1.2 can have three types of values.The "normal" transformation list (e.g. scale, translate, rotate, matrix, etc.),the newly introduced'ref(svg)' type or'none'.getMatrixTrait returns the current evaluated matrix inall cases. If the user needs to know that the'transform' attribute value was a'ref' or a'none',getTrait must be used. By usingsetTrait the user can set the'transform' attribute to'ref(svg)' or'none'.
Due to backward compatibility reasons the'display' values accessible via the trait mechanism are limited to'none' and'inline', all other values are translated into'none' or'inline'. (For a list of all possible'display' values, seeControlling visibility.) If other'display' values are of interest, e.g. the user want to set display to'block', the more genericgetAttributeNS/setAttributeNS must be used. Note however that an SVG Tiny 1.2 user agent is allowed to normalize its attribute data as described inDisplay normalization.
The following rule applies to SMIL animation elements ('animate','animateTransform','animateColor','animateMotion','set','discard').
These elements can be inserted and removed from the tree but they cannot be modified using theTraitAccess methods once inserted into the tree. If an attempt is made to do so, theTraitAccess method will throw aDOMException with code NOT_SUPPORTED_ERR. Modifying the element using thesetAttribute andsetAttributeNS methods of theElement interface will change the document, but will have no effect on the animation.
This restriction means that if the author wishes to add animations via script, the attributes of the animation elements must be modified before being inserted into the tree. The following is an example of adding an animation to the document, setting the relevant attributes prior to insertion.
<svg version="1.2" baseProfile="tiny" xmlns="http://www.w3.org/2000/svg" xml:id="svg-root" width="100%" height="100%" viewBox="0 0 480 360"> <rect xml:id="myRect" fill="green" x="10" y="10" width="200" height="100" stroke="black" stroke-width="2"/></svg>
SVGElement newAnimate = (SVGElement)document.createElementNS(svgNS, "animate");newAnimate.setTrait("attributeName", "fill");newAnimate.setTrait("from", "red");newAnimate.setTrait("to", "blue");newAnimate.setTrait("dur", "5");newAnimate.setTrait("repeatCount", "10");Element myRect = document.getElementById("myRect");myRect.appendChild(newAnimate); IfgetFloatTrait is used to retrieve the value of the'x' or'y' attribute on a'text' element, where the attribute value has more than one<coordinate>, aDOMException with error code TYPE_MISMATCH_ERR must be raised. When the attribute value has only one coordinate, this is the value returned bygetFloatTrait.
IfgetFloatListTrait orsetFloatListTrait are used on elements other than a'text' element, aDOMException with error code TYPE_MISMATCH_ERR must be raised.
IfgetFloatTrait is used to retrieve the value of the'width' or'height' attribute on an'svg' element, where the value is specified as a percentage or unit value, aDOMException with error code TYPE_MISMATCH_ERR must be raised.
If trait accessors are used to get or set the'font-family','font-style' or'font-weight' properties on a'font-face' element, aDOMException with error code NOT_SUPPORTED_ERR must be raised.
If the getPathTrait method is used to get anSVGPath and the path attribute was syntactically invalid at some point, the return value must be an SVGPath containing all valid path segments until the point of the error.
The following rule applies to multimedia elements ('audio','video','animation').
SVG timing attributes cannot be modified using theTraitAccess methods once inserted into the tree. If an attempt is made to do so, theTraitAccess method will throw aDOMException with code NOT_SUPPORTED_ERR. Modifying these attributes using thesetAttribute andsetAttributeNS methods of theElement interface will change the document, but will have no effect on the element.
This interface represents anSVG element in the document tree.It provides methods to traverse elements in the uDOM tree and allows setting and getting the'id' of an element.
Note: See thedefinition of'id' and'xml:id' for the rules of how to treat'id' and'xml:id'.
interface SVGElement : Element, EventTarget, TraitAccess{attribute DOMString id;};On read, returns the element's'xml:id' or'id' attribute according to the rules defined in theStructure chapter, ornull if no ID specified.
On write, sets the element's'xml:id' or'id' attributes according to the rules defined in theStructure chapter.
interface SVGTimedElement : SVGElement, smil::ElementTimeControl{void pauseElement();void resumeElement();readonly attribute boolean isPaused;};true if thetimed element is paused.false otherwise. SeePaused element and the active duration ([SMIL21], section 10.4.3). Note that an element that is stopped (has reached the end of its active duration) is not paused.This interface is implemented by the following SMIL animation elements:'animate','animateTransform','animateColor','animateMotion' and'set'. It is included for historical reasons and has been deprecated. Note that this interface is unrelated to the new'animation' element.
interface SVGAnimationElement : SVGTimedElement{};interface SVGVisualMediaElement : SVGLocatableElement, SVGTimedElement{};TheSVGTimer interface provides an API for scheduling a one time or repetitive event. ASVGTimer object is always either in the running (attributerunning istrue) or waiting (attributerunning isfalse) state. After each interval of the timer, anEvent of typeSVGTimer is triggered.
SVGTimer events are triggered only when thetimer is in therunning state. TheSVGTimer event is limited to the target phase. SinceSVGTimer is anEventTarget,EventListeners can be registered on it usingaddEventListener withSVGTimer as the event type. Event listeners can access their corresponding SVGTimer object through the event object's target property.
SVGTimer instances are created using thecreateTimer method of theSVGGlobal interface.
interface SVGTimer : events::EventTarget{attribute long delay;attribute long repeatInterval;readonly attribute boolean running;void start();void stop();};This attribute specifies the time remaining in milliseconds until the next event is fired. When theSVGTimer is in therunning state this attribute is dynamically updated to reflect the remaining time in the current interval. When theSVGTimer iswaiting the delay reflects the time that remained when stopped. Getting the delay attribute returns the current value, i.e. a snapshot value of the remaining delay. After delay period has passed while the object is in therunning state, theSVGTimer object will trigger anEvent of typeSVGTimer. The delay will then be updated with therepeatInterval value and a new count down will start. Setting the delay resets the current interval to the new value. If this attribute is0, it means that the event will be triggered as soon as possible. Assigning a negative value is equivalent to calling thestop() method. The initial value is set through the initialInterval parameter in thecreateTimer method on theSVGGlobal interface, and defines the first interval of theSVGTimer.
This attribute specifies in milliseconds the interval for each repeat of theSVGTimer, i.e. each timer interval subsequent to the initial interval. The initial value of this attribute is set through therepeatInterval parameter in thecreateTimer method on theSVGGlobal interface. Assigning a negative value disables the repetitive triggering of the event making it a one time timer which triggers an event after thedelay.
SVGTimer state. Value istrue if the timer is running,false if the timer is waiting. Note that therepeatInterval anddelay properties can be non-negative if the timer is stopped (but ifdelay is negative, the timer is stopped).
Changes theSVGTimer state intorunning. If the timer is already in the running state, it has no effect. Initially the timer iswaiting, and must be started with this method. If the timerdelay had a negative value when started, for example if the time had been stopped by setting the delay to a negative value, the delay value is reset torepeatInterval when the this method is called.
Many scripted SVG documents in existence make use of functions on a browser specific Window interface. SVG Tiny 1.2 specifies anSVGGlobal interface, on which some of these de facto standard functions are defined, as well as some functions for new features defines in this specification. TheSVGGlobal interface must be implemented by the object that represents thedefault view of the document ([DOM2VIEWS], section 1.1). This object also implementsAbstractView. Thus, in the ECMAScript language binding, the global script object implementsSVGGlobal. TheSVGGlobal object for a document can also be obtained throughDocumentView::defaultView.
interface SVGGlobal{SVGTimer createTimer(in long initialInterval, in long repeatInterval);void getURL(in DOMString iri, in AsyncStatusCallback callback);void postURL(in DOMString iri, in DOMString data, in AsyncStatusCallback callback, in DOMString type, in DOMString encoding);Node parseXML(in DOMString data, in Document contextDoc);};SVGTimer will initially be in thewaiting state.| inlonginitialInterval | Specifies the first interval in milliseconds for a repetitiveSVGTimer, i.e. sets the initial value of thedelay attribute on the timer. In the case theSVGTimer is not repetitive, it specifies the interval for the one time timer. Setting this parameter with a negative value will create anSVGTimer which is in the waiting state. |
| inlongrepeatInterval | Specifies the time interval on which theSVGTimer repeats subsequent to the initial interval. A negative value will make theSVGTimer a one time timer. |
Given anIRI and anAsyncStatusCallback object on which to call a callback function, this method will attempt to fetch the resource at that IRI. If the IRI uses the HTTP or HTTPS scheme, the HTTP GET method will be used. Implementations may support other schemes, but are not required to.
This method call must take place asynchronously. When called, control returns immediately to the calling context, and once the request is completed the callback is called. Multiple calls to this method must be executed in FIFO order.
User agents are required to support the gzip content coding for HTTP requests and must decode such content before passing it on to the callback. User agents are not required to support gzip encoding content that they send, though they are encouraged to. Cookies should be supported so that state can be maintained across requests. User agents may provide the user with means to interact with the request (e.g. to enter authentication information) but are not required to.
It is important to note that for security reasons, user agents are strongly encouraged to restrict these requests by origin. When enforcing such restrictions, the callback is called immediately with itsAsyncURLStatus object'ssuccess field set tofalse and other fields set tonull. Redirection responses (3xx HTTP status codes) must not be exposed through the API but rather they must be processed internally according to the HTTP specification.
| inDOMStringiri | TheIRI of the resource that is being requested. |
| inAsyncStatusCallbackcallback | The object on which the callback will be called upon completion of the request. |
Given anIRI, data to be transmitted, anAsyncStatusCallback object on which to call a callback function, a media type, and a content coding, this method will post the data to the specified IRI using the requested media type and content coding. User agents must supportpostURL being invoked with an HTTP or HTTPS IRI, but may support other IRI schemes if they indicate protocols that are functionally compatible with HTTP. Once the request has been completed the callback is invoked as described in theAsyncStatusCallback interface. IfpostURL is invoked with an IRI that does not support posting content, or which does not post content in a manner compatible with HTTP, aDOMException with code NOT_SUPPORTED_ERR must be thrown.
Processing requirements are the same as forgetURL, with the following notes and additions.
text/plain.identity.| inDOMStringiri | TheIRI of the resource that is being requested. |
| inDOMStringdata | The data that will be the body of the POST request. |
| inAsyncStatusCallbackcallback | The object on which the callback will be called upon completion of the request. |
| inDOMStringtype | The content type of the POST request. |
| inDOMStringencoding | The encoding of the POST request. |
Given a string and aDocument object, parse the string as an XML document and return aNode representing it. If the XML in the string is not well-formed according to eitherXML 1.0 orXML 1.1 or not namespace-well-formed according toNamespaces in XML 1.0 orNamespaces in XML 1.1 respectively, this method must return anull value.
When parsing the input string, thecontextDoc parameter is used only for setting theownerDocument field in the parsed nodes.
If during parsing a'script' element is encountered, it must not be executed at that time. It will only be executed if it inserted into the current SVG document.
There is no requirement to load any external resources, e.g. external entities, stylesheets, scripts, raster images, video, audio, etc., for the parsing to complete. XSL stylesheets must not be applied.
If thecontextDoc parameter is defined, this method returns anElement object theownerDocument field of which must be set to be the providedDocument object. In effect when thecontextDoc parameter is specified the processing must be equivalent to applying the following steps:
documentElement elementimportNode on theDocument object passed toparseXML with theElement from the previous step as its first parameter and thedeep parameter set totrue. (Please note thatimportNode is part of DOM 3 Core but not of the uDOM. It is mentioned here to indicate that the effect must be as ifimportNode had been used, but not to require that it be supported in implementations.)| inDOMStringdata | The data that is to be parsed as XML. |
| inDocumentcontextDoc | TheDocument object in the context of which to perform the parsing. |
| DOMException | INVALID_CHARACTER_ERR: Raised if one of the parsed XML names is not an XML name according to the XML version of thecontextDoc document. |
This interface is implemented by code that intends to process content retrieved throughgetURL orpostURL, both of which take an instance of this interface as a parameter. TheoperationComplete method of the object implementing this interface is called upon completion of the request.
interface AsyncStatusCallback{void operationComplete(in AsyncURLStatus status);}; This method is implemented by code in order to be notified of the result of fetching a resource usinggetURL orpostURL. Upon completion of the request, the method is called with anAsyncURLStatus object that holds the resource contents and information about the request.
| inAsyncURLStatusstatus | An object representing the HTTP response. |
This interface captures several aspects of an HTTP response in order to be passed to theoperationComplete method upon completion of an HTTP request.
interface AsyncURLStatus{readonly attribute boolean success;readonly attribute DOMString contentType;readonly attribute DOMString content;};A boolean field indicating whether the request succeeded or not.
For HTTP requests with response status codes in the 200 range, this attribute must be set to true, and for status codes in the 400 and 500 ranges it must be set to false. Status codes in the 100 range must be ignored and those in the 300 range must be processed as indicated ingetURL's processing requirements.
When fetching non-HTTP resources, this attribute must be set to true if the resource was successfully retrieved in full, and false otherwise.
A string containing the media type of the response.
For HTTP requests, this attribute must be set to the value of the Content-Type HTTP header. If there was no Content-Type header, the attribute must be set tonull.
When fetching non-HTTP resources, this attribute must be set tonull.
A string containing the contents of the fetched resource.
If the resource is not a valid sequence of characters (as interpreted according to the media type and other headers for an HTTP request, or as appropriate for non-HTTP resources), then this attribute must be set to null.
For HTTP requests, if the media type of the response body was in thetext/* hierarchy and specified a charset parameter, then the text must be converted into the host programming language's native form if the encoding is supported. If the encoding is not supported, the value of this field must benull. The only required encodings are UTF-8 and UTF-16 (BE and LE). If the HTTP response body had one or more content codings applied to it then it must be fully decoded before setting this field. If the HTTP response status code was an error code but carried a body, the content of that body must still be exposed.
TheEventListenerInitializer2 interface is used to provide a way for scripts written in languages that do not have a concept of a "global object" to initialize their event listeners. Specifically, it is used for Java event listeners, but this general approach is suggested for other such scripting languages. See the description of the'script' element for details on how the object implementingEventListenerInitializer2 is discovered and used.
interface EventListenerInitializer2{void initializeEventListeners(in Element scriptElement);EventListener createEventListener(in Element handlerElement);};Invoked to indicate that the script given by the specified'script' element should be executed.
| inElementscriptElement | The'script' element that identifies the script to execute. |
Invoked to obtain anEventListener that corresponds to the specified'handler' element.
| inElementhandlerElement | The'handler' element for which a correspondingEventListener is to be returned. |
| EventListener | TheEventListener. |