4 Basic Data Types and Interfaces


Contents


4.1 Basic data types

The common data types for SVG's properties and attributes fall into the following categories:


4.2 Recognized color keyword names

The following is the list of recognized color keywords that can be used as a keyword value for data type <color>:

alicebluergb(240, 248, 255)
antiquewhitergb(250, 235, 215)
aquargb( 0, 255, 255)
aquamarinergb(127, 255, 212)
azurergb(240, 255, 255)
beigergb(245, 245, 220)
bisquergb(255, 228, 196)
blackrgb( 0, 0, 0)
blanchedalmondrgb(255, 235, 205)
bluergb( 0, 0, 255)
bluevioletrgb(138, 43, 226)
brownrgb(165, 42, 42)
burlywoodrgb(222, 184, 135)
cadetbluergb( 95, 158, 160)
chartreusergb(127, 255, 0)
chocolatergb(210, 105, 30)
coralrgb(255, 127, 80)
cornflowerbluergb(100, 149, 237)
cornsilkrgb(255, 248, 220)
crimsonrgb(220, 20, 60)
cyanrgb( 0, 255, 255)
darkbluergb( 0, 0, 139)
darkcyanrgb( 0, 139, 139)
darkgoldenrodrgb(184, 134, 11)
darkgrayrgb(169, 169, 169)
darkgreenrgb( 0, 100, 0)
darkgreyrgb(169, 169, 169)
darkkhakirgb(189, 183, 107)
darkmagentargb(139, 0, 139)
darkolivegreenrgb( 85, 107, 47)
darkorangergb(255, 140, 0)
darkorchidrgb(153, 50, 204)
darkredrgb(139, 0, 0)
darksalmonrgb(233, 150, 122)
darkseagreenrgb(143, 188, 143)
darkslatebluergb( 72, 61, 139)
darkslategrayrgb( 47, 79, 79)
darkslategreyrgb( 47, 79, 79)
darkturquoisergb( 0, 206, 209)
darkvioletrgb(148, 0, 211)
deeppinkrgb(255, 20, 147)
deepskybluergb( 0, 191, 255)
dimgrayrgb(105, 105, 105)
dimgreyrgb(105, 105, 105)
dodgerbluergb( 30, 144, 255)
firebrickrgb(178, 34, 34)
floralwhitergb(255, 250, 240)
forestgreenrgb( 34, 139, 34)
fuchsiargb(255, 0, 255)
gainsbororgb(220, 220, 220)
ghostwhitergb(248, 248, 255)
goldrgb(255, 215, 0)
goldenrodrgb(218, 165, 32)
grayrgb(128, 128, 128)
greyrgb(128, 128, 128)
greenrgb( 0, 128, 0)
greenyellowrgb(173, 255, 47)
honeydewrgb(240, 255, 240)
hotpinkrgb(255, 105, 180)
indianredrgb(205, 92, 92)
indigorgb( 75, 0, 130)
ivoryrgb(255, 255, 240)
khakirgb(240, 230, 140)
lavenderrgb(230, 230, 250)
lavenderblushrgb(255, 240, 245)
lawngreenrgb(124, 252, 0)
lemonchiffonrgb(255, 250, 205)
lightbluergb(173, 216, 230)
lightcoralrgb(240, 128, 128)
lightcyanrgb(224, 255, 255)
lightgoldenrodyellowrgb(250, 250, 210)
lightgrayrgb(211, 211, 211)
lightgreenrgb(144, 238, 144)
lightgreyrgb(211, 211, 211)
    
