Document Structure – SVG 1.1 (Second Edition) (original) (raw)

Contents

5.1 Defining an SVG document fragment: the ‘svg’ element

5.1.1 Overview

An SVG document fragment consists of any number of SVG elements contained within an ‘svg’ element.

An SVG document fragment can range from an empty fragment (i.e., no content inside of the ‘svg’ element), to a very simple SVG document fragment containing a single SVG graphics elementsuch as a ‘rect’, to a complex, deeply nested collection ofcontainer elements and graphics elements.

An SVG document fragment can stand by itself as a self-contained file or resource, in which case the SVG document fragment is an SVG document, or it can be embedded inline as a fragment within a parent XML document.

The following example shows simple SVG content embedded inline as a fragment within a parent XML document. Note the use of XML namespaces to indicate that the ‘svg’ and‘ellipse’ elements belong to the SVG namespace:

<svg:svg width="4cm" height="8cm" version="1.1"> <svg:ellipse cx="2cm" cy="4cm" rx="2cm" ry="1cm" />

This example shows a slightly more complex (i.e., it contains multiple rectangles) stand-alone, self-contained SVG document:

Four separate rectangles

‘svg’ elements can appear in the middle of SVG content. This is the mechanism by which SVG document fragments can be embedded within other SVG document fragments.

Another use for ‘svg’ elements within the middle of SVG content is to establish a new viewport. (SeeEstablishing a new viewport.)

In all cases, for compliance with theNamespaces in XML Recommendation [XML-NS], an SVG namespace declaration must be provided so that all SVG elements are identified as belonging to the SVG namespace. The following are possible ways to provide a namespace declaration. An ‘xmlns’attribute without a namespace prefix could be specified on an‘svg’ element, which means that SVG is the default namespace for all elements within the scope of the element with the ‘xmlns’ attribute:

<svg xmlns="http://www.w3.org/2000/svg" …> <rect …/>

If a namespace prefix is specified on the ‘xmlns’attribute (e.g., xmlns:svg="http://www.w3.org/2000/svg"), then the corresponding namespace is not the default namespace, so an explicit namespace prefix must be assigned to the elements:

<svg:svg xmlns:svg="http://www.w3.org/2000/svg" …> <svg:rect …/>

Namespace prefixes can be specified on ancestor elements (illustrated in the above example). For more information, refer to the Namespaces in XML Recommendation [XML-NS].

5.1.2 The ‘svg’ element

‘svg’

Categories:

Container element, structural element

Content model:

Any number of the following elements, in any order:

Attributes:

DOM Interfaces:

Attribute definitions:

version = ""

Indicates the SVG language version to which this document fragment conforms.
In SVG 1.0 [SVG10], this attribute was fixed to the value '1.0'. For SVG 1.1, the attribute should have the value'1.1'.
Animatable: no.

baseProfile = profile-name

Describes the minimum SVG language profile that the author believes is necessary to correctly render the content. The attribute does not specify any processing restrictions; It can be considered metadata. For example, the value of the attribute could be used by an authoring tool to warn the user when they are modifying the document beyond the scope of the specified base profile. Each SVG profile should define the text that is appropriate for this attribute.
If the attribute is not specified, the effect is as if a value of 'none' were specified.
Animatable: no.

x = ""

(Has no meaning or effect on outermost svg elements.)
The x-axis coordinate of one corner of the rectangular region into which an embedded ‘svg’ element is placed.
If the attribute is not specified, the effect is as if a value of '0' were specified.
Animatable: yes.

y = ""

(Has no meaning or effect on outermost svg elements.)
The y-axis coordinate of one corner of the rectangular region into which an embedded ‘svg’ element is placed.
If the attribute is not specified, the effect is as if a value of '0' were specified.
Animatable: yes.

width = ""

For outermost svg elements, the intrinsic width of the SVG document fragment. For embedded ‘svg’ elements, the width of the rectangular region into which the ‘svg’ element is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of the element.
If the attribute is not specified, the effect is as if a value of '100%' were specified.
Animatable: yes.

height = ""

For outermost svg elements, the intrinsic height of the SVG document fragment. For embedded ‘svg’ elements, the height of the rectangular region into which the ‘svg’ element is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of the element.
If the attribute is not specified, the effect is as if a value of '100%' were specified.
Animatable: yes.

preserveAspectRatio = "[defer] []"

See ‘preserveAspectRatio’.

If the attribute is not specified, then the effect is as if a value of 'xMidYMid meet' were specified.

Animatable: yes.

contentScriptType = "content-type"

See 'contentScriptType'.

contentStyleType = "content-type"

See 'contentStyleType'.

