first

Daisy Diff compare report. Click on the changed parts for a detailed description. Use the left and right arrow keys to walk through the modifications.

last

5.8 Conditional processing

5.8.1 Conditional processing overview

SVG contains a 'switch' element along with attributes 'requiredFeatures', 'requiredExtensions' and 'systemLanguage' to provide an ability to specify alternate viewing depending on the capabilities of a given user agent or the user's language.

<!ENTITY % SVG.Conditional.extra.attrib "" >
<!ENTITY % SVG.Conditional.attrib
    "requiredFeatures %FeatureList.datatype; #IMPLIED
     requiredExtensions %ExtensionList.datatype; #IMPLIED
     systemLanguage %LanguageCodes.datatype; #IMPLIED
     %SVG.Conditional.extra.attrib;"
>

Attributes requiredFeatures, requiredExtensions and systemLanguage Attributes 'requiredFeatures', 'requiredExtensions' and 'systemLanguage' act as tests and return either true or false results. The 'switch' renders the first of its children for which all of these attributes test true. If the given attribute is not specified, then a true value is assumed.

Similar to the 'display' property, conditional processing attributes only affect the direct rendering of elements and do not prevent elements from being successfully referenced by other elements (such as via a 'use').

In consequence:

• 'requiredFeatures', 'requiredExtensions' and 'systemLanguage' attributes affect 'a', 'altGlyph', 'foreignObject', 'textPath', 'tref', and 'tspan' elements.
• 'requiredFeatures', 'requiredExtensions' and 'systemLanguage' attributes will have no effect on 'mask', 'clipPath', and 'pattern' elements.
• 'requiredFeatures', 'requiredExtensions' and 'systemLanguage' attributes do not apply to the 'defs', and 'cursor' elements because they are not part of the rendering tree.
• 'requiredFeatures', 'requiredExtensions' and 'systemLanguage' attributes affect 'animate', 'animateColor', 'animateMotion', 'animateTransform', and 'set' elements. If the conditional statement on these animation elements fails, the animation will never be triggered.

5.8.2 The 'switch' element

The 'switch' element evaluates the 'requiredFeatures', 'requiredExtensions' and 'systemLanguage' attributes on its direct child elements in order, and then processes and renders the first child for which these attributes evaluate to true. All others will be bypassed and therefore not rendered. If the child element is a container element such as a 'g', then the entire subtree is either processed/rendered or bypassed/not rendered.

Note that the values of properties 'display' and 'visibility' have no effect on 'switch' element processing. In particular, setting 'display' to none on a child of a 'switch' element has no effect on true/false testing associated with 'switch' element processing.

<!ENTITY % SVG.switch.extra.content "" >
<!ENTITY % SVG.switch.element "INCLUDE" >
<![%SVG.switch.element;[
<!ENTITY % SVG.switch.content
    "(( %SVG.Description.class; )*, ( %SVG.svg.qname; | %SVG.g.qname;
      | %SVG.use.qname; | %SVG.text.qname; | %SVG.Animation.class;
        %SVG.Conditional.class; %SVG.Image.class; %SVG.Shape.class;
        %SVG.Hyperlink.class; %SVG.Extensibility.class;
        %SVG.switch.extra.content; )*)"
