DOMMatrix: rotateAxisAngleSelf() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Note: This feature is available in Web Workers.

The rotateAxisAngleSelf() method of the DOMMatrix interface is a transformation method that rotates the source matrix by the given vector and angle, returning the altered matrix.

To rotate a matrix without mutating it, see DOMMatrixReadOnly.rotateAxisAngle(), which creates a new rotated matrix while leaving the original unchanged.

Syntax

js
rotateAxisAngleSelf()
rotateAxisAngleSelf(rotX)
rotateAxisAngleSelf(rotX, rotY)
rotateAxisAngleSelf(rotX, rotY, rotZ)
rotateAxisAngleSelf(rotX, rotY, rotZ, angle)

Parameters

rotX

A number; the x-coordinate of the vector denoting the axis of rotation. If non-zero, is2D is false.

rotY Optional

A number; the y-coordinate of the vector denoting the axis of rotation. If undefined, the rotX value is used. If non-zero, is2D is false.

rotZ Optional

A number; the z-coordinate of the vector denoting the axis of rotation. If undefined, the rotX value is used.

angle Optional

A number; the angle of the rotation around the axis vector, in degrees.

If rotY and rotZ are both missing, rotZ is set to the value of rotX, and both rotX and rotY are 0.

Return value

A DOMMatrix.

Examples

js
const matrix = new DOMMatrix(); // create a matrix
console.log(matrix.rotateAxisAngleSelf(10, 20, 30, 45).toString());
/* "matrix3d(
    0.728, 0.609, -0.315, 0, 
    -0.525, 0.791, 0.315, 0, 
    0.441, -0.063, 0.895, 
    0, 0, 0, 0, 1)" */
console.log(matrix.toString());
/* "matrix3d(
    0.728, 0.609, -0.315, 0, 
    -0.525, 0.791, 0.315, 0, 
    0.441, -0.063, 0.895, 0, 
    0, 0, 0, 1)" */

Specifications

Specification
Geometry Interfaces Module Level 1
# dom-dommatrix-rotateaxisangleself

Browser compatibility

BCD tables only load in the browser

See also