zoomAndPan = "disable | magnify"

See 'zoomAndPan'.

If an SVG document is likely to be referenced as a component of another document, the author will often want to include a‘viewBox’ attribute on the outermost svg element of the referenced document. This attribute provides a convenient way to design SVG documents to scale-to-fit into an arbitrary viewport.

5.2 Grouping: the ‘g’ element

5.2.1 Overview

The ‘g’ element is a container element for grouping together related graphics elements.

Grouping constructs, when used in conjunction with the ‘desc’and ‘title’ elements, provide information about document structure and semantics. Documents that are rich in structure may be rendered graphically, as speech, or as braille, and thus promoteaccessibility.

A group of elements, as well as individual objects, can be given a name using the ‘id’ attribute. Named groups are needed for several purposes such as animation and re-usable objects.

An example:

Two groups, each of two rectangles

View this example as SVG (SVG-enabled browsers only)

A ‘g’ element can contain other ‘g’ elements nested within it, to an arbitrary depth. Thus, the following is possible:

Groups can nest

Any element that is not contained within a ‘g’ is treated (at least conceptually) as if it were in its own group.

5.2.2 The ‘g’ element

‘g’

Categories:

Container element, structural element

Content model:

Any number of the following elements, in any order:

Attributes:

DOM Interfaces:

5.3 Defining content for reuse, and the ‘defs’ element

5.3.1 Overview

SVG allows graphical objects to be defined for later reuse. To do this, it makes extensive use of IRI references[RFC3987] to these other objects. For example, to fill a rectangle with a linear gradient, you first define a ‘linearGradient’ element and give it an ID, as in:

...

You then reference the linear gradient as the value of the‘fill’ property for the rectangle, as in:

Some types of element, such as gradients, will not by themselves produce a graphical result. They can therefore be placed anywhere convenient. However, sometimes it is desired to define a graphical object and prevent it from being directly rendered. it is only there to be referenced elsewhere. To do this, and to allow convenient grouping defined content, SVG provides the ‘defs’ element.

It is recommended that, wherever possible, referenced elements be defined inside of a ‘defs’ element. Among the elements that are always referenced: ‘altGlyphDef’, ‘clipPath’, ‘cursor’,‘filter’, ‘linearGradient’, ‘marker’,‘mask’, ‘pattern’, ‘radialGradient’ and‘symbol’. Defining these elements inside of a ‘defs’ element promotes understandability of the SVG content and thus promotes accessibility.

5.3.2 The ‘defs’ element

‘defs’

Categories:

Container element, structural element

Content model:

Any number of the following elements, in any order:

Attributes:

DOM Interfaces:

The ‘defs’ element is a container element forreferenced elements. For understandability andaccessibility reasons, it is recommended that, whenever possible, referenced elements be defined inside of a ‘defs’.

The content model for ‘defs’ is the same as for the‘g’ element; thus, any element that can be a child of a‘g’ can also be a child of a ‘defs’, and vice versa.

Elements that are descendants of a ‘defs’ are not rendered directly; they are prevented from becoming part of the rendering tree just as if the ‘defs’ element were a ‘g’ element and the‘display’ property were set to none. Note, however, that the descendants of a ‘defs’ are always present in the source tree and thus can always be referenced by other elements; thus, the value of the ‘display’property on the ‘defs’ element or any of its descendants does not prevent those elements from being referenced by other elements.

To provide some SVG user agents with an opportunity to implement efficient implementations in streaming environments, creators of SVG content are encouraged to place all elements which are targets of local IRI references within a ‘defs’element which is a direct child of one of the ancestors of the referencing element. For example:

Local URI references within ancestor's 'defs' element.

View this example as SVG (SVG-enabled browsers only)

In the document above, the linear gradient is defined within a ‘defs’ element which is the direct child of the ‘svg’element, which in turn is an ancestor of the ‘rect’ element which references the linear gradient. Thus, the above document conforms to the guideline.

5.4 The ‘desc’and ‘title’ elements

Each container element or graphics element in an SVG drawing can supply a ‘desc’ and/or a ‘title’ description string where the description is text-only. When the current SVG document fragment is rendered as SVG on visual media, ‘desc’ and ‘title’ elements are not rendered as part of the graphics. User agents may, however, for example, display the ‘title’ element as a tooltip, as the pointing device moves over particular elements. Alternate presentations are possible, both visual and aural, which display the ‘desc’ and ‘title’ elements but do not display ‘path’ elements or other graphics elements. This is readily achieved by using a different (perhaps user) style sheet. For deep hierarchies, and for following ‘use’ element references, it is sometimes desirable to allow the user to control how deep they drill down into descriptive text.

