CSSPrimitiveValue: getFloatValue() method

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("CSSOM")}}{{non-standard_header}}

The **getFloatValue()** method of the {{domxref("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 {{domxref("DOMException")}} is 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

js-nolint
getFloatValue(unit)

Parameters

  • unit
  • : An unsigned short representing the code for the unit type, in which the

value should be returned. Valid values are:

ConstantDescription
CSS_CMThe value is a {{cssxref("<length>")}} in centimeters.
CSS_DEGThe value is an {{cssxref("<angle>")}} in degrees.
CSS_DIMENSIONThe value is a {{cssxref("<number>")}} with an unknown dimension.
CSS_EMSThe value is a {{cssxref("<length>")}} in em units.
CSS_EXSThe value is a {{cssxref("<length>")}} in ex units.
CSS_GRADThe value is an {{cssxref("<angle>")}} in grads.
CSS_HZThe value is a {{cssxref("<frequency>")}} in Hertz. The value can be obtained by using the getFloatValue method.
CSS_INThe value is a {{cssxref("<length>")}} in inches.
CSS_KHZThe value is a {{cssxref("<frequency>")}} in Kilohertz.
CSS_MMThe value is a {{cssxref("<length>")}} in millimeters.
CSS_MSThe value is a {{cssxref("<time>")}} in milliseconds.
CSS_NUMBERThe value is a simple {{cssxref("<number>")}}.
CSS_PCThe value is a {{cssxref("<length>")}} in picas.
CSS_PERCENTAGEThe value is a {{cssxref("<percentage>")}}.
CSS_PTThe value is a {{cssxref("<length>")}} in points.
CSS_PXThe value is a {{cssxref("<length>")}} in pixels.
CSS_RADThe value is an {{cssxref("<angle>")}} in radians.
CSS_SThe value is a {{cssxref("<time>")}} in seconds.

Return value

A float value in the specified unit.

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 float value can't be converted into the specified unit. </td> </tr> </tbody> </table>

Examples

js
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

{{Compat}}