Adobe 0046100128056 Scripting Guide - Page 61

Converting item shapes, IntersectPath, MinusBack, and SubtractPath.

Page 61 highlights

CHAPTER 5: Working with Page Items Duplicating and Moving Page Items 61 item supports the following methods related to the Pathfinder features: AddPath, ExcludeOverlapPath, IntersectPath, MinusBack, and SubtractPath. All of the Pathfinder methods work the same way--you provide an array of page items to use as the basis for the operation (just as you select a series of page items before choosing the Pathfinder operation in the user interface). Note that it is very likely that the type of the object will change after you apply one of the Pathfinder operations. Which object type it will change to depends on the number and location of the points in the path or paths resulting from the operation. To merge two page items into a single page item, for example, you would use something like the approach shown in the following fragment (for the complete script, refer to AddPath). //Given a rectangle "myRectangle" and an Oval "myOval"... myRectangle.addPath(myOval); The excludeOverlapPath method creates a new path based on the non-intersecting areas of two or more overlapping page items, as shown in the following script fragment (for the complete script, refer to ExcludeOverlapPath). //Given a rectangle "myRectangle" and an Oval "myOval"... myRectangle.excludeOverlapPath(myOval); The intersectPath method creates a new page item from the area of intersection of two or more page items, as shown in the following script fragment (for the complete script, refer to IntersectPath). //Given a rectangle "myRectangle" and an Oval "myOval"... myRectangle.intersect(myOval); The minusBack method removes the area of intersection of the back-most object from the page item or page items in front of it, as shown in the following script fragment (for the complete script, refer to MinusBack). //Given a rectangle "myRectangle" and an Oval "myOval"... myRectangle.minusBack(myOval); The subtractPath method removes the area of intersection of the frontmost object from the page item or page items behind it, as shown in the following script fragment (for the complete script, refer to SubtractPath). //Given a rectangle "myRectangle" and an Oval "myOval"... myOval.subtractPath(myRetangle); Converting page-item shapes InDesign page items can be converted to other shapes using the options in the Object > Convert Shape menu or the Pathfinder panel (Window > Object and Layout > Pathfinder). In InDesign scripting, page items support the convertShape method, as demonstrated in the following script fragment (for the complete script, refer to ConvertShape). //Given a rectangle "myRectangle"... myRectangle.convertShape(ConvertShapeOptions.convertToRoundedRectangle); The convertShape method also provides a way to open or close reverse paths, as shown in the following script fragment (for the complete script, refer to OpenPath).

  • 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
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209

C
HAPTER
5: Working with Page Items
Duplicating and Moving Page Items
61
item supports the following methods related to the Pathfinder features: AddPath, ExcludeOverlapPath,
IntersectPath, MinusBack, and SubtractPath.
All of the Pathfinder methods work the same way--you provide an array of page items to use as the basis
for the operation (just as you select a series of page items before choosing the Pathfinder operation in the
user interface).
Note that it is very likely that the type of the object will change after you apply one of the Pathfinder
operations. Which object type it will change to depends on the number and location of the points in the
path or paths resulting from the operation.
To merge two page items into a single page item, for example, you would use something like the approach
shown in the following fragment (for the complete script, refer to AddPath).
//Given a rectangle "myRectangle" and an Oval "myOval"...
myRectangle.addPath(myOval);
The excludeOverlapPath method creates a new path based on the non-intersecting areas of two or more
overlapping page items, as shown in the following script fragment (for the complete script, refer to
ExcludeOverlapPath).
//Given a rectangle "myRectangle" and an Oval "myOval"...
myRectangle.excludeOverlapPath(myOval);
The intersectPath method creates a new page item from the area of intersection of two or more page
items, as shown in the following script fragment (for the complete script, refer to IntersectPath).
//Given a rectangle "myRectangle" and an Oval "myOval"...
myRectangle.intersect(myOval);
The minusBack method removes the area of intersection of the back-most object from the page item or
page items in front of it, as shown in the following script fragment (for the complete script, refer to
MinusBack).
//Given a rectangle "myRectangle" and an Oval "myOval"...
myRectangle.minusBack(myOval);
The subtractPath method removes the area of intersection of the frontmost object from the page item or
page items behind it, as shown in the following script fragment (for the complete script, refer to
SubtractPath).
//Given a rectangle "myRectangle" and an Oval "myOval"...
myOval.subtractPath(myRetangle);
Converting page-item shapes
InDesign page items can be converted to other shapes using the options in the Object > Convert Shape
menu or the Pathfinder panel (Window > Object and Layout > Pathfinder). In InDesign scripting, page
items support the convertShape method, as demonstrated in the following script fragment (for the
complete script, refer to ConvertShape).
//Given a rectangle "myRectangle"...
myRectangle.convertShape(ConvertShapeOptions.convertToRoundedRectangle);
The convertShape method also provides a way to open or close reverse paths, as shown in the following
script fragment (for the complete script, refer to OpenPath).