>
<!ELEMENT %SVG.switch.qname; %SVG.switch.content; >
<!-- end of SVG.switch.element -->]]>
<!ENTITY % SVG.switch.attlist "INCLUDE" >
<![%SVG.switch.attlist;[
<!ATTLIST %SVG.switch.qname;
    %SVG.Core.attrib;
    %SVG.Conditional.attrib;
    %SVG.Style.attrib;
    %SVG.Presentation.attrib;
    %SVG.GraphicalEvents.attrib;
    %SVG.External.attrib;
    transform %TransformList.datatype; #IMPLIED
>

For more information and an example, see Embedding foreign object types.

5.8.3 The 'requiredFeatures' attribute

If the attribute is not present, then its implicit return value is "true". If a null string or empty string value is given to attribute 'requiredFeatures', the attribute returns "false".

'requiredFeatures' is often used in conjunction with the 'switch' element. If the 'requiredFeatures' is used in other situations, then it represents a simple switch on the given element whether to render the element or not.

5.8.4 The 'requiredExtensions' attribute

The 'requiredExtensions' attribute defines a list of required language extensions. Language extensions are capabilities within a user agent that go beyond the feature set defined in this specification. Each extension is identified by a URI reference.

If a given URI reference contains white space within itself, that white space must be escaped.

If the attribute is not present, then its implicit return value is "true". If a null string or empty string value is given to attribute 'requiredExtensions', the attribute returns "false".

'requiredExtensions' is often used in conjunction with the 'switch' element. If the 'requiredExtensions' is used in other situations, then it represents a simple switch on the given element whether to render the element or not.

The URI names for the extension should include versioning information, such as "http://example.org/SVGExtensionXYZ/1.0", so that script writers can distinguish between different versions of a given extension.

5.8.5 The 'systemLanguage' attribute

The attribute value is a comma-separated list of language names as defined in Tags for the Identification of Languages [RFC3066].

Evaluates to "true" if one of the languages indicated by user preferences exactly equals one of the languages given in the value of this parameter, or if one of the languages indicated by user preferences exactly equals a prefix of one of the languages given in the value of this parameter such that the first tag character following the prefix is "-".

Evaluates to "false" otherwise.

Note: This use of a prefix matching rule does not imply that language tags are assigned to languages in such a way that it is always true that if a user understands a language with a certain tag, then this user will also understand all languages with tags for which this tag is a prefix.

The prefix rule simply allows the use of prefix tags if this is the case.

Implementation note: When making the choice of linguistic preference available to the user, implementers should take into account the fact that users are not familiar with the details of language matching as described above, and should provide appropriate guidance. As an example, users may assume that on selecting "en-gb", they will be served any kind of English document if British English is not available. The user interface for setting user preferences should guide the user to add "en" to get the best matching behavior.

Multiple languages MAY be listed for content that is intended for multiple audiences. For example, content that is presented simultaneously in the original Maori and English versions, would call for:

However, just because multiple languages are present within the object on which the 'systemLanguage' test attribute is placed, this does not mean that it is intended for multiple linguistic audiences. An example would be a beginner's language primer, such as "A First Lesson in Latin," which is clearly intended to be used by an English-literate audience. In this case, the 'systemLanguage' test attribute should only include "en".

Authoring note: Authors should realize that if several alternative language objects are enclosed in a 'switch', and none of them matches, this may lead to situations where no content is displayed. It is thus recommended to include a "catch-all" choice at the end of such a 'switch' which is acceptable in all cases.

For the 'systemLanguage' attribute: Animatable: no.

If the attribute is not present, then its implicit return value is "true". If a null string or empty string value is given to attribute 'systemLanguage', the attribute returns "false".

'systemLanguage' is often used in conjunction with the 'switch' element. If the 'systemLanguage' is used in other situations, then it represents a simple switch on the given element whether to render the element or not.

5.8.6 Applicability of

test attributes

The following list describes the applicability of the test attributes to the elements that do not directly produce rendering.

• the test attributes do not effect the 'mask', 'clipPath', 'gradientlinearGradient', 'radialGradient' and 'pattern' elements. The test attributes on a referenced element do not affect the rendering of the referencing element.
• the test attributes do not effect the 'defs', and 'cursor' elements as they are not part of the rendering tree.
• an animation element ('animate', 'animateMotion', 'animateTransform', 'animateColor' and 'set') will never be triggered if it has a test attribute that evaluates to false.

5.9 Specifying whether external resources are required for proper rendering

Documents often reference and use the contents of other files (and other Web resources) as part of their rendering. In some cases, authors want to specify that particular resources are required for a document to be considered correct.

Attribute 'externalResourcesRequired' is available on all container elements and to all elements which potentially can reference external resources. It specifies whether referenced resources that are not part of the current document are required for proper rendering of the given container element or graphics element.

This attribute applies to all types of resource references, including style sheets, color profiles (see Color profile descriptions) and fonts specified by a URI reference using a 'font-face' element or a CSS @font-face specification. In particular, if an element sets externalResourcesRequired="true", then all style sheets must be available since any style sheet might affect the rendering of that element.

Attribute 'externalResourcesRequired' is not inheritable (from a sense of attribute value inheritance), but if set on a container element, its value will apply to all elements within the container.

Because setting externalResourcesRequired="true" on a container element can have the effect of disabling progressive display of the contents of that container, tools that generate SVG content are cautioned against using simply setting externalResourcesRequired="true" on the outermost 'svg' element on a universal basis. Instead, it is better to specify externalResourcesRequired="true" on those particular graphics elements or container elements which specify need the availability of external resources in order to render properly.

For 'externalResourcesRequired': Animatable: no.

5.10 Common attributes

5.10.1 Attributes common to all elements: 'id' and 'xml:base'

The 'id' and 'xml:base' attributes are available on all SVG elements:

5.10.2 The 'xml:lang' and 'xml:space' attributes

<!ENTITY % SVG.id.attrib
    "id ID #IMPLIED"
>
<!ENTITY % SVG.base.attrib
    "xml:base %URI.datatype; #IMPLIED"
>
<!ENTITY % SVG.lang.attrib
    "xml:lang %LanguageCode.datatype; #IMPLIED"
>
<!ENTITY % SVG.space.attrib
    "xml:space ( default | preserve ) #IMPLIED"
>
<!ENTITY % SVG.Core.extra.attrib "" >
<!ENTITY % SVG.Core.attrib
    "%SVG.id.attrib;
     %SVG.base.attrib;
     %SVG.lang.attrib;
     %SVG.space.attrib;
     %SVG.Core.extra.attrib;"
>

5.11

The Core Attribute Module defines the attribute set Core.attrib that is the core set of attributes that can be present on any element.

The Structure Module defines the Description.class, Structure.class and Use.class content sets.

The Basic Structure Module defines the Description.class, Structure.class and Use.class content sets.

The Container Attribute Module defines the Container.attrib attribute set.

The Conditional Processing Module defines the Conditional.class content set.

The Conditional Processing Module defines the Conditional.attrib attribute set.

The Image Module defines the Image.class content set.

The following interfaces are defined below: SVGDocument, SVGSVGElement, SVGGElement, SVGDefsElement, SVGDescElement, SVGTitleElement, SVGSymbolElement, SVGUseElement, SVGElementInstance, SVGElementInstanceList, SVGImageElement, SVGSwitchElement, GetSVGDocument.

DOM interfaces

5.11.1 Interface SVGDocument

When an 'svg' element is embedded inline as a component of a document from another namespace, such as when an 'svg' element is embedded inline within an XHTML document [XHTML], then an SVGDocument object will not exist; instead, the root object in the document object hierarchy will be a Document object of a different type, such as an HTMLDocument object.

However, an SVGDocument object will indeed exist when the root element of the XML document hierarchy is an 'svg' element, such as when viewing a stand-alone SVG file (i.e., a file with MIME type "image/svg+xml"). In this case, the SVGDocument object will be the root object of the document object model hierarchy.

In the case where an SVG document is embedded by reference, such as when an XHTML document has an 'object' element whose 'href' attribute references an SVG document (i.e., a document whose MIME type is "image/svg+xml" and whose root element is thus an 'svg' element), there will exist two distinct DOM hierarchies. The first DOM hierarchy will be for the referencing document (e.g., an XHTML document). The second DOM hierarchy will be for the referenced SVG document. In this second DOM hierarchy, the root object of the document object model hierarchy is an SVGDocument object.

The SVGDocument interface contains a similar list of attributes and methods to the HTMLDocument interface described in the Document Object Model (HTML) Level 1 chapter of the [DOM1] specification.

interface SVGDocument : Document,
                

DocumentEvent {
  

readonly attribute DOMString 

title;
  readonly attribute DOMString 

referrer;
  readonly attribute DOMString 

domain;
  readonly attribute DOMString 

URL;
  readonly attribute SVGSVGElement rootElement;
};

Attributes:

title (readonly DOMString

)

The title of a document as specified by the 'title' sub-element of the 'svg' root element (i.e., <svg><title>Here is the title</title>...</svg>)

referrer (readonly DOMString

)

Returns the URI of the page that linked to this page. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, via a bookmark).

domain (readonly DOMString

)

The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.

URL (readonly DOMString

)

The complete URI of the document.

rootElement (readonly SVGSVGElement

)

The root 'svg'

in the document hierarchy.

5.11.2 Interface SVGSVGElement

A key interface definition is the SVGSVGElement interface, which is the interface that corresponds to the 'svg' element. This interface contains various miscellaneous commonly-used utility methods, such as matrix operations and the ability to control the time of redraw on visual rendering devices.

SVGSVGElement extends ViewCSS and DocumentCSS to provide access to the computed values of properties and the override style sheet as described in DOM2.

DOM Level 2 Style [DOM2STYLE].

interface SVGSVGElement : SVGElement,
                

          SVGTests,
      

                    SVGLangSpace,
                

          SVGExternalResourcesRequired,
      

   SVGStylable,
                

          SVGLocatable,
      

   SVGFitToViewBox,
                

          SVGZoomAndPan,
      

  EventTarget,
 

    DocumentEvent,
       

         ViewCSS,
              

        DocumentCSS {

 

readonly attribute SVGAnimatedLength x;
  readonly attribute SVGAnimatedLength 

y;
  readonly attribute SVGAnimatedLength width;
  readonly attribute SVGAnimatedLength height;
           

attribute 

DOMString contentScriptType setraises(DOMException);

     attribute DOMString contentStyleType setraises(DOMException);
  readonly attribute SVGRect viewport;
  readonly attribute float pixelUnitToMillimeterX;
  readonly attribute float pixelUnitToMillimeterY;
  readonly attribute float screenPixelToMillimeterX;
  readonly attribute float screenPixelToMillimeterY;
           attribute boolean useCurrentView

 setraises(DOMException);
  readonly attribute SVGViewSpec currentView;
           attribute float currentScale

 setraises(DOMException);
  readonly attribute SVGPoint currentTranslate;

  unsigned long suspendRedraw

(

in unsigned long max_wait_milliseconds

);
  void 

unsuspendRedraw

(

in unsigned long suspend_handle_id

) 

raises(

DOMException

);
  void 

unsuspendRedrawAll

(

);
  void 

forceRedraw

(

);
  void 

pauseAnimations

(

);
  void 

unpauseAnimations

(

);
  boolean 

animationsPaused

(

);
  float 

getCurrentTime

(

);
  void 

setCurrentTime

(

in float seconds

);
  NodeList 

getIntersectionList

(

in SVGRect rect, in SVGElement referenceElement

);
  NodeList 

getEnclosureList

(

in SVGRect rect, in SVGElement referenceElement

);
  boolean 

checkIntersection

(

in SVGElement element, in SVGRect rect

);
  boolean 

checkEnclosure

(

in SVGElement element, in SVGRect rect

);
  void 

deselectAll

(

);
  SVGNumber 

createSVGNumber

(

);
  SVGLength 

createSVGLength

(

);
  SVGAngle 

createSVGAngle

(

);
  SVGPoint 

createSVGPoint

(

);
  SVGMatrix 

createSVGMatrix

(

);
  SVGRect 

createSVGRect

(

);
  SVGTransform 

createSVGTransform

(

);
  SVGTransform 

createSVGTransformFromMatrix

(

in SVGMatrix matrix

);
  Element 

getElementById

(

in DOMString elementId

);
};

Attributes:

x (readonly SVGAnimatedLength

)

Corresponds to attribute 'x' on the given 'svg' element.

y (readonly SVGAnimatedLength

)

Corresponds to attribute 'y' on the given 'svg' element.

width (readonly SVGAnimatedLength

)

Corresponds to attribute 'width' on the given 'svg' element.

height (readonly SVGAnimatedLength

)

Corresponds to attribute 'height' on the given 'svg' element.

contentScriptType (DOMString

)

Corresponds to attribute 'contentScriptType' on the given 'svg' element.

Exceptions on setting

DOMException

, code NOT_

SUPPORTED_

ERR

Raised on an attempt to change the value of a readonly attribute.

contentStyleType (DOMString

)

Corresponds to attribute 'contentStyleType' on the given 'svg' element.

Exceptions on setting

DOMException

, code NOT_

SUPPORTED_

ERR

Raised on an attempt to change the value of a readonly attribute.

viewport (readonly SVGRect

)

The position and size of the viewport (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. The position and size values are unitless values in the coordinate system of the parent element. If no parent element exists (i.e., 'svg' element represents the root of the document tree), if this SVG document is embedded as part of another document (e.g., via the HTML 'object' element), then the position and size are unitless values in the coordinate system of the parent document. (If the parent uses CSS or XSL layout, then unitless values represent pixel units for the current CSS or XSL viewport, as described in the

CSS 2 specification.) If the parent element does not have a coordinate system, then the user agent should provide reasonable default values for this attribute.

The object itself and its contents are both readonly.

pixelUnitToMillimeterX (readonly float

)

Size of a pixel units (as defined by

CSS 2) along the x-axis of the viewport, which represents a unit somewhere in the range of 70dpi to 120dpi, and, on systems that support this, might actually match the characteristics of the target medium. On systems where it is impossible to know the size of a pixel, a suitable default pixel size is provided.

pixelUnitToMillimeterY (readonly float

)

Corresponding size of a pixel unit along the y-axis of the viewport.

screenPixelToMillimeterX (readonly float

)

User interface (UI) events in DOM Level 2 indicate the screen positions at which the given UI event occurred. When the user agent actually knows the physical size of a "screen unit", this attribute will express that information; otherwise, user agents will provide a suitable default value such as .28mm.

screenPixelToMillimeterY (readonly float

)

Corresponding size of a screen pixel along the y-axis of the viewport.

useCurrentView (boolean

)

The initial view (i.e., before magnification and panning) of the current innermost SVG document fragment can be either the "standard" view (i.e., based on attributes on the 'svg' element such as

'viewBox') or to a "custom" view (i.e., a hyperlink into a particular 'view' or other element - see Linking into SVG content: URI fragments and SVG views). If the initial view is the "standard" view, then this attribute is false. If the initial view is a "custom" view, then this attribute is true.

Exceptions on setting

DOMException, code NO_MODIFICATION_ALLOWED_ERR

Raised on an attempt to change the value of a readonly attribute.

currentView (readonly SVGViewSpec

)

The definition of the initial view (i.e., before magnification and panning) of the current innermost SVG document fragment. The meaning depends on the situation:

• If the initial view was a "standard" view, then:
  • the values for viewBox, preserveAspectRatio and zoomAndPan within currentView will match the values for the corresponding DOM attributes that are on SVGSVGElement directly
  • the values for transform and viewTarget within currentView will be null
• If the initial view was a link into a 'view' element, then:
  • the values for viewBox, preserveAspectRatio and zoomAndPan within currentView will correspond to the corresponding attributes for the given 'view' element
  • the values for transform and viewTarget within currentView will be null
• If the initial view was a link into another element (i.e., other than a 'view'), then:
  • the values for viewBox, preserveAspectRatio and zoomAndPan within currentView will match the values for the corresponding DOM attributes that are on SVGSVGElement directly for the closest ancestor 'svg' element
  • the values for transform within currentView will be null
  • the viewTarget within currentView will represent the target of the link
• If the initial view was a link into the SVG document fragment using an SVG view specification fragment identifier (i.e., #svgView(...)), then:
  • the values for viewBox, preserveAspectRatio, zoomAndPan, transform and viewTarget within currentView will correspond to the values from the SVG view specification fragment identifier

The object itself and its contents are both readonly.

currentScale (float

)

This attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations, as described under Magnification and panning. DOM attributes currentScale and currentTranslate are equivalent to the 2x3 matrix [

a b c d e f] = [

currentScale 0 0 currentScale currentTranslate.x currentTranslate.y]. If "magnification" is enabled (i.e., zoomAndPan="magnify"), then the effect is as if an extra transformation were placed at the outermost level on the SVG document fragment (i.e., outside the outermost 'svg' element).

Exceptions on setting

DOMException, code NO_MODIFICATION_ALLOWED_ERR

Raised on an attempt to change the value of a readonly attribute.

currentTranslate (readonly SVGPoint

)

The corresponding translation factor that takes into account user "magnification".

Operations:

unsigned long suspendRedraw(in unsigned long max_wait_milliseconds)

Takes a time-out value which indicates that redraw shall not occur until: (a) the corresponding unsuspendRedraw(suspend_handle_id) call has been made, (b) an unsuspendRedrawAll() call has been made, or (c) its timer has timed out. In environments that do not support interactivity (e.g., print media), then redraw shall not be suspended. suspend_handle_id = suspendRedraw(max_wait_milliseconds) and unsuspendRedraw(suspend_handle_id) must be packaged as balanced pairs. When you want to suspend redraw actions as a collection of SVG DOM changes occur, then precede the changes to the SVG DOM with a method call similar to suspend_handle_id = suspendRedraw(max_wait_milliseconds) and follow the changes with a method call similar to unsuspendRedraw(suspend_handle_id). Note that multiple suspendRedraw calls can be used at once and that each such method call is treated independently of the other suspendRedraw method calls.

Parameters

1. unsigned long max_wait_milliseconds
   The amount of time in milliseconds to hold off before redrawing the device. Values greater than 60 seconds will be truncated down to 60 seconds.

Returns

A number which acts as a unique identifier for the given suspendRedraw() call. This value must be passed as the parameter to the corresponding unsuspendRedraw() method call.

No Exceptions

void unsuspendRedraw(in unsigned long suspend_handle_id)

Cancels a specified suspendRedraw() by providing a unique suspend_handle_id.

Parameters

1. unsigned long suspend_handle_id
   A number which acts as a unique identifier for the desired suspendRedraw() call. The number supplied must be a value returned from a previous call to suspendRedraw()

No Return Value

Exceptions

DOMException, code NOT_FOUND_ERR

This method will raise a DOMException with value NOT_FOUND_ERR if an invalid value (i.e., no such suspend_handle_id is active) for suspend_handle_id is provided.

void unsuspendRedrawAll()

Cancels all currently active suspendRedraw() method calls. This method is most useful at the very end of a set of SVG DOM calls to ensure that all pending suspendRedraw() method calls have been cancelled.

No Parameters

No Return Value

No Exceptions

void forceRedraw()

In rendering environments supporting interactivity, forces the user agent to immediately redraw all regions of the viewport that require updating.

No Parameters

No Return Value

No Exceptions

void pauseAnimations()

Suspends (i.e., pauses) all currently running animations that are defined within the SVG document fragment corresponding to this 'svg' element, causing the animation clock corresponding to this document fragment to stand still until it is unpaused.

No Parameters

No Return Value

No Exceptions

void unpauseAnimations()

Unsuspends (i.e., unpauses) currently running animations that are defined within the SVG document fragment, causing the animation clock to continue from the time at which it was suspended.

No Parameters

No Return Value

No Exceptions

boolean animationsPaused()

Returns true if this SVG document fragment is in a paused state.

No Parameters

Returns

Boolean indicating whether this SVG document fragment is in a paused state.

No Exceptions

float getCurrentTime()

Returns the current time in seconds relative to the start time for the current SVG document fragment.

No Parameters

Returns

The current time in seconds.

No Exceptions

void setCurrentTime(in float seconds)

Adjusts the clock for this SVG document fragment, establishing a new current time.

Parameters

1. float seconds
   The new current time in seconds relative to the start time for the current SVG document fragment.

No Return Value

No Exceptions

NodeList getIntersectionList(in SVGRect rect, in SVGElement referenceElement)

Returns the list of graphics elements whose rendered content intersects the supplied rectangle, honoring the 'pointer-events' property value on each candidate graphics element.

Parameters

1. SVGRect rect
   The test rectangle. The values are in the initial coordinate system for the current 'svg' element.

1. SVGElement referenceElement
   If not null, then only return elements whose drawing order has them below the given reference element.

Returns

A list of Elements whose content intersects the supplied rectangle.

No Exceptions

NodeList getEnclosureList(in SVGRect rect, in SVGElement referenceElement)

Returns the list of graphics elements whose rendered content is entirely contained within the supplied rectangle, honoring the 'pointer-events' property value on each candidate graphics element.

Parameters

1. SVGRect rect
   The test rectangle. The values are in the initial coordinate system for the current 'svg' element.

1. SVGElement referenceElement
   If not null, then only return elements whose drawing order has them below the given reference element.

Returns

A list of Elements whose content is enclosed by the supplied rectangle.

No Exceptions

boolean checkIntersection(in SVGElement element, in SVGRect rect)

Returns true if the rendered content of the given element intersects the supplied rectangle, honoring the 'pointer-events' property value on each candidate graphics element.

Parameters

1. SVGElement element
   The element on which to perform the given test.

1. SVGRect rect
   The test rectangle. The values are in the initial coordinate system for the current 'svg' element.

Returns

True or false, depending on whether the given element intersects the supplied rectangle.

No Exceptions

boolean checkEnclosure(in SVGElement element, in SVGRect rect)

Returns true if the rendered content of the given element is entirely contained within the supplied rectangle, honoring the 'pointer-events' property value on each candidate graphics element.

Parameters

1. SVGElement element
   The element on which to perform the given test.

1. SVGRect rect
   The test rectangle. The values are in the initial coordinate system for the current 'svg' element.

Returns

True or false, depending on whether the given element is enclosed by the supplied rectangle.

No Exceptions

void deselectAll()

Unselects any selected objects, including any selections of text strings and type-in bars.

No Parameters

No Return Value

No Exceptions

SVGNumber createSVGNumber()

Creates an SVGNumber object outside of any document trees. The object is initialized to a value of zero.

No Parameters

Returns

An SVGNumber object.

No Exceptions

SVGLength createSVGLength()

Creates an SVGLength object outside of any document trees. The object is initialized to the value of 0 user units.

No Parameters

Returns

An SVGLength object.

No Exceptions

SVGAngle createSVGAngle()

Creates an SVGAngle object outside of any document trees. The object is initialized to the value 0 degrees (unitless).

No Parameters

Returns

An SVGAngle object.

No Exceptions

SVGPoint createSVGPoint()

Creates an SVGPoint object outside of any document trees. The object is initialized to the point (0,0) in the user coordinate system.

No Parameters

Returns

An SVGPoint object.

No Exceptions

SVGMatrix createSVGMatrix()

Creates an SVGMatrix object outside of any document trees. The object is initialized to the identity matrix.

No Parameters

Returns

An SVGMatrix object.

No Exceptions

SVGRect createSVGRect()

Creates an SVGRect object outside of any document trees. The object is initialized such that all values are set to 0 user units.

No Parameters

Returns

An SVGRect object.

No Exceptions

SVGTransform createSVGTransform()

Creates an SVGTransform object outside of any document trees. The object is initialized to an identity matrix transform (SVG_TRANSFORM_MATRIX).

No Parameters

Returns

An SVGTransform object.

No Exceptions

SVGTransform createSVGTransformFromMatrix(in SVGMatrix matrix)

Creates an SVGTransform object outside of any document trees. The object is initialized to the given matrix transform (i.e., SVG_TRANSFORM_MATRIX).

Parameters

1. SVGMatrix matrix
   The transform matrix.

Returns

An SVGTransform object.

No Exceptions

Element getElementById(in DOMString elementId)

Searches this SVG document fragment (i.e., the search is restricted to a subset of the document tree) for an Element whose id is given by elementId. If an Element is found, that Element is returned. If no such element exists, returns null. Behavior is not defined if more than one element has this id.

Parameters

1. DOMString elementId
   The unique id value for an element.

Returns

The matching element.

No Exceptions

5.11.3 Interface SVGGElement

interface SVGGElement : SVGElement,
                

        SVGTests,
        

SVGLangSpace,
                        SVGExternalResourcesRequired,
                        SVGStylable,
                        SVGTransformable,
                

        EventTarget {
};

5.11.4 Interface SVGDefsElement

interface SVGDefsElement : SVGElement,
                

           SVGTests,
     

                      SVGLangSpace,
                           SVGExternalResourcesRequired,
                           SVGStylable,
                           SVGTransformable,
                

           EventTarget {
};

5.11.5 Interface SVGDescElement

interface SVGDescElement : SVGElement,
                

           SVGLangSpace,
     

                      SVGStylable {
};

5.11.6 Interface SVGTitleElement

interface SVGTitleElement : SVGElement,
                

            SVGLangSpace,
    

                        SVGStylable {
};

5.11.7 Interface SVGSymbolElement

interface SVGSymbolElement : SVGElement,
                

             SVGLangSpace,
   

                          SVGExternalResourcesRequired,
                             SVGStylable,
                             SVGFitToViewBox,
                

             EventTarget {
};

5.11.8 Interface SVGUseElement

interface SVGUseElement : SVGElement,
                

          SVGURIReference,
      

                    SVGTests,
                          SVGLangSpace,
                          SVGExternalResourcesRequired,
                          SVGStylable,
                          SVGTransformable,
                

          EventTarget {
  

readonly attribute SVGAnimatedLength 

x;
  readonly attribute SVGAnimatedLength 

y;
  readonly attribute SVGAnimatedLength 

width;
  readonly attribute SVGAnimatedLength 

height;
  readonly attribute SVGElementInstance instanceRoot;
  readonly attribute SVGElementInstance animatedInstanceRoot;
};

Attributes:

x (readonly SVGAnimatedLength

)

Corresponds to attribute 'x' on the given 'use' element.

y (readonly SVGAnimatedLength

)

Corresponds to attribute 'y' on the given 'use' element.

width (readonly SVGAnimatedLength

)

Corresponds to attribute 'width' on the given 'use' element.

height (readonly SVGAnimatedLength

)

Corresponds to attribute 'height' on the given 'use' element.

instanceRoot (readonly SVGElementInstance

)

The root of the "instance tree". See description of SVGElementInstance for a discussion on the instance tree.

animatedInstanceRoot (readonly SVGElementInstance

)

If the 'xlink:href' attribute is being animated, contains the current animated root of the "instance tree". If the 'xlink:href' attribute is not currently being animated, contains the same value as

instanceRoot

.

See description of SVGElementInstance for a discussion on the instance tree.

5.11.9 Interface SVGElementInstance

For each 'use' element, the SVG DOM maintains a shadow tree (the "instance tree") of objects of type SVGElementInstance. A An SVGElementInstance represents a single node in the instance tree. The root object in the instance tree is pointed to by the instanceRoot attribute on the SVGUseElement object for the corresponding 'use' element.

If the 'use' element references a simple graphics element such as a 'rect', then there is only a single SVGElementInstance object, and the correspondingElement attribute on this SVGElementInstance object is the SVGRectElement that corresponds to the referenced 'rect' element.

If the 'use' element references a 'g' which contains two 'rect' elements, then the instance tree contains three SVGElementInstance objects, a root SVGElementInstance object whose correspondingElement is the SVGGElement object for the 'g', and then two child SVGElementInstance objects, each of which has its correspondingElement that is an SVGRectElement object.

If the referenced object is itself a 'use', or if there are 'use' subelements within the referenced object, the instance tree will contain recursive expansion of the indirect references to form a complete tree. For example, if a 'use' element references a 'g', and the 'g' itself contains a 'use', and that 'use' references a 'rect', then the instance tree for the original (outermost) 'use' will consist of a hierarchy of SVGElementInstance objects, as follows:

SVGElementInstance #1 (parentNode=null, firstChild=#2, correspondingElement is the 'g')
  SVGElementInstance #2 (parentNode=#1, firstChild=#3, correspondingElement is the other 'use')
    SVGElementInstance #3 (parentNode=#2, firstChild=null, correspondingcorrespondingElement Element is the 'rect')

interface SVGElementInstance : 

EventTarget {
  

readonly attribute SVGElement correspondingElement;
  readonly attribute SVGUseElement correspondingUseElement;
  readonly attribute SVGElementInstance parentNode;
  readonly attribute SVGElementInstanceList childNodes;
  readonly attribute SVGElementInstance firstChild;
  readonly attribute SVGElementInstance lastChild;
  readonly attribute SVGElementInstance previousSibling;
  readonly attribute SVGElementInstance nextSibling;
};

Attributes:

correspondingElement (readonly SVGElement

)

The corresponding element to which this object is an instance. For example, if a 'use' element references a 'rect' element, then an SVGElementInstance is created, with its correspondingElement being the SVGElementInstance object for the 'rect' element.

correspondingUseElement (readonly SVGUseElement

)

The corresponding 'use' element to which this SVGElementInstance object belongs. When 'use' elements are nested (e.g., a 'use' references another 'use' which references a graphics element such as a 'rect'), then the correspondingUseElement is the outermost 'use' (i.e., the one which indirectly references the 'rect', not the one with the direct reference).

parentNode (readonly SVGElementInstance

)

The parent of this SVGElementInstance within the instance tree. All SVGElementInstance objects have a parent except the SVGElementInstance which corresponds to the element which was directly referenced by the 'use' element, in which case parentNode is null.

childNodes (readonly SVGElementInstanceList

)

An SVGElementInstanceList that contains all children of this SVGElementInstance within the instance tree. If there are no children, this is an SVGElementInstanceList containing no entries (i.e., an empty list).

firstChild (readonly SVGElementInstance

)

The first child of this SVGElementInstance within the instance tree. If there is no such SVGElementInstance, this returns null.

lastChild (readonly SVGElementInstance

)

The last child of this SVGElementInstance within the instance tree. If there is no such SVGElementInstance, this returns null.

previousSibling (readonly SVGElementInstance

)

The SVGElementInstance immediately preceding this SVGElementInstance. If there is no such SVGElementInstance, this returns null.

nextSibling (readonly SVGElementInstance

)

The SVGElementInstance immediately following this SVGElementInstance. If there is no such SVGElementInstance, this returns null.

5.11.10 Interface SVGElementInstanceList

interface SVGElementInstanceList {

  readonly attribute unsigned long length;

  SVGElementInstance item

(

in unsigned long index

);
};

Attributes:

length (readonly unsigned long

)

The number of SVGElementInstance objects in the list. The range of valid child indices is 0 to length

−1 inclusive.

Operations:

SVGElementInstance item(in unsigned long index)

Returns the indexth item in the collection. If index is greater than or equal to the number of nodes in the list, this returns null.

Parameters

1. unsigned long index
   Index into the collection.

Returns

The SVGElementInstance object at the indexth position in the SVGElementInstanceList, or null if that is not a valid index.

No Exceptions

5.11.11 Interface SVGImageElement

interface SVGImageElement : SVGElement,
                

            SVGURIReference,
    

                        SVGTests,
                            SVGLangSpace,
                            SVGExternalResourcesRequired,
                            SVGStylable,
                            SVGTransformable,
                

            EventTarget {
  

readonly attribute SVGAnimatedLength x;
  readonly attribute SVGAnimatedLength y;
  readonly attribute SVGAnimatedLength width;
  readonly attribute SVGAnimatedLength height;
  readonly attribute SVGAnimatedPreserveAspectRatio preserveAspectRatio;
};

Attributes:

x (readonly SVGAnimatedLength

)

Corresponds to attribute 'x' on the given 'image' element.

y (readonly SVGAnimatedLength

)

Corresponds to attribute 'y' on the given 'image' element.

width (readonly SVGAnimatedLength

)

Corresponds to attribute 'width' on the given 'image' element.

height (readonly SVGAnimatedLength

)

Corresponds to attribute 'height' on the given 'image' element.

preserveAspectRatio (readonly SVGAnimatedPreserveAspectRatio

)

Corresponds to attribute 'preserveAspectRatio' on the given 'image' element.

5.11.12 Interface SVGSwitchElement

interface SVGSwitchElement : SVGElement,
                

             SVGTests,
   

                          SVGLangSpace,
                             SVGExternalResourcesRequired,
                             SVGStylable,
                             SVGTransformable,
                

             EventTarget {
};

5.11.13 Interface GetSVGDocument

interface GetSVGDocument {
  

SVGDocument getSVGDocument

(

) 

raises(

DOMException

);
};

Operations:

SVGDocument getSVGDocument()

Returns the SVGDocument object for the referenced SVG document.

No Parameters

Returns

The SVGDocument object for the referenced SVG document.

Exceptions

DOMException, code NOT_SUPPORTED_ERR

No SVGDocument object is available.