MDN self-hosted library · e01.org

DOMPointReadOnly: toJSON() method

Geometry Interfaces

Geometry Interfaces

The toJSON() method of the DOMPointReadOnly interface returns a JSON-serializable plain object representing the DOMPointReadOnly object.

The method is automatically called by JSON.stringify() when a DOMPointReadOnly object is encountered during JSON serialization. The serialized value can then be deserialized using the DOMPointReadOnly.fromPoint() function within the reviver of JSON.parse().

Syntax

toJSON()

Parameters

None.

Return value

A JSON-serializable plain object containing the following properties:

  • x
  • y
  • z
  • w

Each property's value is copied as-is.

Examples

Calling toJSON() directly

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

const point = new DOMPointReadOnly(10, 20);

const json = point.toJSON();
console.log(json);
// { x: 10, y: 20, z: 0, w: 1 }
console.log(typeof json); // "object"

Serializing to a JSON string

The DOMPointReadOnly object from the previous example is serialized using JSON.stringify(), which calls the toJSON() method automatically.

const pointJSON = JSON.stringify(point);
console.log(pointJSON);

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

{
  "x": 10,
  "y": 20,
  "z": 0,
  "w": 1
}

Specifications

Browser compatibility