In conforming SVG document fragments, any ‘title’ element should be the first child element of its parent. Note that those implementations that do use ‘title’ to display a tooltip often will only do so if the‘title’ is indeed the first child element of its parent.

The following is an example. In typical operation, the SVG user agent would not render the ‘desc’ and ‘title’ elements but would render the remaining contents of the ‘g’ element.

Company sales by region This is a bar chart which shows company sales by region.

Description and title elements can contain marked-up text from other namespaces. Here is an example:

mydoc:titleThis is an example SVG file mydoc:paraThe global description uses markup from the mydoc:emphmydoc namespace.

Authors should always provide a ‘title’ child element to theoutermost svg element within a stand-alone SVG document. The‘title’ child element to an ‘svg’ element serves the purposes of identifying the content of the given SVG document fragment. Since users often consult documents out of context, authors should provide context-rich titles. Thus, instead of a title such as "Introduction", which doesn't provide much contextual background, authors should supply a title such as "Introduction to Medieval Bee-Keeping" instead. For reasons of accessibility, user agents should always make the content of the ‘title’ child element to the outermost svg elementavailable to users. The mechanism for doing so depends on the user agent (e.g., as a caption, spoken).

The DTD definitions of many of SVG's elements (particularly, container and text elements) place no restriction on the placement or number of the ‘desc’ and ‘title’ sub-elements. This flexibility is only present so that there will be a consistent content model for container elements, because some container elements in SVG allow for mixed content, and becausethe mixed content rules for XML([XML10], section 3.2.2) do not permit the desired restrictions. Representations of future versions of the SVG language might use more expressive representations than DTDs which allow for more restrictive mixed content rules. It is strongly recommended that at most one ‘desc’ and at most one ‘title’ element appear as a child of any particular element, and that these elements appear before any other child elements (except possibly‘metadata’ elements) or character data content. If user agents need to choose among multiple ‘desc’ or ‘title’ elements for processing (e.g., to decide which string to use for a tooltip), the user agent shall choose the first one.

5.5 The ‘symbol’ element

‘symbol’

Categories:

Container element, structural element

Content model:

Any number of the following elements, in any order:

Attributes:

DOM Interfaces:

The ‘symbol’ element is used to define graphical template objects which can be instantiated by a ‘use’ element.

The use of ‘symbol’ elements for graphics that are used multiple times in the same document adds structure and semantics. Documents that are rich in structure may be rendered graphically, as speech, or as braille, and thus promote accessibility.

The key distinctions between a ‘symbol’ and a ‘g’ are:

Closely related to the ‘symbol’ element are the‘marker’ and ‘pattern’ elements.

‘symbol’ elements are never rendered directly; their only usage is as something that can be referenced using the‘use’ element. The ‘display’ property does not apply to the ‘symbol’ element; thus, ‘symbol’ elements are not directly rendered even if the ‘display’ property is set to a value other than none, and ‘symbol’elements are available for referencing even when the‘display’ property on the ‘symbol’ element or any of its ancestors is set to none.

5.6 The ‘use’ element

‘use’

Categories:

Graphics element, graphics referencing element, structural element

Content model:

Any number of the following elements, in any order:

Attributes:

DOM Interfaces:

Any ‘svg’, ‘symbol’, ‘g’, graphics element or other ‘use’ is potentially a template object that can be re-used (i.e., "instanced") in the SVG document via a ‘use’ element. The ‘use’ element references another element and indicates that the graphical contents of that element is included/drawn at that given point in the document.

Unlike ‘image’, the ‘use’ element cannot reference entire files.

The ‘use’ element has optional attributes ‘x’, ‘y’, ‘width’ and ‘height’ which are used to map the graphical contents of the referenced element onto a rectangular region within the current coordinate system.

The effect of a ‘use’ element is as if the contents of the referenced element were deeply cloned into a separate non-exposed DOM tree which had the ‘use’ element as its parent and all of the ‘use’ element's ancestors as its higher-level ancestors. Because the cloned DOM tree is non-exposed, the SVG Document Object Model (DOM) only contains the ‘use’ element and its attributes. The SVG DOM does not show the referenced element's contents as children of ‘use’ element.

For user agents that support Styling with CSS, the conceptual deep cloning of the referenced element into a non-exposed DOM tree also copies any property values resulting from the CSS cascade ([CSS2], chapter 6) on the referenced element and its contents. CSS2 selectors can be applied to the original (i.e., referenced) elements because they are part of the formal document structure. CSS2 selectors cannot be applied to the (conceptually) cloned DOM tree because its contents are not part of the formal document structure.

