Adobe InDesign CS6 (8.0) Object Model JS: TransformationMatrix

InDesign CS6

Class

TransformationMatrix

 A transformation matrix.

QuickLinks

addEventListener, catenateMatrix, changeCoordinates, getElements, invertMatrix, removeEventListener, rotateMatrix, scaleMatrix, shearMatrix, toSource, toSpecifier, translateMatrix

Hierarchy

Application
TransformationMatrix
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
clockwiseShearAnglenumber readonlyThe shear angle of the transformation matrix.
counterclockwiseRotationAnglenumber readonlyThe rotation angle of the transformation matrix.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
horizontalScaleFactornumber readonlyThe horizontal scale factor of the transformation matrix.
horizontalTranslationnumber readonlyThe horizontal translation of the transformation matrix.
indexnumber readonlyThe index of the TransformationMatrix within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
matrixMappingArray of
Array of 2 Arrays of 2 Reals
readonlyThe mapping the transformation matrix performs on the unit triangle. Can return: Array of Array of 2 Arrays of 2 Reals.
matrixValuesArray of number readonlyThe values of the transformation matrix.
namestring readonlyThe name of the TransformationMatrix.
parentApplication readonlyThe parent of the TransformationMatrix (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
verticalScaleFactornumber readonlyThe vertical scale factor of the transformation matrix.
verticalTranslationnumber readonlyThe vertical translation of the transformation matrix.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

TransformationMatrix catenateMatrix (withMatrix: TransformationMatrix)
Multiply the transformation matrix by another.

ParameterTypeDescription
withMatrixTransformationMatrixThe right hand matrix factor

Array of number changeCoordinates (point: Array of number)
Multiply the point by the matrix.

ParameterTypeDescription
pointArray of numberThe point to transform

Array of TransformationMatrix getElements ()
Resolves the object specifier, creating an array of object references.

TransformationMatrix invertMatrix ()
Invert the transformation matrix.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

TransformationMatrix rotateMatrix ([byAngle: number][, byCosine: number][, bySine: number])
Rotate the transformation matrix.

ParameterTypeDescription
byAnglenumberThe counterclockwise rotation angle (Optional)
byCosinenumberThe cosine of the desired rotation (Optional)
bySinenumberThe sine of the desired rotation (Optional)

TransformationMatrix scaleMatrix ([horizontallyBy: number][, verticallyBy: number])
Scale the transformation matrix.

ParameterTypeDescription
horizontallyBynumberThe horizontal scale factor (Optional)
verticallyBynumberThe vertical scale factor (Optional)

TransformationMatrix shearMatrix ([byAngle: number][, bySlope: number])
Shear the transformation matrix.

ParameterTypeDescription
byAnglenumberThe horizontal shear angle (Optional)
bySlopenumberThe horizontal shear slope (Optional)

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

string toSpecifier ()
Retrieves the object specifier.

TransformationMatrix translateMatrix ([horizontallyBy: number][, verticallyBy: number])
Translate the transformation matrix.

ParameterTypeDescription
horizontallyBynumberThe horizontal translation distance (Optional)
verticallyBynumberThe vertical translation distance (Optional)

Element of

Page.masterPageTransform

Used in:

TransformationMatrix TransformationMatrices.nextItem (obj: TransformationMatrix)

TransformationMatrix TransformationMatrices.previousItem (obj: TransformationMatrix)

TransformationMatrix TransformationMatrix.catenateMatrix (withMatrix: TransformationMatrix)

Return

Array of TransformationMatrix Button.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix CheckBox.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix ComboBox.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix EPS.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix EPSText.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix FormField.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Graphic.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix GraphicLine.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Group.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Guide.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix HtmlItem.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Image.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix ImportedPage.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix ListBox.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix MasterSpread.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix MediaItem.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Movie.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix MultiStateObject.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Oval.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix PDF.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix PICT.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Page.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix PageItem.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Polygon.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix RadioButton.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Rectangle.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix SignatureField.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Sound.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix SplineItem.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix Spread.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix TextBox.transformValuesOf (in: CoordinateSpaces)

Array of TransformationMatrix TextFrame.transformValuesOf (in: CoordinateSpaces)

TransformationMatrix TransformationMatrices.[] (index: number)

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

TransformationMatrix TransformationMatrices.anyItem ()

Array of TransformationMatrix TransformationMatrices.everyItem ()

TransformationMatrix TransformationMatrices.firstItem ()

TransformationMatrix TransformationMatrices.item (index: varies)

TransformationMatrix TransformationMatrices.itemByName (name: string)

Array of TransformationMatrix TransformationMatrices.itemByRange (from: varies, to: varies)

TransformationMatrix TransformationMatrices.lastItem ()

TransformationMatrix TransformationMatrices.middleItem ()

TransformationMatrix TransformationMatrices.nextItem (obj: TransformationMatrix)

TransformationMatrix TransformationMatrices.previousItem (obj: TransformationMatrix)

TransformationMatrix TransformationMatrix.catenateMatrix (withMatrix: TransformationMatrix)

Array of TransformationMatrix TransformationMatrix.getElements ()

TransformationMatrix TransformationMatrix.invertMatrix ()

TransformationMatrix TransformationMatrix.rotateMatrix ([byAngle: number][, byCosine: number][, bySine: number])

TransformationMatrix TransformationMatrix.scaleMatrix ([horizontallyBy: number][, verticallyBy: number])

TransformationMatrix TransformationMatrix.shearMatrix ([byAngle: number][, bySlope: number])

TransformationMatrix TransformationMatrix.translateMatrix ([horizontallyBy: number][, verticallyBy: number])

Array of TransformationMatrix WMF.transformValuesOf (in: CoordinateSpaces)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index