lightpinkrgb(255, 182, 193)
lightsalmonrgb(255, 160, 122)
lightseagreenrgb( 32, 178, 170)
lightskybluergb(135, 206, 250)
lightslategrayrgb(119, 136, 153)
lightslategreyrgb(119, 136, 153)
lightsteelbluergb(176, 196, 222)
lightyellowrgb(255, 255, 224)
limergb( 0, 255, 0)
limegreenrgb( 50, 205, 50)
linenrgb(250, 240, 230)
magentargb(255, 0, 255)
maroonrgb(128, 0, 0)
mediumaquamarinergb(102, 205, 170)
mediumbluergb( 0, 0, 205)
mediumorchidrgb(186, 85, 211)
mediumpurplergb(147, 112, 219)
mediumseagreenrgb( 60, 179, 113)
mediumslatebluergb(123, 104, 238)
mediumspringgreenrgb( 0, 250, 154)
mediumturquoisergb( 72, 209, 204)
mediumvioletredrgb(199, 21, 133)
midnightbluergb( 25, 25, 112)
mintcreamrgb(245, 255, 250)
mistyrosergb(255, 228, 225)
moccasinrgb(255, 228, 181)
navajowhitergb(255, 222, 173)
navyrgb( 0, 0, 128)
oldlacergb(253, 245, 230)
olivergb(128, 128, 0)
olivedrabrgb(107, 142, 35)
orangergb(255, 165, 0)
orangeredrgb(255, 69, 0)
orchidrgb(218, 112, 214)
palegoldenrodrgb(238, 232, 170)
palegreenrgb(152, 251, 152)
paleturquoisergb(175, 238, 238)
palevioletredrgb(219, 112, 147)
papayawhiprgb(255, 239, 213)
peachpuffrgb(255, 218, 185)
perurgb(205, 133, 63)
pinkrgb(255, 192, 203)
plumrgb(221, 160, 221)
powderbluergb(176, 224, 230)
purplergb(128, 0, 128)
redrgb(255, 0, 0)
rosybrownrgb(188, 143, 143)
royalbluergb( 65, 105, 225)
saddlebrownrgb(139, 69, 19)
salmonrgb(250, 128, 114)
sandybrownrgb(244, 164, 96)
seagreenrgb( 46, 139, 87)
seashellrgb(255, 245, 238)
siennargb(160, 82, 45)
silverrgb(192, 192, 192)
skybluergb(135, 206, 235)
slatebluergb(106, 90, 205)
slategrayrgb(112, 128, 144)
slategreyrgb(112, 128, 144)
snowrgb(255, 250, 250)
springgreenrgb( 0, 255, 127)
steelbluergb( 70, 130, 180)
tanrgb(210, 180, 140)
tealrgb( 0, 128, 128)
thistlergb(216, 191, 216)
tomatorgb(255, 99, 71)
turquoisergb( 64, 224, 208)
violetrgb(238, 130, 238)
wheatrgb(245, 222, 179)
whitergb(255, 255, 255)
whitesmokergb(245, 245, 245)
yellowrgb(255, 255, 0)
yellowgreenrgb(154, 205, 50)
  

4.3 Basic DOM interfaces

The following interfaces are defined below: SVGElement, SVGList, SVGLengthList, SVGAnimatedLengthList, SVGAnimatedString, SVGAnimatedBoolean, SVGAnimatedEnumeration, SVGAngle, SVGAnimatedAngle, SVGColor, SVGICCColor, SVGAnimatedInteger, SVGLength, SVGAnimatedLength, SVGAnimatedNumber, SVGNumberList, SVGAnimatedNumberList, SVGRect, SVGAnimatedRect, SVGUnitTypes, SVGStylable, SVGTransformable, SVGTests, SVGLangSpace, SVGExternalResourcesRequired, SVGFitToViewBox, SVGZoomAndPan, SVGViewSpec, SVGURIReference, SVGCSSRule, SVGRenderingIntent.


Interface SVGElement

All of the SVG DOM interfaces that correspond directly to elements in the SVG language (e.g., the SVGPathElement interface corresponds directly to the 'path' element in the language) are derivative from base class SVGElement.


IDL Definition
interface SVGElement : Element { 
           attribute DOMString id;
                       // raises DOMException on setting
  readonly attribute SVGSVGElement ownerSVGElement;
  readonly attribute SVGElement viewportElement;
};

Attributes
DOMString id
The value of the id attribute on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly SVGSVGElement ownerSVGElement
The nearest ancestor 'svg' element. Null if the given element is the outermost 'svg' element.
readonly SVGElement viewportElement
The element which established the current viewport. Often, the nearest ancestor 'svg' element. Null if this is the given element is the outermost 'svg' element.

Interface SVGList

This interface defines a set of generic list handling attributes and methods.


IDL Definition
interface SVGList { 

  readonly attribute unsigned long numberOfItems;

  void   clear (  )
                  raises( DOMException );
  Object initialize ( in Object newItem )
                  raises( DOMException, SVGException );
  Object createItem (  );
  Object getItem ( in unsigned long index )
                  raises( DOMException );
  Object insertItemBefore ( in Object newItem, in unsigned long index )
                  raises( DOMException, SVGException );
  Object replaceItem ( in Object newItem, in unsigned long index )
                  raises( DOMException, SVGException );
  Object removeItem ( in unsigned long index )
                  raises( DOMException );
  Object appendItem ( in Object newItem )
                  raises( DOMException, SVGException );
};

