CSSPrimitiveValue.setFloatValue()

The setFloatValue() method of the CSSPrimitiveValue interface is used to set a float value. If the property attached to this value can't accept the specified unit or the float value, the value will be unchanged and a DOMException will be raised.

Syntax

cssPrimitiveValue.setFloatValue(unitType, floatValue);

Parameters

unitType
An unsigned short representing the code for the unit type, in which the value should be returned. Valid values are:
Constant Description
CSS_CM The value is a <length> in centimeters.
CSS_DEG The value is an <angle> in degrees.
CSS_DIMENSION The value is a <number> with an unknown dimension.
CSS_EMS The value is a <length> in em units.
CSS_EXS The value is a <length> in ex units.
CSS_GRAD The value is an <angle> in grads.
CSS_HZ The value is a <frequency> in Hertz. The value can be obtained by using the getFloatValue method.
CSS_IN The value is a <length> in inches.
CSS_KHZ The value is a <frequency> in Kilohertz.
CSS_MM The value is a <length> in millimeters.
CSS_MS The value is a <time> in milliseconds.
CSS_NUMBER The value is a simple <number>.
CSS_PC The value is a <length> in picas.
CSS_PERCENTAGE The value is a <percentage>.
CSS_PT The value is a <length> in points.
CSS_PX The value is a <length> in pixels.
CSS_RAD The value is an <angle> in radians.
CSS_S The value is a <time> in seconds.
floatValue
A float representing the new float value.

Return value

Void.

Exceptions

Type Description
DOMException An INVALID_ACCESS_ERR is raised if the CSS value doesn't contain a float value or if the string value can't be converted into the specified unit.
An NO_MODIFICATION_ALLOWED_ERR is raised if this property is read-only.

Specifications

Specification Status Comment
Document Object Model (DOM) Level 2 Style Specification
The definition of 'CSSPrimitiveValue.setFloatValue' in that specification.
Obsolete Initial definition

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Deprecated
Chrome No support NoEdge ? Firefox No support ? — 62IE ? Opera No support NoSafari ? WebView Android ? Chrome Android ? Edge Mobile ? Firefox Android No support ? — 62Opera Android ? Safari iOS ? Samsung Internet Android ?

Legend

No support  
No support
Compatibility unknown  
Compatibility unknown
Deprecated. Not for use in new websites.
Deprecated. Not for use in new websites.

Document Tags and Contributors

Contributors to this page: fscholz, Sebastianz
Last updated by: fscholz,