Adobe 65011817 Extended User Guide - Page 12

Last updated 12/8/2009 EXTENDING FIREWORKS 8 The Fireworks Object Model Matrix data type The format for a matrix is {matrix:[float, float, float, float, float, float, float, float, float]}. This guide assumes that you know how to use these nine values to construct a three-by-three transformation matrix; discussion of the construction of transformation matrices is beyond the scope of this manual. Point data type The format for a point is {x:float, y:float}. For instance, dom.addNewLine(startPoint, endPoint) could look like the following example: fw.getDocumentDOM().addNewLine({x:64.5, y:279.5}, {x:393.5, y:421.5}); Rectangle data type The format for a rectangle is {left:float, top:float, right: float, bottom: float}. For instance, dom.addNewOval(boundingRectangle) could look like the following example: fw.getDocumentDOM().addNewOval({left:72, top:79, right:236, bottom:228}); Resolution data type The format for resolution is {pixelsPerUnit: float, units: string}. Acceptable values for units are "inch" or "cm". For instance, dom.setDocumentResolution(resolution) could look like the following example: fw.getDocumentDOM().setDocumentResolution({pixelsPerUnit:72, units:"inch"}); Using Fireworks API functions Three categories of API functions are described in this book: Document functions, History panel functions, and Fireworks functions. The following rules apply to all functions. Zero-based indexes Some functions take an index argument which is a zero-based, one-dimensional array. That means a value of 0 represents the first item in the array, 1 represents the second item, and so on. For example, the following command deletes the second layer of the active Fireworks document: fw.getDocumentDOM().deleteLayer(2); Functions that take a frameIndex argument can be passed -1 to indicate the current frame. Similarly, functions that take a layerIndex argument may be passed -1 to indicate the current layer. Passing null values In general, passing a null value to a function causes an exception to be thrown. A few functions do allow null as an argument; such cases are noted in the function descriptions. Working with selected elements Many API functions in this chapter refer to a "selection" or to "selected items." These terms refer to Fireworks elements, such as text boxes or images, that are currently selected. In most cases, the functions work even if only one item is selected. If a function requires more than one selected item, this is noted in the description of the function.