CSSPrimitiveValue: getFloatValue() method
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 getFloatValue() method of the
CSSPrimitiveValue interface 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.
Note: This method 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.
Syntax
getFloatValue(unit)
Parameters
unit-
An
unsigned shortrepresenting the code for the unit type, in which the value should be returned. Valid values are:Constant Description CSS_CMThe value is a <length>in centimeters.CSS_DEGThe value is an <angle>in degrees.CSS_DIMENSIONThe value is a <number>with an unknown dimension.CSS_EMSThe value is a <length>in em units.CSS_EXSThe value is a <length>in ex units.CSS_GRADThe value is an <angle>in grads.CSS_HZThe value is a <frequency>in Hertz. The value can be obtained by using the getFloatValue method.CSS_INThe value is a <length>in inches.CSS_KHZThe value is a <frequency>in Kilohertz.CSS_MMThe value is a <length>in millimeters.CSS_MSThe value is a <time>in milliseconds.CSS_NUMBERThe value is a simple <number>.CSS_PCThe value is a <length>in picas.CSS_PERCENTAGEThe value is a <percentage>.CSS_PTThe value is a <length>in points.CSS_PXThe value is a <length>in pixels.CSS_RADThe value is an <angle>in radians.CSS_SThe value is a <time>in seconds.
Return value
A float value in the specified unit.
Exceptions
| Type | Description |
|---|---|
DOMException |
An INVALID_ACCESS_ERR is raised if the CSS value doesn't
contain a float value or if the float value can't be converted into the
specified unit.
|
Examples
const cs = window.getComputedStyle(document.body);
const cssValue = cs.getPropertyCSSValue("margin-top");
console.log(cssValue.getFloatValue(CSSPrimitiveValue.CSS_CM));
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
Loading…