K4 InDesign Javascript API Documentation

LayoutTransformationMatrix

A transformation matrix.

Instance Properties

Name Description Access
clockwiseShearAngle number The shear angle of the transformation matrix. read-only
counterclockwiseRotationAngle number The rotation angle of the transformation matrix. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
horizontalScaleFactor number The horizontal scale factor of the transformation matrix. read-only
horizontalTranslation number The horizontal translation of the transformation matrix. read-only
index number The index of the TransformationMatrix within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
matrixMapping The mapping the transformation matrix performs on the unit triangle. Can return: Array of Array of 2 Arrays of 2 Reals. read-only
matrixValues number The values of the transformation matrix. read-only
name string The name of the TransformationMatrix. read-only
parent Application The parent of the TransformationMatrix (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
verticalScaleFactor number The vertical scale factor of the transformation matrix. read-only
verticalTranslation number The vertical translation of the transformation matrix. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
catenateMatrix(
withMatrix)
  → TransformationMatrix
changeCoordinates(
point)
  → number
getElements(
)
  → TransformationMatrix
invertMatrix(
)
  → TransformationMatrix
removeEventListener(
eventType, handler ​[, captures])
  → bool
rotateMatrix(
[byAngle] ​[, byCosine] ​[, bySine])
  → TransformationMatrix
scaleMatrix(
[horizontallyBy] ​[, verticallyBy])
  → TransformationMatrix
shearMatrix(
[byAngle] ​[, bySlope])
  → TransformationMatrix
toSource(
)
  → string
toSpecifier(
)
  → string
translateMatrix(
[horizontallyBy] ​[, verticallyBy])
  → TransformationMatrix
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
catenateMatrix(
withMatrix)
  → TransformationMatrix
Multiply the transformation matrix by another.
withMatrix TransformationMatrix The right hand matrix factor
changeCoordinates(
point)
  → number
Multiply the point by the matrix.
point Array<number> The point to transform
getElements(
)
  → TransformationMatrix
Resolves the object specifier, creating an array of object references.
invertMatrix(
)
  → TransformationMatrix
Invert the transformation matrix.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
rotateMatrix(
[byAngle] ​[, byCosine] ​[, bySine])
  → TransformationMatrix
Rotate the transformation matrix.
byAngle number The counterclockwise rotation angle (Optional)
byCosine number The cosine of the desired rotation (Optional)
bySine number The sine of the desired rotation (Optional)
scaleMatrix(
[horizontallyBy] ​[, verticallyBy])
  → TransformationMatrix
Scale the transformation matrix.
horizontallyBy number The horizontal scale factor (Optional)
verticallyBy number The vertical scale factor (Optional)
shearMatrix(
[byAngle] ​[, bySlope])
  → TransformationMatrix
Shear the transformation matrix.
byAngle number The horizontal shear angle (Optional)
bySlope number The horizontal shear slope (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the TransformationMatrix.
toSpecifier(
)
  → string
Retrieves the object specifier.
translateMatrix(
[horizontallyBy] ​[, verticallyBy])
  → TransformationMatrix
Translate the transformation matrix.
horizontallyBy number The horizontal translation distance (Optional)
verticallyBy number The vertical translation distance (Optional)