Attributes
readonly unsigned long numberOfItems
The number of items in the list.
Methods
clear
Clears all existing current items from the list, with the result being an empty list.
No Parameters
No Return Value
Exceptions
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
initialize
Clears all existing current items from the list and re-initializes the list to hold the single item specified by the parameter.
Parameters
in Object newItem The item which should become the only member of the list.
Return value
Object The item being inserted into the list.
Exceptions
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
SVGException
SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
createItem
Creates an initialized item of the appropriate type for this list.
No Parameters
Return value
Object The created item.
No Exceptions
getItem
Returns the specified item from the list.
Parameters
in unsigned long index The index of the item from the list which is to be returned. The first item is number 0.
Return value
Object The selected item.
Exceptions
DOMException
INDEX_SIZE_ERR: Raised if the index number is negative or greater than or equal to numberOfItems.
insertItemBefore
Inserts a new item into the list at the specified position. The first item is number 0.
Parameters
in Object newItem The item which is to be inserted into the list.
in unsigned long index The index of the item before which the new item is to be inserted. The first item is number 0.
If the index is less than or equal to 0, then the new item is inserted at the front of the list. If the index is greater than or equal to numberOfItems, then the new item is appended to the end of the list.
Return value
Object The inserted item.
Exceptions
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
SVGException
SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
replaceItem
Replaces an existing item in the list with a new item.
Parameters
in Object newItem The item which is to be inserted into the list.
in unsigned long index The index of the item which is to be replaced. The first item is number 0.
Return value
Object The inserted item.
Exceptions
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
INDEX_SIZE_ERR: Raised if the index number is negative or greater than or equal to numberOfItems.
SVGException
SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.
removeItem
Removes an existing item from the list.
Parameters
in unsigned long index The index of the item which is to be removed. The first item is number 0.
Return value
Object The removed item.
Exceptions
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
INDEX_SIZE_ERR: Raised if the index number is negative or greater than or equal to numberOfItems.
appendItem
Inserts a new item at the end of the list.
Parameters
in Object newItem The item which is to be inserted into the list. The first item is number 0.
Return value
Object The inserted item.
Exceptions
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the list cannot be modified.
SVGException
SVG_WRONG_TYPE_ERR: Raised if parameter newItem is the wrong type of object for the given list.

Interface SVGLengthList

Used for values that can be expressed as an array of SVGLengths.

The various methods inherited from SVGList, which are defined in SVGList to accept parameters and return values of type Object, must receive parameters of type SVGLength and return values of type SVGLength.


IDL Definition
interface SVGLengthList : SVGList {};


Interface SVGAnimatedLengthList

Used for attributes of type SVGLengthList which can be animated.

IDL Definition
interface SVGAnimatedLengthList { 

           attribute SVGLengthList baseVal;
                       // raises DOMException on setting
  readonly attribute SVGLengthList animVal;
};

Attributes
SVGLengthList baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly SVGLengthList animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGAnimatedString

Used for attributes of type DOMString which can be animated.

IDL Definition
interface SVGAnimatedString { 

           attribute DOMString baseVal;
                       // raises DOMException on setting
  readonly attribute DOMString animVal;
};

Attributes
DOMString baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly DOMString animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGAnimatedBoolean

Used for attributes of type boolean which can be animated.

IDL Definition
interface SVGAnimatedBoolean { 

           attribute boolean baseVal;
                       // raises DOMException on setting
  readonly attribute boolean animVal;
};

Attributes
boolean baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly boolean animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGAnimatedEnumeration

Used for attributes whose value must be a constant from a particular enumeration and which can be animated.

IDL Definition
interface SVGAnimatedEnumeration { 

           attribute unsigned short baseVal;
                       // raises DOMException on setting
  readonly attribute unsigned short animVal;
};

Attributes
unsigned short baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly unsigned short animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGAngle

The SVGAngle interface corresponds to the <angle> basic data type.


IDL Definition
interface SVGAngle { 

  // Angle Unit Types
  const unsigned short SVG_ANGLETYPE_UNKNOWN     = 0;
  const unsigned short SVG_ANGLETYPE_UNSPECIFIED = 1;
  const unsigned short SVG_ANGLETYPE_DEG         = 2;
  const unsigned short SVG_ANGLETYPE_RAD         = 3;
  const unsigned short SVG_ANGLETYPE_GRAD        = 4;

  readonly attribute unsigned short unitType;
           attribute float          value;
                       // raises DOMException on setting
           attribute float          valueInSpecifiedUnits;
                       // raises DOMException on setting
           attribute DOMString      valueAsString;
                       // raises DOMException on setting

  void newValueSpecifiedUnits ( in unsigned short unitType, in float valueInSpecifiedUnits );
  void convertToSpecifiedUnits ( in unsigned short unitType );
};

