Adobe InCopy CS5 (7.0) Object Model JS: TransformationMatrices

InCopy CS5

Class

TransformationMatrices

 A collection of transformation matrices.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

TransformationMatrix [] (index: number)
Returns the TransformationMatrix with the specified index.

ParameterTypeDescription
indexnumberThe index.

TransformationMatrix add ([horizontalScaleFactor: number][, verticalScaleFactor: number][, clockwiseShearAngle: number][, counterclockwiseRotationAngle: number][, horizontalTranslation: number][, verticalTranslation: number][, matrixValues: Array of number][, matrixMapping: Array of varies][, withProperties: Object])
Create a new TransformationMatrix.

ParameterTypeDescription
horizontalScaleFactornumberThe horizontal scale factor of the transformation matrix (Optional)
verticalScaleFactornumberThe vertical scale factor of the transformation matrix (Optional)
clockwiseShearAnglenumberThe shear angle of the transformation matrix (Optional)
counterclockwiseRotationAnglenumberThe rotation angle of the transformation matrix (Optional)
horizontalTranslationnumberThe horizontal translation of the transformation matrix (Optional)
verticalTranslationnumberThe vertical translation of the transformation matrix (Optional)
matrixValues Array of numberThe values of the transformation matrix (Optional)
matrixMapping Array of :
Array of Array of 2 Arrays of 2 Reals
The mapping the transformation matrix performs on the unit triangle. Can accept: Array of Array of 2 Arrays of 2 Reals. (Optional)
withPropertiesObjectInitial values for properties of the new TransformationMatrix (Optional)

TransformationMatrix anyItem ()
Returns any TransformationMatrix in the collection.

number count ()
Displays the number of elements in the TransformationMatrix.

Array of TransformationMatrix everyItem ()
Returns every TransformationMatrix in the collection.

TransformationMatrix firstItem ()
Returns the first TransformationMatrix in the collection.

TransformationMatrix item (index: varies)
Returns the TransformationMatrix with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

TransformationMatrix itemByName (name: string)
Returns the TransformationMatrix with the specified name.

ParameterTypeDescription
namestringThe name.

Array of TransformationMatrix itemByRange (from: varies, to: varies)
Returns the TransformationMatrices within the specified range.

ParameterTypeDescription
fromLong Integer
String
TransformationMatrix
The TransformationMatrix, index, or name at the beginning of the range. Can accept: TransformationMatrix, Long Integer or String.
toLong Integer
String
TransformationMatrix
The TransformationMatrix, index, or name at the end of the range. Can accept: TransformationMatrix, Long Integer or String.

TransformationMatrix lastItem ()
Returns the last TransformationMatrix in the collection.

TransformationMatrix middleItem ()
Returns the middle TransformationMatrix in the collection.

TransformationMatrix nextItem (obj: TransformationMatrix)
Returns the TransformationMatrix whose index follows the specified TransformationMatrix in the collection.

ParameterTypeDescription
objTransformationMatrixThe TransformationMatrix whose index comes before the desired TransformationMatrix.

TransformationMatrix previousItem (obj: TransformationMatrix)
Returns the TransformationMatrix with the index previous to the specified index.

ParameterTypeDescription
objTransformationMatrixThe index of the TransformationMatrix that follows the desired TransformationMatrix.

string toSource ()
Generates a string which, if executed, will return the TransformationMatrix.

Element of

Application.transformationMatrices

Jongware, 23-Mar-2011 v3.0.3dContents :: Index