1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Getting Object Properties</title>
</head>
<style>
@import "manual.css";
</style>
<body>
<h2>Getting Object Properties</h2>
<dl>
<dt><a name="-getObjectType"><strong>getObjectType</strong></a>(...)</dt>
<dd><code>getObjectType(["name"]) -> string</code>
<p>Get type of object "name" as a string. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getCornerRadius"><strong>getCornerRadius</strong></a>(...)</dt>
<dd><code>getCornerRadius(["name"]) -> integer</code>
<p>Returns the corner radius of the object "name". The radius is expressed in points. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getCustomLineStyle"><strong>getCustomLineStyle</strong></a>(...)</dt>
<dd><code>getCustomLineStyle(["name"]) -> string</code>
<p>Returns the style name of custom line style for the object. If object's "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getFillBlendmode"><strong>getFillBlendmode</strong>(...)</a></dt>
<dd><code>getFillBlendmode(["name"]) -> integer</code>
<p>Returns the fill blendmode of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
<dt><a name="-getFillColor"><strong>getFillColor</strong></a>(...)</dt>
<dd><code>getFillColor(["name"]) -> string</code>
<p>Returns the name of the fill color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getFillShade"><strong>getFillShade</strong></a>(...)</dt>
<dd><code>getFillShade(["name"]) -> integer</code>
<p>Returns the shading value of the fill color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getFillTransparency"><strong>getFillTransparency</strong>(...)</a></dt>
<dd><code>getFillTransparency(["name"]) -> float</code>
<p>Returns the fill transparency of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
<dt><a name="-getImageColorSpace"><strong>getImageColorSpace</strong></a>(...)</dt>
<dd><code>getImageColorSpace(["name"]) -> integer (see CSPACE_* constants)</code>
<p>Returns the color space of the image loaded in image frame "name" as one of following integer constants:
<ul>
<li>CSPACE_RGB</li>
<li>CSPACE_CMYK</li>
<li>CSPACE_GRAY</li>
<li>CSPACE_DUOTONE</li>
<li>CSPACE_MONOCHROME.</li>
</ul>
</p>
<p>Returns CSPACE_UNDEFINED if there is no image loaded in the frame.</p>
<p>If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getImageFile"><strong>getImageFile</strong></a>(...)</dt>
<dd><code>getImageFile(["name"]) -> string</code>
<p>Returns the filename for the image in the image frame. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getImageOffset"><strong>getImageOffset</strong></a>(...)</dt>
<dd><code>getImageOffset(["name"]) -> (x,y)</code>
<p>Returns a (x, y) tuple containing the offset values in point unit of the image frame "name". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getImageScale"><strong>getImageScale</strong></a>(...)</dt>
<dd><code>getImageScale(["name"]) -> (x,y)</code>
<p>Returns a (x, y) tuple containing the scaling values of the image frame "name". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getLineBlendmode"><strong>getLineBlendmode</strong>(...)</a></dt>
<dd><code>getLineBlendmode(["name"]) -> integer</code>
<p>Returns the line blendmode of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
<dt><a name="-getLineCap"><strong>getLineCap</strong></a>(...)</dt>
<dd><code>getLineEnd(["name"]) -> integer (see constants)</code>
<p>Returns the line cap style of the object "name". If "name" is not given the currently selected item is used. The cap types are: CAP_FLAT, CAP_ROUND, CAP_SQUARE</p></dd>
<dt><a name="-getLineColor"><strong>getLineColor</strong></a>(...)</dt>
<dd><code>getLineColor(["name"]) -> string</code>
<p>Returns the name of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getLineJoin"><strong>getLineJoin</strong></a>(...)</dt>
<dd><code>getLineJoin(["name"]) -> integer (see contants)</code>
<p>Returns the line join style of the object "name". If "name" is not given the currently selected item is used. The join types are: JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND</p></dd>
<dt><a name="-getLineShade"><strong>getLineShade</strong></a>(...)</dt>
<dd><code>getLineShade(["name"]) -> integer</code>
<p>Returns the shading value of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getLineStyle"><strong>getLineStyle</strong></a>(...)</dt>
<dd><code>getLineStyle(["name"]) -> integer (see constants)</code>
<p>Returns the line style of the object "name". If "name" is not given the currently selected item is used. Line style constants are: LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID</p></dd>
<dt><a name="-getLineTransparency"><strong>getLineTransparency</strong>(...)</a></dt>
<dd><code>getLineTransparency(["name"]) -> float</code>
<p>Returns the line transparency of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
<dd><code>getLineWidth(["name"]) -> integer</code>
<p>Returns the line width of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
<dt><a name="-getObjectAttributes"><strong>getObjectAttributes</strong></a>(...)</dt>
<dd><code>getObjectAttributes(["name"]) -> list</code>
<p>Returns a list containing all attributes of object "name". If "name" is not given the currently selected Item is used.</p></dd>
<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
<dd><code>getPosition(["name"]) -> (x,y)</code>
<p>Returns a (x, y) tuple with the position of the object "name". If "name" is not given the currently selected item is used. The position is expressed in the actual measurement unit of the document - see UNIT_<type> for reference.</p></dd>
<dt><a name="-getRotation"><strong>getRotation</strong></a>(...)</dt>
<dd><code>getRotation(["name"]) -> integer</code>
<p>Returns the rotation of the object "name". The value is expressed in degrees, and clockwise is positive. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getSize"><strong>getSize</strong></a>(...)</dt>
<dd><code>getSize(["name"]) -> (width,height)</code>
<p>Returns a (width, height) tuple with the size of the object "name". If "name" is not given the currently selected item is used. The size is expressed in the current measurement unit of the document - see UNIT_<type> for reference.</p></dd>
</dl>
</body>
</html>
|