Property inheritance, however, works as if the referenced element had been textually included as a deeply cloned child of the ‘use’ element. The referenced element inherits properties from the ‘use’ element and the ‘use’ element's ancestors. An instance of a referenced element does not inherit properties from the referenced element's original parents.

If event attributes are assigned to referenced elements, then the actual target for the event will be theSVGElementInstance object within the "instance tree" corresponding to the given referenced element.

The event handling for the non-exposed tree works as if the referenced element had been textually included as a deeply cloned child of the ‘use’ element, except that events are dispatched to the SVGElementInstance objects. The event's target and currentTarget attributes are set to theSVGElementInstance that corresponds to the target and current target elements in the referenced subtree. An event propagates through the exposed and non-exposed portions of the tree in the same manner as it would in the regular document tree: first going from the root element to the ‘use’ element and then through non-exposed tree elements in the capture phase, followed by the target phase at the target of the event, then bubbling back through non-exposed tree to the use element and then back through regular tree to the root element in bubbling phase.

An element and all its corresponding SVGElementInstance objects share an event listener list. The currentTarget attribute of the event can be used to determine through which object an event listener was invoked.

The behavior of the ‘visibility’ property conforms to this model of property inheritance. Thus, specifying 'visibility:hidden' on a ‘use’ element does not guarantee that the referenced content will not be rendered. If the ‘use’ element specifies 'visibility:hidden' and the element it references specifies 'visibility:hidden' or 'visibility:inherit', then that one element will be hidden. However, if the referenced element instead specifies 'visibility:visible', then that element will be visible even if the ‘use’ element specifies 'visibility:hidden'.

Animations on a referenced element will cause the instances to also be animated.

A ‘use’ element has the same visual effect as if the ‘use’ element were replaced by the following generated content:

For user agents that support Styling with CSS, the generated ‘g’ element carries along with it the "cascaded" property values on the ‘use’ element which result fromthe CSS cascade ([CSS2], chapter 6). Additionally, the copy (deep clone) of the referenced resource carries along with it the "cascaded" property values resulting from the CSS cascade on the original (i.e., referenced) elements. Thus, the result of various CSS selectors in combination with the ‘class’ and ‘style’ attributes are, in effect, replaced by the functional equivalent of a ‘style’ attribute in the generated content which conveys the "cascaded" property values.

Example Use01 below has a simple ‘use’ on a ‘rect’.

Example Use01 - Simple case of 'use' on a 'rect'

Example Use01

Example Use01 — Simple case of 'use' on a 'rect'

View this example as SVG (SVG-enabled browsers only)

The visual effect would be equivalent to the following document:

Example Use01-GeneratedContent - Simple case of 'use' on a 'rect'

View this example as SVG (SVG-enabled browsers only)

Example Use02 below has a‘use’ on a ‘symbol’.

Example Use02 - 'use' on a 'symbol' MySymbol - four rectangles in a grid

Example Use02

Example Use02 — 'use' on a 'symbol'

View this example as SVG (SVG-enabled browsers only)

The visual effect would be equivalent to the following document:

Example Use02-GeneratedContent - 'use' on a 'symbol'

View this example as SVG (SVG-enabled browsers only)

Example Use03 illustrates what happens when a ‘use’ has a ‘transform’ attribute.

Example Use03 - 'use' with a 'transform' attribute

Example Use03

Example Use03 — 'use' with a 'transform' attribute

View this example as SVG (SVG-enabled browsers only)

The visual effect would be equivalent to the following document:

Example Use03-GeneratedContent - 'use' with a 'transform' attribute

View this example as SVG (SVG-enabled browsers only)

Example Use04 illustrates a‘use’ element with various methods of applying CSS styling.

Example Use04 - 'use' with CSS styling

Example Use04

Example Use04 — 'use' with CSS styling

View this example as SVG (SVG-enabled browsers only)

The visual effect would be equivalent to the following document. Observe that some of the style rules above apply to the generated content (i.e., rules 1-6, 10-12), whereas others do not (i.e., rules 7-9). The rules which do not affect the generated content are:

In the generated content below, the selectors that yield a match have been transferred into inline ‘style’ attributes for illustrative purposes.

Example Use04-GeneratedContent - 'use' with a 'transform' attribute

<!-- Start of generated content. Replaces 'use' -->
<g style="/* rule 1 */ fill:blue;
             /* rule 3 */ fill-opacity:.5;
             /* rule 5 */ stroke-linecap:round;
             /* rule 12 */ stroke-dashoffset:50" >
  <path d="M300 50 L900 50 L900 250 L300 250"
        style="/* rule 2 */ stroke:red; 
               /* rule 4 */ stroke-opacity:.5; 
               /* rule 6 */ stroke-linejoin: bevel; 
               /* rule 10 */ stroke-dasharray:300,100" />