Definition group Angle Unit Types
Defined constants
SVG_ANGLETYPE_UNKNOWN The unit type is not one of predefined unit types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.
SVG_ANGLETYPE_UNSPECIFIED No unit type was provided (i.e., a unitless value was specified). For angles, a unitless value is treated the same as if degrees were specified.
SVG_ANGLETYPE_DEG The unit type was explicitly set to degrees.
SVG_ANGLETYPE_RAD The unit type is radians.
SVG_ANGLETYPE_GRAD The unit type is grads.
Attributes
readonly unsigned short unitType
The type of the value as specified by one of the constants specified above.
float value
The angle value as a floating point value, in degrees. Setting this attribute will cause valueInSpecifiedUnits and valueAsString to be updated automatically to reflect this setting.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
float valueInSpecifiedUnits
The angle value as a floating point value, in the units expressed by unitType. Setting this attribute will cause value and valueAsString to be updated automatically to reflect this setting.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMString valueAsString
The angle value as a string value, in the units expressed by unitType. Setting this attribute will cause value and valueInSpecifiedUnits to be updated automatically to reflect this setting.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Methods
newValueSpecifiedUnits
Reset the value as a number with an associated unitType, thereby replacing the values for all of the attributes on the object.
Parameters
in unsigned short unitType The unitType for the angle value (e.g., SVG_ANGLETYPE_DEG).
in float valueInSpecifiedUnits The angle value.
No Return Value
No Exceptions
convertToSpecifiedUnits
Preserve the same value, but convert to the specified unitType. Object attributes unitType, valueAsSpecified and valueAsString might be modified as a result of this method.
Parameters
in unsigned short unitType The unitType to switch to (e.g., SVG_ANGLETYPE_DEG).
No Return Value
No Exceptions

Interface SVGAnimatedAngle

Corresponds to all properties and attributes whose values can be basic type 'angle' and which are animatable.

IDL Definition
interface SVGAnimatedAngle { 

           attribute SVGAngle baseVal;
                       // raises DOMException on setting
  readonly attribute SVGAngle animVal;
};

Attributes
SVGAngle baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly SVGAngle animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGColor

The SVGColor corresponds to color value definition for properties 'stop-color', 'flood-color' and 'lighting-color' and is a base class for interface SVGPaint. It incorporates SVG's extended notion of color, which incorporates ICC-based color specifications.

Interface SVGColor does not correspond to the <color> basic data type. For the <color> basic data type, the applicable DOM interfaces are defined in [DOM2-CSS]; in particular, see the [DOM2-CSS-RGBCOLOR].


IDL Definition
interface SVGColor : css::CSSValue { 
  // Color Types
  const unsigned short SVG_COLORTYPE_UNKNOWN           = 0;
  const unsigned short SVG_COLORTYPE_RGBCOLOR          = 1;
  const unsigned short SVG_COLORTYPE_RGBCOLOR_ICCCOLOR = 2;

  readonly attribute unsigned short colorType;
  readonly attribute css::RGBColor       rgbColor;
  readonly attribute SVGICCColor    iccColor;

  void        setRGBColor ( in css::RGBColor rgbColor );
  void        setRGBColorICCColor ( in css::RGBColor rgbColor, in SVGICCColor iccColor );
  css::RGBColor    createRGBColor (  );
  SVGICCColor createSVGICCColor (  );
};

Definition group Color Types
Defined constants
SVG_COLORTYPE_UNKNOWN The color type is not one of predefined types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.
SVG_COLORTYPE_RGBCOLOR An sRGB color has been specified without an alternative ICC color specification.
SVG_COLORTYPE_RGBCOLOR_ICCCOLOR An sRGB color has been specified along with an alternative ICC color specification.
Attributes
readonly unsigned short colorType
The type of the value as specified by one of the constants specified above.
readonly css::RGBColor rgbColor
The color specified in the sRGB color space.
readonly SVGICCColor iccColor
The alternate ICC color specification.
Methods
setRGBColor
Modifies the color value to be the specified sRGB color without an alternate ICC color specification.
Parameters
in css::RGBColor rgbColor The new sRGB color specification.
No Return Value
No Exceptions
setRGBColorICCColor
Modifies the color value to be the specified sRGB color with an alternate ICC color specification.
Parameters
in css::RGBColor rgbColor The new sRGB color specification.
in SVGICCColor iccColor The alternate ICC color specification.
No Return Value
No Exceptions
createRGBColor
Returns an RGBColor object which is initialized to red=green=blue=0.
No Parameters
Return value
css::RGBColor The returned RGBColor object.
No Exceptions
createSVGICCColor
Returns an SVGICCColor object which is initialized to an empty list of colors and a null for the colorProfile string.
No Parameters
Return value
SVGICCColor The returned SVGICCColor object.
No Exceptions

Interface SVGICCColor

The SVGICCColor expresses an ICC-based color specification and is a base class for interface SVGColor


IDL Definition
interface SVGICCColor { 

           attribute DOMString colorProfile;
                       // raises DOMException on setting
  readonly attribute SVGList   colors;
};

Attributes
DOMString colorProfile

The name of the color profile, which is the first parameter of an ICC color specification.

Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly SVGList colors

The list of color values that define this ICC color. Each color value is an arbitrary floating point number.

The various methods from SVGList, which are defined to accept parameters and return values of type Object, must receive parameters of type float and return values of type float.


Interface SVGAnimatedInteger

Used for attributes of basic type 'integer' which can be animated.

IDL Definition
interface SVGAnimatedInteger { 

