Join us online - 19th of November
Save your spot

Interface DOMMatrix

The DOMMatrix interface represents 4×4 matrices, suitable for 2D and 3D operations including rotation and translation. It is a mutable version of the DOMMatrixReadOnly interface. The interface is available inside web workers.

MDN Reference

interface DOMMatrix {
    a: number;
    b: number;
    c: number;
    d: number;
    e: number;
    f: number;
    is2D: boolean;
    isIdentity: boolean;
    m11: number;
    m12: number;
    m13: number;
    m14: number;
    m21: number;
    m22: number;
    m23: number;
    m24: number;
    m31: number;
    m32: number;
    m33: number;
    m34: number;
    m41: number;
    m42: number;
    m43: number;
    m44: number;
    flipX(): DOMMatrix;
    flipY(): DOMMatrix;
    inverse(): DOMMatrix;
    invertSelf(): DOMMatrix;
    multiply(other?: DOMMatrixInit): DOMMatrix;
    multiplySelf(other?: DOMMatrixInit): DOMMatrix;
    preMultiplySelf(other?: DOMMatrixInit): DOMMatrix;
    rotate(rotX?: number, rotY?: number, rotZ?: number): DOMMatrix;
    rotateAxisAngle(
        x?: number,
        y?: number,
        z?: number,
        angle?: number,
    ): DOMMatrix;
    rotateAxisAngleSelf(
        x?: number,
        y?: number,
        z?: number,
        angle?: number,
    ): DOMMatrix;
    rotateFromVector(x?: number, y?: number): DOMMatrix;
    rotateFromVectorSelf(x?: number, y?: number): DOMMatrix;
    rotateSelf(rotX?: number, rotY?: number, rotZ?: number): DOMMatrix;
    scale(
        scaleX?: number,
        scaleY?: number,
        scaleZ?: number,
        originX?: number,
        originY?: number,
        originZ?: number,
    ): DOMMatrix;
    scale3d(
        scale?: number,
        originX?: number,
        originY?: number,
        originZ?: number,
    ): DOMMatrix;
    scale3dSelf(
        scale?: number,
        originX?: number,
        originY?: number,
        originZ?: number,
    ): DOMMatrix;
    scaleNonUniform(scaleX?: number, scaleY?: number): DOMMatrix;
    scaleSelf(
        scaleX?: number,
        scaleY?: number,
        scaleZ?: number,
        originX?: number,
        originY?: number,
        originZ?: number,
    ): DOMMatrix;
    setMatrixValue(transformList: string): DOMMatrix;
    skewX(sx?: number): DOMMatrix;
    skewXSelf(sx?: number): DOMMatrix;
    skewY(sy?: number): DOMMatrix;
    skewYSelf(sy?: number): DOMMatrix;
    toFloat32Array(): Float32Array<ArrayBuffer>;
    toFloat64Array(): Float64Array<ArrayBuffer>;
    toJSON(): any;
    toString(): string;
    transformPoint(point?: DOMPointInit): DOMPoint;
    translate(tx?: number, ty?: number, tz?: number): DOMMatrix;
    translateSelf(tx?: number, ty?: number, tz?: number): DOMMatrix;
}

Hierarchy (View Summary)

Index
a b c d e f is2D isIdentity m11 m12 m13 m14 m21 m22 m23 m24 m31 m32 m33 m34 m41 m42 m43 m44
flipX flipY inverse invertSelf multiply multiplySelf preMultiplySelf rotate rotateAxisAngle rotateAxisAngleSelf rotateFromVector rotateFromVectorSelf rotateSelf scale scale3d scale3dSelf scaleNonUniform scaleSelf setMatrixValue skewX skewXSelf skewY skewYSelf toFloat32Array toFloat64Array toJSON toString transformPoint translate translateSelf
a: number

MDN Reference

b: number

MDN Reference

c: number

MDN Reference

d: number

MDN Reference

e: number

MDN Reference

f: number

MDN Reference

is2D: boolean

The readonly is2D property of the DOMMatrixReadOnly interface is a Boolean flag that is true when the matrix is 2D. The value is true if the matrix was initialized as a 2D matrix and only 2D transformation operations were applied. Otherwise, the matrix is defined in 3D, and is2D is false.

MDN Reference

isIdentity: boolean

The readonly isIdentity property of the DOMMatrixReadOnly interface is a Boolean whose value is true if the matrix is the identity matrix.

MDN Reference

m11: number

MDN Reference

m12: number

MDN Reference

m13: number

MDN Reference

m14: number

MDN Reference

m21: number

MDN Reference

m22: number

MDN Reference

m23: number

MDN Reference

m24: number

MDN Reference

m31: number

MDN Reference

m32: number

MDN Reference

m33: number

MDN Reference

m34: number

MDN Reference

m41: number

MDN Reference

m42: number

MDN Reference

m43: number

MDN Reference

m44: number

