ComPDFKit Web SDK
    Preparing search index...

    Class Matrix

    A matrix of numbers, 3×3 by default, used for 2D affine transforms on column vectors (p' = M · p).

    Index
    • get Columns(): number

      Number of columns.

      Returns number

    • get Identity(): Matrix

      A new 3×3 identity matrix.

      Returns Matrix

    • get Rows(): number

      Number of rows.

      Returns number

    • Defaults to the 3×3 identity matrix; non-square matrices are all zeros.

      Parameters

      • Optionalrows: number

        Number of rows.

      • Optionalcolumns: number

        Number of columns.

      Returns Matrix

    • Copies the matrix.

      Returns Matrix

      A new matrix with the same size and values.

    • Multiplies a list of transforms in order into one, optionally around a point (default 0, 0: move the point to the origin, apply the transforms, then move it back).

      Parameters

      Returns Matrix

    • Computes the determinant of a 3×3 matrix.

      Returns number

      The determinant.

      RangeError when the matrix is not 3×3.

    • Canvas DOMMatrix (a b c d e f) to matrix: [a c e; b d f; 0 0 1].

      Parameters

      • dom: { a: number; b: number; c: number; d: number; e: number; f: number }
        • a: number

          Row 0, column 0 (horizontal scale).

        • b: number

          Row 1, column 0.

        • c: number

          Row 0, column 1.

        • d: number

          Row 1, column 1 (vertical scale).

        • e: number

          Row 0, column 2 (horizontal translation).

        • f: number

          Row 1, column 2 (vertical translation).

      Returns Matrix

    • Returns one entry.

      Parameters

      • row: number

        Row index (0-based).

      • column: number

        Column index (0-based).

      Returns number

      The value at that position.

    • Gauss-Jordan elimination; returns null for a singular matrix.

      Returns Matrix | null

    • Multiplies two matrices. Each entry is rounded to 6 decimals.

      Parameters

      • left: Matrix

        Left operand.

      • right: Matrix

        Right operand; its row count must equal the column count of left.

      Returns Matrix

      A new matrix left · right.

      RangeError when the sizes do not match.

    • Sets one entry.

      Parameters

      • row: number

        Row index (0-based).

      • column: number

        Column index (0-based).

      • value: number

        The new value.

      Returns void

    • Overwrites the top-left 2×2 with a rotation; counterclockwise when the y axis points up.

      Parameters

      • angle: number
      • OptionalisRadians: boolean

      Returns void

    • Sets the horizontal and vertical scale entries.

      Parameters

      • sx: number

        Horizontal scale.

      • sy: number

        Vertical scale.

      Returns void

    • Sets the horizontal scale entry (row 0, column 0).

      Parameters

      • sx: number

        Horizontal scale.

      Returns void

    • Sets the vertical scale entry (row 1, column 1).

      Parameters

      • sy: number

        Vertical scale.

      Returns void

    • Sets the skew entries.

      Parameters

      • kx: number

        Horizontal skew factor.

      • ky: number

        Vertical skew factor.

      Returns void

    • Sets the horizontal skew entry (row 0, column 1).

      Parameters

      • kx: number

        Horizontal skew factor.

      Returns void

    • Sets the vertical skew entry (row 1, column 0).

      Parameters

      • ky: number

        Vertical skew factor.

      Returns void

    • Sets the translation entries.

      Parameters

      • tx: number

        Horizontal translation.

      • ty: number

        Vertical translation.

      Returns void

    • Sets the horizontal translation entry (row 0, column 2).

      Parameters

      • tx: number

        Horizontal translation.

      Returns void

    • Sets the vertical translation entry (row 1, column 2).

      Parameters

      • ty: number

        Vertical translation.

      Returns void

    • Returns the affine part of a 3×3 matrix in canvas order.

      Returns [a: number, b: number, c: number, d: number, e: number, f: number]

      [a, b, c, d, e, f], where x' = a·x + c·y + e and y' = b·x + d·y + f.

    • Transposes in place (square matrices).

      Returns void

    columns: number

    Number of columns.

    rows: number

    Number of rows.