           attribute long baseVal;
                       // raises DOMException on setting
  readonly attribute long animVal;
};

Attributes
long baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly long animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGLength

The SVGLength interface corresponds to the <length> basic data type.


IDL Definition
interface SVGLength { 

  // Length Unit Types
  const unsigned short SVG_LENGTHTYPE_UNKNOWN    = 0;
  const unsigned short SVG_LENGTHTYPE_NUMBER     = 1;
  const unsigned short SVG_LENGTHTYPE_PERCENTAGE = 2;
  const unsigned short SVG_LENGTHTYPE_EMS        = 3;
  const unsigned short SVG_LENGTHTYPE_EXS        = 4;
  const unsigned short SVG_LENGTHTYPE_PX         = 5;
  const unsigned short SVG_LENGTHTYPE_CM         = 6;
  const unsigned short SVG_LENGTHTYPE_MM         = 7;
  const unsigned short SVG_LENGTHTYPE_IN         = 8;
  const unsigned short SVG_LENGTHTYPE_PT         = 9;
  const unsigned short SVG_LENGTHTYPE_PC         = 10;

  readonly attribute unsigned short unitType;
           attribute float          value;
                       // raises DOMException on setting
           attribute float          valueInSpecifiedUnits;
                       // raises DOMException on setting
           attribute DOMString      valueAsString;
                       // raises DOMException on setting

  void newValueSpecifiedUnits ( in unsigned short unitType, in float valueInSpecifiedUnits );
  void convertToSpecifiedUnits ( in unsigned short unitType );
};

Definition group Length Unit Types
Defined constants
SVG_LENGTHTYPE_UNKNOWN The unit type is not one of predefined unit types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.
SVG_LENGTHTYPE_NUMBER No unit type was provided (i.e., a unitless value was specified), which indicates a value in user units.
SVG_LENGTHTYPE_PERCENTAGE A percentage value was specified.
SVG_LENGTHTYPE_EMS A value was specified using the "em" units defined in CSS2.
SVG_LENGTHTYPE_EXS A value was specified using the "ex" units defined in CSS2.
SVG_LENGTHTYPE_PX A value was specified using the "px" units defined in CSS2.
SVG_LENGTHTYPE_CM A value was specified using the "cm" units defined in CSS2.
SVG_LENGTHTYPE_MM A value was specified using the "mm" units defined in CSS2.
SVG_LENGTHTYPE_IN A value was specified using the "in" units defined in CSS2.
SVG_LENGTHTYPE_PT A value was specified using the "pt" units defined in CSS2.
SVG_LENGTHTYPE_PC A value was specified using the "pc" units defined in CSS2.
Attributes
readonly unsigned short unitType
The type of the value as specified by one of the constants specified above.
float value
The value as an floating point value, in user units. Setting this attribute will cause valueInSpecifiedUnits and valueAsString to be updated automatically to reflect this setting.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
float valueInSpecifiedUnits
The value as an floating point value, in the units expressed by unitType. Setting this attribute will cause value and valueAsString to be updated automatically to reflect this setting.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMString valueAsString
The value as a string value, in the units expressed by unitType. Setting this attribute will cause value and valueInSpecifiedUnits to be updated automatically to reflect this setting.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Methods
newValueSpecifiedUnits
Reset the value as a number with an associated unitType, thereby replacing the values for all of the attributes on the object.
Parameters
in unsigned short unitType The unitType for the value (e.g., SVG_LENGTHTYPE_MM).
in float valueInSpecifiedUnits The new value.
No Return Value
No Exceptions
convertToSpecifiedUnits
Preserve the same value, but convert to the specified unitType. Object attributes unitType, valueAsSpecified and valueAsString might be modified as a result of this method,
Parameters
in unsigned short unitType The unitType to switch to (e.g., SVG_LENGTHTYPE_MM).
No Return Value
No Exceptions

Interface SVGAnimatedLength

Used for attributes of basic type 'length' which can be animated.

IDL Definition
interface SVGAnimatedLength { 

           attribute SVGLength baseVal;
                       // raises DOMException on setting
  readonly attribute SVGLength animVal;
};

Attributes
SVGLength baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly SVGLength animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGAnimatedNumber

Used for attributes of basic type 'number' which can be animated.

IDL Definition
interface SVGAnimatedNumber { 

           attribute float baseVal;
                       // raises DOMException on setting
  readonly attribute float animVal;
};

Attributes
float baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly float animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGNumberList

Used for values that can be expressed as an array of numbers (i.e., each entry is a 'float').

The various methods inherited from SVGList, which are defined in SVGList to accept parameters and return values of type Object, must receive parameters of type float and return values of type float.


IDL Definition
interface SVGNumberList : SVGList {};


Interface SVGAnimatedNumberList

Used for attributes which take a list of numbers and which can be animated.

IDL Definition
interface SVGAnimatedNumberList { 

