CSSPrimitiveValue: setFloatValue() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("CSSOM")}}{{non-standard_header}}
The **setFloatValue()** method of the {{domxref("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 {{domxref("DOMException")}} will be raised.
توجه: 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
setFloatValue(unitType, floatValue)Parameters
unitType- : An
unsigned shortrepresenting the code for the unit type, in which the
value should be returned. Valid values are:
| Constant | Description |
|---|---|
CSS_CM | The value is a {{cssxref("<length>")}} in centimeters. |
CSS_DEG | The value is an {{cssxref("<angle>")}} in degrees. |
CSS_DIMENSION | The value is a {{cssxref("<number>")}} with an unknown dimension. |
CSS_EMS | The value is a {{cssxref("<length>")}} in em units. |
CSS_EXS | The value is a {{cssxref("<length>")}} in ex units. |
CSS_GRAD | The value is an {{cssxref("<angle>")}} in grads. |
CSS_HZ | The value is a {{cssxref("<frequency>")}} in Hertz. The value can be obtained by using the getFloatValue method. |
CSS_IN | The value is a {{cssxref("<length>")}} in inches. |
CSS_KHZ | The value is a {{cssxref("<frequency>")}} in Kilohertz. |
CSS_MM | The value is a {{cssxref("<length>")}} in millimeters. |
CSS_MS | The value is a {{cssxref("<time>")}} in milliseconds. |
CSS_NUMBER | The value is a simple {{cssxref("<number>")}}. |
CSS_PC | The value is a {{cssxref("<length>")}} in picas. |
CSS_PERCENTAGE | The value is a {{cssxref("<percentage>")}}. |
CSS_PT | The value is a {{cssxref("<length>")}} in points. |
CSS_PX | The value is a {{cssxref("<length>")}} in pixels. |
CSS_RAD | The value is an {{cssxref("<angle>")}} in radians. |
CSS_S | The value is a {{cssxref("<time>")}} in seconds. |
floatValue- : A
floatrepresenting the new float value.
Return value
None ({{jsxref("undefined")}}).
Exceptions
<table class="no-markdown"> <thead> <tr> <th scope="col"><strong>Type</strong></th> <th scope="col"><strong>Description</strong></th> </tr> </thead> <tbody> <tr> <td><code>DOMException</code></td> <td> An <code>INVALID_ACCESS_ERR</code> 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.<br />A NO_MODIFICATION_ALLOWED_ERR is raised if this property is read-only. </td> </tr> </tbody> </table>
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
{{Compat}}