</g> 
<!-- End of generated content -->

View this example as SVG (SVG-enabled browsers only)

When a ‘use’ references another element which is another ‘use’ or whose content contains a‘use’ element, then the deep cloning approach described above is recursive. However, a set of references that directly or indirectly reference a element to create a circular dependency is an error, as described in References and the ‘defs’ element.

Attribute definitions:

x = ""

The x-axis coordinate of one corner of the rectangular region into which the referenced element is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.

y = ""

The y-axis coordinate of one corner of the rectangular region into which the referenced element is placed.
If the attribute is not specified, the effect is as if a value of "0" were specified.
Animatable: yes.

width = ""

The width of the rectangular region into which the referenced element is placed. A negative value is an error (see Error processing). A value of zero disables rendering of this element.
Animatable: yes.

height = ""

The height of the rectangular region into which the referenced element is placed. A negative value is an error (see Error processing). A value of zero disables rendering of this element.
Animatable: yes.

xlink:href = ""

A IRI reference to an element/fragment within an SVG document.
Animatable: yes.

5.7 The ‘image’ element

‘image’

Categories:

Graphics element, graphics referencing element

Content model:

Any number of the following elements, in any order:

Attributes:

DOM Interfaces:

The ‘image’ element indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system. The ‘image’ element can refer to raster image files such as PNG or JPEG or to files with MIME type of "image/svg+xml". Conforming SVG viewers need to support at least PNG, JPEG and SVG format files.

The result of processing an ‘image’ is always a four-channel RGBA result. When an ‘image’ element references a raster image file such as PNG or JPEG files which only has three channels (RGB), then the effect is as if the object were converted into a 4-channel RGBA image with the alpha channel uniformly set to 1. For a single-channel raster image, the effect is as if the object were converted into a 4-channel RGBA image, where the single channel from the referenced object is used to compute the three color channels and the alpha channel is uniformly set to 1.

An ‘image’ element establishes a new viewport for the referenced file as described in Establishing a new viewport. The bounds for the new viewport are defined by attributes ‘x’, ‘y’, ‘width’ and ‘height’. The placement and scaling of the referenced image are controlled by the ‘preserveAspectRatio’ attribute on the ‘image’ element.

When an ‘image’ element references an SVG image, the ‘clip’ and ‘overflow’ properties on the root element in the referenced SVG image are ignored (in the same manner as the‘x’, ‘y’, ‘width’ and ‘height’ attributes are ignored). Unless the value of‘preserveAspectRatio’ on the ‘image’ element starts with 'defer', the ‘preserveAspectRatio’ attribute on the root element in the referenced SVG image is also ignored (see ‘preserveAspectRatio’ for details). Instead, the ‘preserveAspectRatio’ attribute on the referencing ‘image’ element defines how the SVG image content is fitted into the viewport and the ‘clip’ and ‘overflow’ properties on the ‘image’ element define how the SVG image content is clipped (or not) relative to the viewport.

The value of the ‘viewBox’ attribute to use when evaluating the ‘preserveAspectRatio’ attribute is defined by the referenced content. For content that clearly identifies a viewBox (e.g. an SVG file with the ‘viewBox’ attribute on theoutermost svg element) that value should be used. For most raster content (PNG, JPEG) the bounds of the image should be used (i.e. the ‘image’ element has an implicit ‘viewBox’ of '0 0 raster-image-width raster-image-height'). Where no value is readily available (e.g. an SVG file with no ‘viewBox’ attribute on theoutermost svg element) the ‘preserveAspectRatio’ attribute is ignored, and only the translation due to the ‘x’ & ‘y’ attributes of the viewport is used to display the content.