           attribute SVGNumberList baseVal;
                       // raises DOMException on setting
  readonly attribute SVGNumberList animVal;
};

Attributes
SVGNumberList baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly SVGNumberList animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGRect

Rectangles are defined as consisting of a (x,y) coordinate pair identifying a minimum X value, a minimum Y value, and a width and height, which are usually constrained to be non-negative.


IDL Definition
interface SVGRect { 

           attribute float x;
                       // raises DOMException on setting
           attribute float y;
                       // raises DOMException on setting
           attribute float width;
                       // raises DOMException on setting
           attribute float height;
                       // raises DOMException on setting
};

Attributes
float x
Corresponds to attribute x on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
float y
Corresponds to attribute y on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
float width
Corresponds to attribute width on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
float height
Corresponds to attribute height on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Interface SVGAnimatedRect

Used for attributes of type SVGRect which can be animated.

IDL Definition
interface SVGAnimatedRect { 

           attribute SVGRect baseVal;
                       // raises DOMException on setting
  readonly attribute SVGRect animVal;
};

Attributes
SVGRect baseVal
The base value of the given attribute before applying any animations.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly SVGRect animVal
If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

Interface SVGUnitTypes

The SVGUnitTypes interface defines a commonly used set of constants and is a base interface used by SVGGradientElement, SVGPatternElement, SVGClipPathElement, SVGMaskElement, and SVGFilterElement.


IDL Definition
interface SVGUnitTypes { 

  // Unit Types
  const unsigned short SVG_UNIT_TYPE_UNKNOWN           = 0;
  const unsigned short SVG_UNIT_TYPE_USERSPACEONUSE    = 1;
  const unsigned short SVG_UNIT_TYPE_USERSPACE         = 2;
  const unsigned short SVG_UNIT_TYPE_OBJECTBOUNDINGBOX = 3;
};

Definition group Unit Types
Defined constants
SVG_UNIT_TYPE_UNKNOWN The type is not one of predefined types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.
SVG_UNIT_TYPE_USERSPACEONUSE Corresponds to value userSpaceOnUse.
SVG_UNIT_TYPE_USERSPACE Corresponds to value userSpace.
SVG_UNIT_TYPE_OBJECTBOUNDINGBOX Corresponds to value objectBoundingBox.

Interface SVGStylable


IDL Definition
interface SVGStylable { 

  readonly attribute SVGAnimatedString className;
  readonly attribute css::CSSStyleDeclaration style;

  css::CSSValue getPresentationAttribute ( in DOMString name );
  css::CSSValue getAnimatedPresentationAttribute ( in DOMString name );
};

Attributes
readonly SVGAnimatedString className
Corresponds to attribute class on the given element.
readonly css::CSSStyleDeclaration style
Corresponds to attribute style on the given element. If the user agent does not support styling with CSS, then this attribute must always have the value of null.
Methods
getPresentationAttribute
Returns the base (i.e., static) value of a given presentation attribute as an object of type CSSValue. The returned object is live; changes to the objects represent immediate changes to the objects to which the CSSValue is attached.
Parameters
in DOMString name Retrieves a "presentation attribute" by name.
Return value
css::CSSValue

The static/base value of the given presentation attribute as a CSSValue, or NULL if the given attribute does not have a specified value.

If the given attribute or property is being animated, contains the current animated value of the attribute or property. If the given attribute or property is not currently being animated, contains the same value as 'baseVal'.

No Exceptions
getAnimatedPresentationAttribute
Returns the current animated value of a given presentation attribute as an object of type CSSValue. The returned object is readonly. An attempt to modify the return value will generate an exception.
Parameters
in DOMString name Retrieves the current animated value of a "presentation attribute" by name.
Return value
css::CSSValue The current animated value of the given presentation attribute as a CSSValue, or NULL if the given attribute does not have a specified value.
No Exceptions

Interface SVGTransformable

Interface SVGTransformable contains properties and methods that apply to all elements which have attribute transform.


IDL Definition
interface SVGTransformable { 

  readonly attribute SVGElement              nearestViewportElement;
  readonly attribute SVGElement              farthestViewportElement;
  readonly attribute SVGAnimatedTransformList transform;

  SVGRect   getBBox (  );
  SVGMatrix getCTM (  );
  SVGMatrix getScreenCTM (  );
  SVGMatrix getTransformToElement ( in SVGElement element )
                  raises( SVGException );
};

