DOMRectReadOnly: toJSON() method

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

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

{{APIRef("Geometry Interfaces")}}{{AvailableInWorkers}}

The **toJSON()** method of the {{domxref("DOMRectReadOnly")}} interface returns a JSON-serializable plain object representing the DOMRectReadOnly object.

The method is automatically called by {{jsxref("JSON.stringify()")}} when a DOMRectReadOnly object is encountered during JSON serialization. The serialized value can then be deserialized using the {{domxref("DOMRectReadOnly/fromRect_static", "DOMRectReadOnly.fromRect()")}} function within the reviver of {{jsxref("JSON.parse()")}}.

Syntax

js-nolint
toJSON()

Parameters

None.

Return value

A JSON-serializable plain object containing the following properties:

  • {{domxref("DOMRectReadOnly/x", "x")}}
  • {{domxref("DOMRectReadOnly/y", "y")}}
  • {{domxref("DOMRectReadOnly/width", "width")}}
  • {{domxref("DOMRectReadOnly/height", "height")}}
  • {{domxref("DOMRectReadOnly/top", "top")}}
  • {{domxref("DOMRectReadOnly/right", "right")}}
  • {{domxref("DOMRectReadOnly/bottom", "bottom")}}
  • {{domxref("DOMRectReadOnly/left", "left")}}

Each property's value is copied as-is.

Examples

Calling toJSON() directly

Calling toJSON() directly returns a plain object containing the DOMRectReadOnly object's properties.

js
const rect = new DOMRectReadOnly(10, 20, 100, 50);

const json = rect.toJSON();
console.log(json);
// { x: 10, y: 20, width: 100, height: 50, top: 20, right: 110, bottom: 70, left: 10 }
console.log(typeof json); // "object"

Serializing to a JSON string

The DOMRectReadOnly object from the previous example is serialized using {{jsxref("JSON.stringify()")}}, which calls the toJSON() method automatically.

js
const rectJSON = JSON.stringify(rect);
console.log(rectJSON);

This would log a JSON string like so (formatted for readability):

json
{
  "x": 10,
  "y": 20,
  "width": 100,
  "height": 50,
  "top": 20,
  "right": 110,
  "bottom": 70,
  "left": 10
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}