MDN self-hosted library · e01.org

CSSTransformComponent: toMatrix() method

CSS Typed Object Model API

CSS Typed Object Model API

The toMatrix() method of the CSSTransformComponent interface returns a DOMMatrix object.

All transform functions can be represented mathematically as a 4x4 transformation matrix.

[!NOTE] The is2D property affects what transform, and therefore type of matrix that will be returned. CSS 2D and 3D transforms are different for legacy reasons. A brief explanation of 2D vs. 3D transforms can be found in Using CSS transforms.

Syntax

toMatrix()

Parameters

None.

Return value

A DOMMatrix object.

Exceptions

  • TypeError
  • : Raised if any lengths involved in generating the matrix are not compatible units with px (such as relative lengths or percentages).

Examples

Converting a component to a matrix

const translate = new CSSTranslate(CSS.px(10), CSS.px(20));

const matrix = translate.toMatrix();
console.log(matrix.e, matrix.f); // 10 20

Handling incompatible units

toMatrix() throws if a length can't be resolved to pixels, such as a percentage:

const translate = new CSSTranslate(CSS.percent(50), CSS.px(20));

try {
  translate.toMatrix();
} catch (e) {
  console.log(e); // TypeError
}

Specifications

Browser compatibility

See also