CSSPrimitiveValue
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
The CSSPrimitiveValue
interface derives from the CSSValue
interface and represents the current computed value of a CSS property.
Note: This interface was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do not implement it.
To achieve your purpose, you can use:
- the untyped CSS Object Model, widely supported, or
- the modern CSS Typed Object Model API, less supported and considered experimental.
This interface represents a single CSS value. It may be used to determine the value of a specific style property currently set in a block or to set a specific style property explicitly within the block. An instance of this interface might be obtained from the getPropertyCSSValue()
method of the CSSStyleDeclaration
interface. A CSSPrimitiveValue
object only occurs in a context of a CSS property.
Conversions are allowed between absolute values (from millimeters to centimeters, from degrees to radians, and so on) but not between relative values. (For example, a pixel value cannot be converted to a centimeter value.) Percentage values can't be converted since they are relative to the parent value (or another property value). There is one exception for color percentage values: since a color percentage value is relative to the range 0-255, a color percentage value can be converted to a number (see also the RGBColor
interface).
Properties
Inherits properties from its parent,
.CSSValue
-
CSSPrimitiveValue.primitiveType
Read only -
An
unsigned short
representing the type of the value. Possible values are:Constant Description CSS_ATTR
The value is an attr()
function. The value can be obtained by using thegetStringValue()
method.CSS_CM
The value is a <length>
in centimeters. The value can be obtained by using thegetFloatValue()
method.CSS_COUNTER
The value is a counter or counters function. The value can be obtained by using the getCounterValue()
method.CSS_DEG
The value is an <angle>
in degrees. The value can be obtained by using thegetFloatValue()
method.CSS_DIMENSION
The value is a <number>
with an unknown dimension. The value can be obtained by using thegetFloatValue()
method.CSS_EMS
The value is a <length>
in em units. The value can be obtained by using thegetFloatValue()
method.CSS_EXS
The value is a <length>
in ex units. The value can be obtained by using thegetFloatValue()
method.CSS_GRAD
The value is an <angle>
in grads. The value can be obtained by using thegetFloatValue()
method.CSS_HZ
The value is a <frequency>
in Hertz. The value can be obtained by using the getFloatValue method.CSS_IDENT
The value is an identifier. The value can be obtained by using the getStringValue()
method.CSS_IN
The value is a <length>
in inches. The value can be obtained by using thegetFloatValue()
method.CSS_KHZ
The value is a <frequency>
in Kilohertz. The value can be obtained by using thegetFloatValue()
method.CSS_MM
The value is a <length>
in millimeters. The value can be obtained by using thegetFloatValue()
method.CSS_MS
The value is a <time>
in milliseconds. The value can be obtained by using thegetFloatValue()
method.CSS_NUMBER
The value is a simple <number>
. The value can be obtained by using thegetFloatValue()
method.CSS_PC
The value is a <length>
in picas. The value can be obtained by using thegetFloatValue()
method.CSS_PERCENTAGE
The value is a <percentage>
. The value can be obtained by using thegetFloatValue()
method.CSS_PT
The value is a <length>
in points. The value can be obtained by using thegetFloatValue()
method.CSS_PX
The value is a <length>
in pixels. The value can be obtained by using thegetFloatValue()
method.CSS_RAD
The value is an <angle>
in radians. The value can be obtained by using thegetFloatValue()
method.CSS_RECT
The value is a rect()
function. The value can be obtained by using thegetRectValue()
method.CSS_RGBCOLOR
The value is an <color>
. The value can be obtained by using thegetRGBColorValue()
method.CSS_S
The value is a <time>
in seconds. The value can be obtained by using thegetFloatValue()
method.CSS_STRING
The value is a <string>
. The value can be obtained by using thegetStringValue()
method.CSS_UNKNOWN
The value is not a recognized CSS2 value. The value can only be obtained by using the cssText
attribute.CSS_URI
The value is a url()
. The value can be obtained by using thegetStringValue()
method.
Methods
CSSPrimitiveValue.getCounterValue()
-
This method is used to get the counter value. If this CSS value doesn't contain a counter value, a
DOMException
is raised. Modification to the corresponding style property can be achieved using theCounter
interface. CSSPrimitiveValue.getFloatValue()
-
This method is used to get a float value in a specified unit. If this CSS value doesn't contain a float value or can't be converted into the specified unit, a
DOMException
is raised. CSSPrimitiveValue.getRGBColorValue()
-
This method is used to get the RGB color. If this CSS value doesn't contain a RGB color value, a
DOMException
is raised. Modification to the corresponding style property can be achieved using theRGBColor
interface. CSSPrimitiveValue.getRectValue()
-
This method is used to get the Rect value. If this CSS value doesn't contain a rect value, a
DOMException
is raised. Modification to the corresponding style property can be achieved using theRect
interface. CSSPrimitiveValue.getStringValue()
-
This method is used to get the string value. If the CSS value doesn't contain a string value, a
DOMException
is raised. CSSPrimitiveValue.setFloatValue()
-
A method to set the float value with a specified unit. If the property attached with this value can not accept the specified unit or the float value, the value will be unchanged and a
DOMException
will be raised. CSSPrimitiveValue.setStringValue()
-
A method to set the string value with the specified unit. If the property attached to this value can't accept the specified unit or the string value, the value will be unchanged and a
DOMException
will be raised.
Specifications
This feature was originally defined in the DOM Style Level 2 specification, but has been dropped from any standardization effort since then.
It has been superseded by a modern, but incompatible, CSS Typed Object Model API that is now on the standard track.
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
CSSPrimitiveValue |
1-40 |
No |
1-62 |
No |
≤12.1-27 |
3 |
1-40 |
18-40 |
4-62 |
≤12.1-27 |
1 |
1.0-4.0 |
getCounterValue |
1-40 |
No |
20-62 |
No |
15-27 |
3 |
1-40 |
18-40 |
20-62 |
14-27 |
1 |
1.0-4.0 |
getFloatValue |
1-40 |
No |
20-62 |
No |
≤12.1-27 |
3 |
1-40 |
18-40 |
20-62 |
≤12.1-27 |
1 |
1.0-4.0 |
getRectValue |
1-40 |
No |
20-62 |
No |
15-27 |
3 |
1-40 |
18-40 |
20-62 |
14-27 |
1 |
1.0-4.0 |
getRGBColorValue |
1-40 |
No |
20-62 |
No |
15-27 |
3 |
1-40 |
18-40 |
20-62 |
14-27 |
1 |
1.0-4.0 |
getStringValue |
1-40 |
No |
20-62 |
No |
15-27 |
3 |
1-40 |
18-40 |
20-62 |
14-27 |
1 |
1.0-4.0 |
primitiveType |
No |
No |
20-62 |
No |
No |
7 |
No |
No |
20-62 |
No |
7 |
No |
setFloatValue |
1-40 |
No |
20-62 |
No |
15-27 |
3 |
1-40 |
18-40 |
20-62 |
14-27 |
1 |
1.0-4.0 |
setStringValue |
1-40 |
No |
20-62 |
No |
15-27 |
3 |
1-40 |
18-40 |
20-62 |
14-27 |
1 |
1.0-4.0 |
See also
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/CSSPrimitiveValue