Attributes
readonly SVGElement nearestViewportElement
The element which established the current viewport. Often, the nearest ancestor 'svg' element. Null if the current element is the outermost 'svg' element.
readonly SVGElement farthestViewportElement
The farthest ancestor 'svg' element. Null if the current element is the outermost 'svg' element.
readonly SVGAnimatedTransformList transform
Corresponds to attribute transform on the given element.
Methods
getBBox
Returns the tight bounding box in current user space (i.e., after application of the transform attribute) on the geometry of all contained graphics elements, exclusive of stroke-width and filter effects).
No Parameters
Return value
SVGRect An SVGRect object that defines the bounding box.
No Exceptions
getCTM
Returns the transformation matrix from current user units (i.e., after application of the transform attribute) to the viewport coordinate system for the nearestViewportElement.
No Parameters
Return value
SVGMatrix An SVGMatrix object that defines the CTM.
No Exceptions
getScreenCTM
Returns the transformation matrix from current user units (i.e., after application of the transform attribute) to the parent user agent's notice of a "pixel". For display devices, ideally this represents a physical screen pixel. For other devices or environments where physical pixel sizes are not known, then an algorithm similar to the CSS2 definition of a "pixel" can be used instead.
No Parameters
Return value
SVGMatrix An SVGMatrix object that defines the given transformation matrix.
No Exceptions
getTransformToElement
Returns the transformation matrix from the user coordinate system on the current element (after application of the transform attribute) to the user coordinate system on element (after application of its transform attribute).
Parameters
in SVGElement element The target element.
Return value
SVGMatrix An SVGMatrix object that defines the transformation.
Exceptions
SVGException
SVG_MATRIX_NOT_INVERTABLE: Raised if the currently defined transformation matrices make it impossible to compute the given matrix (e.g., because one of the transformations is singular).

Interface SVGTests

Interface SVGTests defines an interface which applies to all elements which have attributes requiredFeatures, requiredExtensions and systemLanguage.


IDL Definition
interface SVGTests { 

           attribute SVGList requiredFeatures;
                       // raises DOMException on setting
           attribute SVGList requiredExtensions;
                       // raises DOMException on setting
           attribute SVGList systemLanguage;
                       // raises DOMException on setting

  boolean hasExtension ( in DOMString extension );
};

Attributes
SVGList requiredFeatures
Corresponds to attribute requiredFeatures on the given element. The various methods from SVGList, which are defined to accept parameters and return values of type Object, must receive parameters of type DOMString and return values of type DOMString.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
SVGList requiredExtensions
Corresponds to attribute requiredExtensions on the given element. The various methods from SVGList, which are defined to accept parameters and return values of type Object, must receive parameters of type DOMString and return values of type DOMString.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
SVGList systemLanguage
Corresponds to attribute systemLanguage on the given element. The various methods from SVGList, which are defined to accept parameters and return values of type Object, must receive parameters of type DOMString and return values of type DOMString.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
Methods
hasExtension
Returns true if the user agent supports the given extension, specified by a URI.
Parameters
in DOMString extension The name of the extension, expressed as a URI.
Return value
boolean True or false, depending on whether the given extension is supported.
No Exceptions

Interface SVGLangSpace

Interface SVGLangSpace defines an interface which applies to all elements which have attributes xml:lang and xml:space.


IDL Definition
interface SVGLangSpace { 

           attribute DOMString xmllang;
                       // raises DOMException on setting
           attribute DOMString xmlspace;
                       // raises DOMException on setting
};

Attributes
DOMString xmllang
Corresponds to attribute xml:lang on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMString xmlspace
Corresponds to attribute xml:space on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Interface SVGExternalResourcesRequired

Interface SVGExternalResourcesRequired defines an interface which applies to all elements where this element or one of its descendants can reference an external resource.


IDL Definition
interface SVGExternalResourcesRequired { 

  readonly attribute SVGAnimatedBoolean externalResourcesRequired;
};

Attributes
readonly SVGAnimatedBoolean externalResourcesRequired
Corresponds to attribute externalResourcesRequired on the given element.

Interface SVGFitToViewBox

Interface SVGFitToViewBox defines DOM attributes that apply to elements which have XML attributes viewBox and preserveAspectRatio.


IDL Definition
interface SVGFitToViewBox { 

  readonly attribute SVGAnimatedRect                viewBox;
  readonly attribute SVGAnimatedPreserveAspectRatio preserveAspectRatio;
};

Attributes
readonly SVGAnimatedRect viewBox
Corresponds to attribute viewBox on the given element.
readonly SVGAnimatedPreserveAspectRatio preserveAspectRatio
Corresponds to attribute preserveAspectRatio on the given element.

Interface SVGZoomAndPan

The SVGZoomAndPan interface defines attribute "zoomAndPan" and associated constants.

IDL Definition
interface SVGZoomAndPan { 

  // Zoom and Pan Types
  const unsigned short SVG_ZOOMANDPAN_UNKNOWN   = 0;
  const unsigned short SVG_ZOOMANDPAN_DISABLE = 1;
  const unsigned short SVG_ZOOMANDPAN_MAGNIFY = 2;
  const unsigned short SVG_ZOOMANDPAN_ZOOM    = 3;

           attribute unsigned short zoomAndPan;
                       // raises DOMException on setting
};