MDN Reference

  • The flipX() method of the DOMMatrixReadOnly interface creates a new matrix being the result of the original matrix flipped about the x-axis. This is equivalent to multiplying the matrix by DOMMatrix(-1, 0, 0, 1, 0, 0). The original matrix is not modified.

    MDN Reference

    Returns DOMMatrix

  • The flipY() method of the DOMMatrixReadOnly interface creates a new matrix being the result of the original matrix flipped about the y-axis. This is equivalent to multiplying the matrix by DOMMatrix(1, 0, 0, -1, 0, 0). The original matrix is not modified.

    MDN Reference

    Returns DOMMatrix

  • The inverse() method of the DOMMatrixReadOnly interface creates a new matrix which is the inverse of the original matrix. If the matrix cannot be inverted, the new matrix's components are all set to NaN and its is2D property is set to false. The original matrix is not changed.

    MDN Reference

    Returns DOMMatrix

  • The invertSelf() method of the DOMMatrix interface inverts the original matrix. If the matrix cannot be inverted, the new matrix's components are all set to NaN and its is2D property is set to false.

    MDN Reference

    Returns DOMMatrix

  • The multiply() method of the DOMMatrixReadOnly interface creates and returns a new matrix which is the dot product of the matrix and the otherMatrix parameter. If otherMatrix is omitted, the matrix is multiplied by a matrix in which every element is 0 except the bottom-right corner and the element immediately above and to its left: m33 and m34. These have the default value of 1. The original matrix is not modified.

    MDN Reference

    Parameters

    Returns DOMMatrix

  • The multiplySelf() method of the DOMMatrix interface multiplies a matrix by the otherMatrix parameter, computing the dot product of the original matrix and the specified matrix: A⋅B. If no matrix is specified as the multiplier, the matrix is multiplied by a matrix in which every element is 0 except the bottom-right corner and the element immediately above and to its left: m33 and m34. These have the default value of 1.

    MDN Reference

    Parameters

    Returns DOMMatrix

  • The preMultiplySelf() method of the DOMMatrix interface modifies the matrix by pre-multiplying it with the specified DOMMatrix. This is equivalent to the dot product B⋅A, where matrix A is the source matrix and B is the matrix given as an input to the method. If no matrix is specified as the multiplier, the matrix is multiplied by a matrix in which every element is 0 except the bottom-right corner and the element immediately above and to its left: m33 and m34. These have the default value of 1.

    MDN Reference

    Parameters

    Returns DOMMatrix

  • The rotate() method of the DOMMatrixReadOnly interface returns a new DOMMatrix created by rotating the source matrix around each of its axes by the specified number of degrees. The original matrix is not altered.

    MDN Reference

    Parameters

    • OptionalrotX: number
    • OptionalrotY: number
    • OptionalrotZ: number

    Returns DOMMatrix

  • The rotateAxisAngle() method of the DOMMatrixReadOnly interface returns a new DOMMatrix created by rotating the source matrix by the given vector and angle. The original matrix is not altered.

    MDN Reference

    Parameters

    • Optionalx: number
    • Optionaly: number
    • Optionalz: number
    • Optionalangle: number

    Returns DOMMatrix

  • 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.

    MDN Reference

    Parameters

    • Optionalx: number
    • Optionaly: number
    • Optionalz: number
    • Optionalangle: number

    Returns DOMMatrix

  • The rotateFromVector() method of the DOMMatrixReadOnly interface is returns a new DOMMatrix created by rotating the source matrix by the angle between the specified vector and (1, 0). The rotation angle is determined by the angle between the vector (1,0)T and (x,y)T in the clockwise direction, or (+/-)arctan(y/x). If x and y are both 0, the angle is specified as 0. The original matrix is not altered.

    MDN Reference

    Parameters

    • Optionalx: number
    • Optionaly: number

    Returns DOMMatrix

  • The rotateFromVectorSelf() method of the DOMMatrix interface is a mutable transformation method that modifies a matrix by rotating the matrix by the angle between the specified vector and (1, 0). The rotation angle is determined by the angle between the vector (1,0)T and (x,y)T in the clockwise direction, or (+/-)arctan(y/x). If x and y are both 0, the angle is specified as 0, and the matrix is not altered.

    MDN Reference

    Parameters

    • Optionalx: number
    • Optionaly: number

    Returns DOMMatrix

  • The rotateSelf() method of the DOMMatrix interface is a mutable transformation method that modifies a matrix. It rotates the source matrix around each of its axes by the specified number of degrees and returns the rotated matrix.

    MDN Reference

    Parameters

    • OptionalrotX: number
    • OptionalrotY: number
    • OptionalrotZ: number

    Returns DOMMatrix

  • The scale() method of the DOMMatrixReadOnly interface creates a new matrix being the result of the original matrix with a scale transform applied.

    MDN Reference

    Parameters

    • OptionalscaleX: number
    • OptionalscaleY: number
    • OptionalscaleZ: number
    • OptionaloriginX: number
    • OptionaloriginY: number
    • OptionaloriginZ: number

    Returns DOMMatrix

  • The scale3d() method of the DOMMatrixReadOnly interface creates a new matrix which is the result of a 3D scale transform being applied to the matrix. It returns a new DOMMatrix created by scaling the source 3d matrix by the given scale factor centered on the origin point specified by the origin parameters, with a default origin of (0, 0, 0). The original matrix is not modified.

    MDN Reference

    Parameters

    • Optionalscale: number
    • OptionaloriginX: number
    • OptionaloriginY: number
    • OptionaloriginZ: number

    Returns DOMMatrix

  • The scale3dSelf() method of the DOMMatrix interface is a mutable transformation method that modifies a matrix by applying a specified scaling factor to all three axes, centered on the given origin, with a default origin of (0, 0, 0), returning the 3D-scaled matrix.

    MDN Reference

    Parameters

    • Optionalscale: number
    • OptionaloriginX: number
    • OptionaloriginY: number
    • OptionaloriginZ: number

    Returns DOMMatrix

  • The scaleSelf() method of the DOMMatrix interface is a mutable transformation method that modifies a matrix by applying a specified scaling factor, centered on the given origin, with a default origin of (0, 0), returning the scaled matrix.

    MDN Reference

    Parameters

    • OptionalscaleX: number
    • OptionalscaleY: number
    • OptionalscaleZ: number
    • OptionaloriginX: number
    • OptionaloriginY: number
    • OptionaloriginZ: number

    Returns DOMMatrix

  • The setMatrixValue() method of the DOMMatrix interface replaces the contents of the matrix with the matrix described by the specified transform or transforms, returning itself.

    MDN Reference

    Parameters

    • transformList: string

    Returns DOMMatrix

  • The skewX() method of the DOMMatrixReadOnly interface returns a new DOMMatrix created by applying the specified skew transformation to the source matrix along its x-axis. The original matrix is not modified.

    MDN Reference

    Parameters

    • Optionalsx: number

    Returns DOMMatrix

  • The skewXSelf() method of the DOMMatrix interface is a mutable transformation method that modifies a matrix. It skews the source matrix by applying the specified skew transformation along the X-axis and returns the skewed matrix.

    MDN Reference

    Parameters

    • Optionalsx: number

    Returns DOMMatrix

  • The skewY() method of the DOMMatrixReadOnly interface returns a new DOMMatrix created by applying the specified skew transformation to the source matrix along its y-axis. The original matrix is not modified.

    MDN Reference

    Parameters

    • Optionalsy: number

    Returns DOMMatrix

  • The skewYSelf() method of the DOMMatrix interface is a mutable transformation method that modifies a matrix. It skews the source matrix by applying the specified skew transformation along the Y-axis and returns the skewed matrix.

    MDN Reference

    Parameters

    • Optionalsy: number

    Returns DOMMatrix

  • The toFloat32Array() method of the DOMMatrixReadOnly interface returns a new Float32Array containing all 16 elements (m11, m12, m13, m14, m21, m22, m23, m24, m31, m32, m33, m34, m41, m42, m43, m44) which comprise the matrix. The elements are stored into the array as single-precision floating-point numbers in column-major (colexographical access, or "colex") order. (In other words, down the first column from top to bottom, then the second column, and so forth.)

    MDN Reference

    Returns Float32Array<ArrayBuffer>

  • The toFloat64Array() method of the DOMMatrixReadOnly interface returns a new Float64Array containing all 16 elements (m11, m12, m13, m14, m21, m22, m23, m24, m31, m32, m33, m34, m41, m42, m43, m44) which comprise the matrix. The elements are stored into the array as double-precision floating-point numbers in column-major (colexographical access, or "colex") order. (In other words, down the first column from top to bottom, then the second column, and so forth.)

    MDN Reference

    Returns Float64Array<ArrayBuffer>

  • The toJSON() method of the DOMMatrixReadOnly interface creates and returns a JSON object. The JSON object includes the 2D matrix elements a through f, the 16 elements of the 4X4 3D matrix, m[1-4][1-4], the boolean is2D property, and the boolean isIdentity property.

    MDN Reference

    Returns any

  • The translate() method of the DOMMatrixReadOnly interface creates a new matrix being the result of the original matrix with a translation applied.

    MDN Reference

    Parameters

    • Optionaltx: number
    • Optionalty: number
    • Optionaltz: number

    Returns DOMMatrix

  • The translateSelf() method of the DOMMatrix interface is a mutable transformation method that modifies a matrix. It applies the specified vectors and returns the updated matrix. The default vector is [0, 0, 0].

    MDN Reference

    Parameters

    • Optionaltx: number
    • Optionalty: number
    • Optionaltz: number

    Returns DOMMatrix

Was this helpful?