For example, if the image element referenced a PNG or JPEG and preserveAspectRatio="xMinYMin meet", then the aspect ratio of the raster would be preserved (which means that the scale factor from image's coordinates to current user space coordinates would be the same for both X and Y), the raster would be sized as large as possible while ensuring that the entire raster fits within the viewport, and the top/left of the raster would be aligned with the top/left of the viewport as defined by the attributes ‘x’, ‘y’, ‘width’ and ‘height’ on the ‘image’ element. If the value of ‘preserveAspectRatio’ was 'none' then aspect ratio of the image would not be preserved. The image would be fitted such that the top/left corner of the raster exactly aligns with coordinate (‘x’, ‘y’) and the bottom/right corner of the raster exactly aligns with coordinate (‘x’+‘width’, ‘y’+‘height’).

The resource referenced by the ‘image’ element represents a separate document which generates its own parse tree and document object model (if the resource is XML). Thus, there is no inheritance of properties into the image.

Unlike ‘use’, the ‘image’ element cannot reference elements within an SVG file.

Attribute definitions:

x = ""

The x-axis coordinate of one corner of the rectangular region into which the referenced document is placed.
If the attribute is not specified, the effect is as if a value of '0' were specified.
Animatable: yes.

y = ""

The y-axis coordinate of one corner of the rectangular region into which the referenced document is placed.
If the attribute is not specified, the effect is as if a value of '0' were specified.
Animatable: yes.

width = ""

The width of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of the element.
Animatable: yes.

height = ""

The height of the rectangular region into which the referenced document is placed.
A negative value is an error (see Error processing). A value of zero disables rendering of the element.
Animatable: yes.

xlink:href = ""

A IRI reference.
Animatable: yes.

preserveAspectRatio = "[defer] []"

See ‘preserveAspectRatio’.

If attribute ‘preserveAspectRatio’ is not specified, then the effect is as if a value of xMidYMid meet were specified.

Animatable: yes.

An example:

This graphic links to an external image My image

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.

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:

5.8.2 The ‘switch’ element

‘switch’

Categories:

Container element

Content model:

Any number of the following elements, in any order:

Attributes:

DOM Interfaces:

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’ tonone on a child of a ‘switch’ element has no effect on true/false testing associated with ‘switch’element processing.

For more information and an example, seeEmbedding foreign object types.

5.8.3 The ‘requiredFeatures’ attribute

Definition of requiredFeatures:

requiredFeatures =list-of-features

The value is a list of feature strings, with the individual values separated by white space. Determines whether all of the named features are supported by the user agent. Only feature strings defined in the Feature String appendix are allowed. If all of the given features are supported, then the attribute evaluates to true; otherwise, the current element and its children are skipped and thus will not be rendered.
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 ‘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 an IRI reference.

Definition of requiredExtensions:

requiredExtensions =list-of-extensions

The value is a list of IRI references which identify the required extensions, with the individual values separated by white space. Determines whether all of the named extensions are supported by the user agent. If all of the given extensions are supported, then the attribute evaluates to true; otherwise, the current element and its children are skipped and thus will not be rendered.
Animatable: no.

If a given IRI 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 IRI 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 BCP 47 [BCP47].

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:

<text systemLanguage="mi, en"><!-- content goes here --></text>

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.

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.

Attribute definition:

externalResourcesRequired = "false | true"

false

(The default value.) Indicates that resources external to the current document are optional. Document rendering can proceed even if external resources are unavailable to the current element and its descendants.

true

Indicates that resources external to the current document are required. If an external resource is not available, progressive rendering is suspended, the document's SVGLoad event is not fired and the animation timeline does not begin until that resource and all other required resources become available, have been parsed and are ready to be rendered. If a timeout event occurs on a required resource, then the document goes into an error state (see Error processing). The document remains in an error state until all required resources become available.

This attribute applies to all types of resource references, including style sheets, color profiles (see Color profile descriptions) and fonts specified by an IRI reference using a ‘font-face’ element or a CSS @font-face specification. In particular, if an element setsexternalResourcesRequired="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 will have the effect of disabling progressive display of the contents of that container, if that container includes elements that reference external resources, tools that generate SVG content are cautioned against 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 specifically 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

Elements that might contain character data content have attributes ‘xml:lang’ and ‘xml:space’.

5.11 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 anSVGDocument 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 anSVGDocument object.

The SVGDocument interface contains a similar list of attributes and methods to the HTMLDocument interface described in theDocument 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; };

title (readonly DOMString)

The title of a document as specified by the ‘title’ sub-element of the ‘svg’ root element (i.e.,Here is the title...)

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 DOM Level 2 Style [DOM2STYLE].

interface SVGSVGElement : SVGElement, SVGTests, SVGLangSpace, SVGExternalResourcesRequired, SVGStylable, SVGLocatable, SVGFitToViewBox, SVGZoomAndPan, 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; readonly attribute boolean useCurrentView; readonly attribute SVGViewSpec currentView; attribute float currentScale; readonly attribute SVGPoint currentTranslate;

unsigned long suspendRedraw(in unsigned long maxWaitMilliseconds); void unsuspendRedraw(in unsigned long suspendHandleID); 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); };

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)

DOMException, code NO_MODIFICATION_ALLOWED_ERR

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

contentStyleType (DOMString)

DOMException, code NO_MODIFICATION_ALLOWED_ERR

Raised on an attempt to change the value of a read only 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 CSS2 specification.) If the parent element does not have a coordinate system, then the user agent should provide reasonable default values for this attribute.

