CSSTransformComponent: toMatrix() method

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

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

{{APIRef("CSS Typed Object Model API")}} {{AvailableInWorkers}}

The **toMatrix()** method of the {{domxref("CSSTransformComponent")}} interface returns a {{domxref("DOMMatrix")}} object.

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

توجه: 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

js-nolint
toMatrix()

Parameters

None.

Return value

A {{domxref("DOMMatrix")}} object.

Exceptions

  • {{jsxref("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

js
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:

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

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also