Definition group Zoom and Pan Types
Defined constants
SVG_ZOOMANDPAN_UNKNOWN The enumeration was set to a value that is not one of predefined types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.
SVG_ZOOMANDPAN_DISABLE Corresponds to value disable.
SVG_ZOOMANDPAN_MAGNIFY Corresponds to value magnify.
SVG_ZOOMANDPAN_ZOOM Corresponds to value zoom.
Attributes
unsigned short zoomAndPan
Corresponds to attribute zoomAndPan on the given element. The value must be one of the zoom and pan constants specified above.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Interface SVGViewSpec

The interface corresponds to an SVG View Specification.


IDL Definition
interface SVGViewSpec : 
                SVGZoomAndPan,
                SVGFitToViewBox { 

           attribute SVGTransformList transform;
                       // raises DOMException on setting
           attribute SVGElement       viewTarget;
                       // raises DOMException on setting
  readonly attribute DOMString        viewBoxString;
  readonly attribute DOMString        preserveAspectRatioString;
  readonly attribute DOMString        transformString;
  readonly attribute DOMString        viewTargetString;
};

Attributes
SVGTransformList transform
Corresponds to the transform setting on the SVG View Specification.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
SVGElement viewTarget
Corresponds to the viewTarget setting on the SVG View Specification.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly DOMString viewBoxString
Corresponds to the viewBox setting on the SVG View Specification.
readonly DOMString preserveAspectRatioString
Corresponds to the preserveAspectRatio setting on the SVG View Specification.
readonly DOMString transformString
Corresponds to the transform setting on the SVG View Specification.
readonly DOMString viewTargetString
Corresponds to the viewTarget setting on the SVG View Specification.

Interface SVGURIReference

Interface SVGURIReference defines an interface which applies to all elements which have the collection of XLink attributes, such as xlink:href, which define a URI reference.


IDL Definition
interface SVGURIReference { 

           attribute DOMString xlinkType;
                       // raises DOMException on setting
           attribute DOMString xlinkRole;
                       // raises DOMException on setting
           attribute DOMString xlinkArcRole;
                       // raises DOMException on setting
           attribute DOMString xlinkTitle;
                       // raises DOMException on setting
           attribute DOMString xlinkShow;
                       // raises DOMException on setting
           attribute DOMString xlinkActuate;
                       // raises DOMException on setting
  readonly attribute SVGAnimatedString href;
};

Attributes
DOMString xlinkType
Corresponds to attribute xlink:type on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMString xlinkRole
Corresponds to attribute xlink:role on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMString xlinkArcRole
Corresponds to attribute xlink:arcrole on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMString xlinkTitle
Corresponds to attribute xlink:title on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMString xlinkShow
Corresponds to attribute xlink:show on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMString xlinkActuate
Corresponds to attribute xlink:actuate on the given element.
Exceptions on setting
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
readonly SVGAnimatedString href
Corresponds to attribute xlink:href on the given element.

Interface SVGCSSRule

SVG extends interface CSSRule with interface SVGCSSRule by adding an SVGColorProfileRule rule to allow for specification of ICC-based color.

It is likely that this extension will become part of a future version of CSS and DOM.


IDL Definition
interface SVGCSSRule : css::CSSRule { 
  // Additional CSS RuleType to support ICC color specifications
  const unsigned short COLOR_PROFILE_RULE = 7;
};

Definition group Additional CSS RuleType to support ICC color specifications
Defined constants
COLOR_PROFILE_RULE The rule is an @color-profile.

Interface SVGRenderingIntent

The SVGRenderingIntent defines the enumerated list of possible values for 'rendering-intent' attributes or descriptors.


IDL Definition
interface SVGRenderingIntent { 

  // Rendering Intent Types
  const unsigned short RENDERING_INTENT_UNKNOWN               = 0;
  const unsigned short RENDERING_INTENT_AUTO                  = 1;
  const unsigned short RENDERING_INTENT_PERCEPTUAL            = 2;
  const unsigned short RENDERING_INTENT_RELATIVE_COLORIMETRIC = 3;
  const unsigned short RENDERING_INTENT_SATURATION            = 4;
  const unsigned short RENDERING_INTENT_ABSOLUTE_COLORIMETRIC = 5;
};

Definition group Rendering Intent Types
Defined constants
RENDERING_INTENT_UNKNOWN The type is not one of predefined types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.
RENDERING_INTENT_AUTO Corresponds to a value of auto.
RENDERING_INTENT_PERCEPTUAL Corresponds to a value of perceptual.
RENDERING_INTENT_RELATIVE_COLORIMETRIC Corresponds to a value of relative-colorimetric.
RENDERING_INTENT_SATURATION Corresponds to a value of saturation.
RENDERING_INTENT_ABSOLUTE_COLORIMETRIC Corresponds to a value of absolute-colorimetric.