K4 InDesign Javascript API Documentation

LayoutTransformationMatrices

A collection of transformation matrices.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[horizontalScaleFactor] ​[, verticalScaleFactor] ​[, clockwiseShearAngle] ​[, counterclockwiseRotationAngle] ​[, horizontalTranslation] ​[, verticalTranslation] ​[, matrixValues], matrixMapping ​[, withProperties])
  → TransformationMatrix
anyItem(
)
  → TransformationMatrix
count(
)
  → number
everyItem(
)
  → TransformationMatrix
firstItem(
)
  → TransformationMatrix
item(
index)
  → TransformationMatrix
itemByName(
name)
  → TransformationMatrix
itemByRange(
from, to)
  → TransformationMatrix
lastItem(
)
  → TransformationMatrix
middleItem(
)
  → TransformationMatrix
nextItem(
obj)
  → TransformationMatrix
previousItem(
obj)
  → TransformationMatrix
toSource(
)
  → string
add(
[horizontalScaleFactor] ​[, verticalScaleFactor] ​[, clockwiseShearAngle] ​[, counterclockwiseRotationAngle] ​[, horizontalTranslation] ​[, verticalTranslation] ​[, matrixValues], matrixMapping ​[, withProperties])
  → TransformationMatrix
Create a new TransformationMatrix.
horizontalScaleFactor number The horizontal scale factor of the transformation matrix (Optional)
verticalScaleFactor number The vertical scale factor of the transformation matrix (Optional)
clockwiseShearAngle number The shear angle of the transformation matrix (Optional)
counterclockwiseRotationAngle number The rotation angle of the transformation matrix (Optional)
horizontalTranslation number The horizontal translation of the transformation matrix (Optional)
verticalTranslation number The vertical translation of the transformation matrix (Optional)
matrixValues Array<number> The values of the transformation matrix (Optional)
matrixMapping The mapping the transformation matrix performs on the unit triangle. Can accept: Array of Array of 2 Arrays of 2 Reals. (Optional)
withProperties Object Initial values for properties of the new TransformationMatrix (Optional)
anyItem(
)
  → TransformationMatrix
Returns any TransformationMatrix in the collection.
count(
)
  → number
Displays the number of elements in the TransformationMatrix.
everyItem(
)
  → TransformationMatrix
Returns every TransformationMatrix in the collection.
firstItem(
)
  → TransformationMatrix
Returns the first TransformationMatrix in the collection.
item(
index)
  → TransformationMatrix
Returns the TransformationMatrix with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByName(
name)
  → TransformationMatrix
Returns the TransformationMatrix with the specified name.
name string The name.
itemByRange(
from, to)
  → TransformationMatrix
Returns the TransformationMatrices within the specified range.
from The TransformationMatrix, index, or name at the beginning of the range. Can accept: TransformationMatrix, Long Integer or String.
to The TransformationMatrix, index, or name at the end of the range. Can accept: TransformationMatrix, Long Integer or String.
lastItem(
)
  → TransformationMatrix
Returns the last TransformationMatrix in the collection.
middleItem(
)
  → TransformationMatrix
Returns the middle TransformationMatrix in the collection.
nextItem(
obj)
  → TransformationMatrix
Returns the TransformationMatrix whose index follows the specified TransformationMatrix in the collection.
obj TransformationMatrix The TransformationMatrix whose index comes before the desired TransformationMatrix.
previousItem(
obj)
  → TransformationMatrix
Returns the TransformationMatrix with the index previous to the specified index.
obj TransformationMatrix The index of the TransformationMatrix that follows the desired TransformationMatrix.
toSource(
)
  → string
Generates a string which, if executed, will return the TransformationMatrix.