The SVGRect object is read only.

pixelUnitToMillimeterX (readonly float)

Size of a pixel units (as defined by CSS2) 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 (readonly 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: IRI 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.

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:

The object itself and its contents are both read only.

currentScale (float)

On an outermost svg element, this attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations, as described underMagnification and panning. DOM attributes currentScale andcurrentTranslate 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 theoutermost svg element).

When accessed on an ‘svg’ element that is not anoutermost svg element, it is undefined what behavior this attribute has.

currentTranslate (readonly SVGPoint)

unsigned long suspendRedraw(in unsigned long maxWaitMilliseconds)

Takes a time-out value which indicates that redraw shall not occur until:

  1. the corresponding unsuspendRedraw() call has been made,
  2. an unsuspendRedrawAll() call has been made, or
  3. its timer has timed out.

In environments that do not support interactivity (e.g., print media), then redraw shall not be suspended. Calls to suspendRedraw() and unsuspendRedraw() should, but need not be, made in balanced pairs.

To suspend redraw actions as a collection of SVG DOM changes occur, precede the changes to the SVG DOM with a method call similar to:

suspendHandleID = suspendRedraw(maxWaitMilliseconds);

and follow the changes with a method call similar to:

unsuspendRedraw(suspendHandleID);

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.

  1. unsigned long maxWaitMilliseconds
    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.

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.

void unsuspendRedraw(in unsigned long suspendHandleID)

Cancels a specified suspendRedraw() by providing a unique suspend handle ID that was returned by a previous suspendRedraw() call.

  1. unsigned long suspendHandleID
    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(). If an invalid handle ID value is provided then the request to unsuspendRedraw() is silently ignored.

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.

void forceRedraw()

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

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.

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.

boolean animationsPaused()

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

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

float getCurrentTime()

Returns the current time in seconds relative to the start time for the current SVG document fragment. If getCurrentTime is called before the document timeline has begun (for example, by script running in a‘script’ element before the document'sSVGLoad event is dispatched), then 0 is returned.

The current time in seconds, or 0 if the document timeline has not yet begun.

void setCurrentTime(in float seconds)

Adjusts the clock for this SVG document fragment, establishing a new current time. If setCurrentTime is called before the document timeline has begun (for example, by script running in a ‘script’ element before the document'sSVGLoad event is dispatched), then the value of seconds in the last invocation of the method gives the time that the document will seek to once the document timeline has begun.

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

NodeList getIntersectionList(in SVGRect rect, in SVGElement referenceElement)

Returns the list of graphics elements whose rendered content intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in ‘pointer-events’ processing.

  1. If not null, then any intersected element that doesn't have the referenceElement as ancestor must not be included in the returned NodeList.

A list of Elements whose content intersects the supplied rectangle. This NodeList must be implemented identically to the NodeList interface as defined in DOM Level 2 Core ([DOM2], section 1.2) with the exception that the interface is notlive.

NodeList getEnclosureList(in SVGRect rect, in SVGElement referenceElement)

Returns the list of graphics elements whose rendered content is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in ‘pointer-events’ processing.

  1. If not null, then any intersected element that doesn't have the referenceElement as ancestor must not be included in the returned NodeList.

A list of Elements whose content is enclosed by the supplied rectangle. This NodeList must be implemented identically to the NodeList interface as defined in DOM Level 2 Core ([DOM2], section 1.2) with the exception that the interface is notlive.

boolean checkIntersection(in SVGElement element, in SVGRect rect)

Returns true if the rendered content of the given element intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in ‘pointer-events’ processing.

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

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

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. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in ‘pointer-events’ processing.

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

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

void deselectAll()

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

SVGNumber createSVGNumber()

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

SVGLength createSVGLength()

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

SVGAngle createSVGAngle()

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

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.

SVGMatrix createSVGMatrix()

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

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.

SVGTransform createSVGTransform()

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

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). The values from the parameter matrix are copied, the matrix parameter is not adopted asSVGTransform::matrix.

  1. The transform matrix.

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 byelementId. 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.

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

The matching element.

5.11.3 Interface SVGGElement

The SVGSVGElement interface corresponds to the ‘g’ element.

interface SVGGElement : SVGElement, SVGTests, SVGLangSpace, SVGExternalResourcesRequired, SVGStylable, SVGTransformable { };

5.11.4 Interface SVGDefsElement

The SVGDefsElement interface corresponds to the ‘defs’ element.

interface SVGDefsElement : SVGElement, SVGTests, SVGLangSpace, SVGExternalResourcesRequired, SVGStylable, SVGTransformable { };

5.11.5 Interface SVGDescElement

The SVGDescElement interface corresponds to the ‘desc’ element.

interface SVGDescElement : SVGElement, SVGLangSpace, SVGStylable { };

5.11.6 Interface SVGTitleElement

The SVGTitleElement interface corresponds to the ‘title’ element.

interface SVGTitleElement : SVGElement, SVGLangSpace, SVGStylable { };

5.11.7 Interface SVGSymbolElement

The SVGSymbolElement interface corresponds to the ‘symbol’ element.

interface SVGSymbolElement : SVGElement, SVGLangSpace, SVGExternalResourcesRequired, SVGStylable, SVGFitToViewBox { };

5.11.8 Interface SVGUseElement

The SVGUseElement interface corresponds to the ‘use’ element.

interface SVGUseElement : SVGElement, SVGURIReference, SVGTests, SVGLangSpace, SVGExternalResourcesRequired, SVGStylable, SVGTransformable { readonly attribute SVGAnimatedLength x; readonly attribute SVGAnimatedLength y; readonly attribute SVGAnimatedLength width; readonly attribute SVGAnimatedLength height; readonly attribute SVGElementInstance instanceRoot; readonly attribute SVGElementInstance animatedInstanceRoot; };

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 ofSVGElementInstance 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 asinstanceRoot. 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. AnSVGElementInstance represents a single node in the instance tree. The root object in the instance tree is pointed to by theinstanceRoot attribute on theSVGUseElement 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 thisSVGElementInstance 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 threeSVGElementInstance 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 ofSVGElementInstance 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, correspondingElement 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; };

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 itscorrespondingElement being the SVGRectElement object for the ‘rect’ element.

