-
Notifications
You must be signed in to change notification settings - Fork 22.4k
/
index.md
98 lines (79 loc) · 5.1 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
---
title: "CSSPrimitiveValue: setFloatValue() method"
short-title: setFloatValue()
slug: Web/API/CSSPrimitiveValue/setFloatValue
page-type: web-api-instance-method
status:
- deprecated
browser-compat: api.CSSPrimitiveValue.setFloatValue
---
{{APIRef("CSSOM")}}{{deprecated_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.
> **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](/en-US/docs/Web/API/CSS_Object_Model), widely supported, or
> - the modern [CSS Typed Object Model API](/en-US/docs/Web/API/CSS_Typed_OM_API), less supported and considered experimental.
## Syntax
```js-nolint
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 {{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 `float` representing 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 />An 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](https://www.w3.org/TR/DOM-Level-2-Style/) 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](/en-US/docs/Web/API/CSS_Typed_OM_API) that is now on the standard track.
## Browser compatibility
{{Compat}}