correspondingUseElement (readonly SVGUseElement)

The corresponding ‘use’ element to which thisSVGElementInstance object belongs. When ‘use’ elements are nested (e.g., a ‘use’ references another ‘use’ which references a graphics element such as a ‘rect’), then thecorrespondingUseElement 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 theSVGElementInstance which corresponds to the element which was directly referenced by the ‘use’ element, in which caseparentNode is null.

childNodes (readonly SVGElementInstanceList)

firstChild (readonly SVGElementInstance)

lastChild (readonly SVGElementInstance)

previousSibling (readonly SVGElementInstance)

nextSibling (readonly SVGElementInstance)

5.11.10 Interface SVGElementInstanceList

The SVGElementInstanceList interface provides the abstraction of an ordered collection of SVGElementInstance objects, without defining or constraining how this collection is implemented.

interface SVGElementInstanceList {

readonly attribute unsigned long length;

SVGElementInstance item(in unsigned long index); };

length (readonly unsigned long)

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

SVGElementInstance item(in unsigned long index)

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

  1. unsigned long index
    Index into the collection.

5.11.11 Interface SVGImageElement

The SVGImageElement interface corresponds to the ‘image’ element.

interface SVGImageElement : SVGElement, SVGURIReference, SVGTests, SVGLangSpace, SVGExternalResourcesRequired, SVGStylable, SVGTransformable { readonly attribute SVGAnimatedLength x; readonly attribute SVGAnimatedLength y; readonly attribute SVGAnimatedLength width; readonly attribute SVGAnimatedLength height; readonly attribute SVGAnimatedPreserveAspectRatio preserveAspectRatio; };

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)

5.11.12 Interface SVGSwitchElement

The SVGSwitchElement interface corresponds to the ‘switch’ element.

interface SVGSwitchElement : SVGElement, SVGTests, SVGLangSpace, SVGExternalResourcesRequired, SVGStylable, SVGTransformable { };

5.11.13 Interface GetSVGDocument

This interface provides access to an SVG document embedded by reference in another DOM-based language. The expectation is that the interface is implemented on DOM objects that allow such SVG document references, such as the DOM Element object that corresponds to an HTML‘object’ element. Such DOM objects are often also required to implement the EmbeddingElement defined in the Window specification [WINDOW].

This interface is deprecated and may be dropped from future versions of the SVG specification. Authors are suggested to use thecontentDocument attribute on the EmbeddingElement interface to obtain a referenced SVG document, if that interface is available.

interface GetSVGDocument { SVGDocument getSVGDocument(); };

SVGDocument getSVGDocument()

This method must return the Document object embedded content in an embedding element, or null if there is no document.

Note that this is equivalent to fetching the value of theEmbeddingElement::contentDocument attribute of the embedding element, if the EmbeddingElement interface is also implemented. The author is advised to check that the document element of the returnedDocument is indeed an ‘svg’ element instead of assuming that that will always be the case.

The Document object for the referenced document, or null if there is no document.