@paged-media/introspect-wasm 0.51.0 → 0.61.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/catalog.json +1336 -0
- package/package.json +3 -2
- package/paged_introspect_wasm.d.ts +123 -27
- package/paged_introspect_wasm.js +27 -0
- package/paged_introspect_wasm_bg.wasm +0 -0
package/catalog.json
ADDED
|
@@ -0,0 +1,1336 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hostFunctions": [
|
|
3
|
+
{
|
|
4
|
+
"name": "paged.set",
|
|
5
|
+
"params": "(id, path, value)",
|
|
6
|
+
"returns": "bool",
|
|
7
|
+
"kind": "write",
|
|
8
|
+
"summary": "Set a property (see settablePaths) on the addressed element. null clears."
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"name": "paged.get",
|
|
12
|
+
"params": "(id, path)",
|
|
13
|
+
"returns": "value | null",
|
|
14
|
+
"kind": "read",
|
|
15
|
+
"summary": "Read one property value of the addressed element."
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"name": "paged.insertText",
|
|
19
|
+
"params": "(storyId, offset, text)",
|
|
20
|
+
"returns": "bool",
|
|
21
|
+
"kind": "author",
|
|
22
|
+
"summary": "Insert plain text at a story body offset; \\n splits paragraphs."
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "paged.deleteRange",
|
|
26
|
+
"params": "(storyId, start, end)",
|
|
27
|
+
"returns": "bool",
|
|
28
|
+
"kind": "author",
|
|
29
|
+
"summary": "Delete the [start, end) character range of a story."
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "paged.insertTextFrame",
|
|
33
|
+
"params": "(pageId, [t,l,b,r])",
|
|
34
|
+
"returns": "string (created id) | null",
|
|
35
|
+
"kind": "author",
|
|
36
|
+
"summary": "Create an empty text-pourable frame at page-local point bounds (mints a story) and select it. Returns the new textFrame:<id> address, or null on failure."
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "paged.insertFrame",
|
|
40
|
+
"params": "(pageId, [t,l,b,r])",
|
|
41
|
+
"returns": "string (created id) | null",
|
|
42
|
+
"kind": "author",
|
|
43
|
+
"summary": "Create an empty graphic (non-text) frame and select it; the usual placeImage target. Returns the new frame's kind:id address, or null."
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "paged.insertPage",
|
|
47
|
+
"params": "(afterPageId?)",
|
|
48
|
+
"returns": "string (page selfId) | null",
|
|
49
|
+
"kind": "author",
|
|
50
|
+
"summary": "Append a page after afterPageId (or at the end), inheriting the default master. Returns the new page's selfId (reusable as the next afterPageId), or null."
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "paged.placeImage",
|
|
54
|
+
"params": "(frameId, uri, fit?)",
|
|
55
|
+
"returns": "bool",
|
|
56
|
+
"kind": "author",
|
|
57
|
+
"summary": "Place an image into a frame; fit is an optional fitting mode."
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "paged.applyStyle",
|
|
61
|
+
"params": "(storyId, start, end, styleRef)",
|
|
62
|
+
"returns": "bool",
|
|
63
|
+
"kind": "author",
|
|
64
|
+
"summary": "Apply a paragraph/character style to a story range. Scope inferred from the ref prefix (CharacterStyle/… else Paragraph)."
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "paged.createGroup",
|
|
68
|
+
"params": "([id, ...])",
|
|
69
|
+
"returns": "bool",
|
|
70
|
+
"kind": "author",
|
|
71
|
+
"summary": "Group two-or-more elements; <2 valid members returns false."
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "paged.undo",
|
|
75
|
+
"params": "()",
|
|
76
|
+
"returns": "bool",
|
|
77
|
+
"kind": "history",
|
|
78
|
+
"summary": "Undo the last mutation."
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "paged.redo",
|
|
82
|
+
"params": "()",
|
|
83
|
+
"returns": "bool",
|
|
84
|
+
"kind": "history",
|
|
85
|
+
"summary": "Redo the last undone mutation."
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"name": "paged.inspect",
|
|
89
|
+
"params": "(id)",
|
|
90
|
+
"returns": "ElementProperties JSON",
|
|
91
|
+
"kind": "read",
|
|
92
|
+
"summary": "Full property snapshot for one element (or storyRange)."
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "paged.tree",
|
|
96
|
+
"params": "()",
|
|
97
|
+
"returns": "SceneTreeNode[] JSON",
|
|
98
|
+
"kind": "read",
|
|
99
|
+
"summary": "Document hierarchy: spreads → pages → frames."
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
"name": "paged.pages",
|
|
103
|
+
"params": "()",
|
|
104
|
+
"returns": "PageSummary[] JSON",
|
|
105
|
+
"kind": "read",
|
|
106
|
+
"summary": "Pages with selfId + 1-based index + sizePt. selfId is the page id for insertFrame/insertTextFrame/insertPage (and the afterPageId of insertPage) — the only way a script can obtain a usable page id."
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"name": "paged.stories",
|
|
110
|
+
"params": "()",
|
|
111
|
+
"returns": "StorySummary[] JSON",
|
|
112
|
+
"kind": "read",
|
|
113
|
+
"summary": "Loaded stories with selfId + characterCount + paragraphCount. The source of valid story ids."
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "paged.layers",
|
|
117
|
+
"params": "()",
|
|
118
|
+
"returns": "LayerSummary[] JSON",
|
|
119
|
+
"kind": "read",
|
|
120
|
+
"summary": "Document layers."
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"name": "paged.swatches",
|
|
124
|
+
"params": "()",
|
|
125
|
+
"returns": "SwatchSummary[] JSON",
|
|
126
|
+
"kind": "read",
|
|
127
|
+
"summary": "Colour palette (selfId/name/kind)."
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"name": "paged.paragraphStyles",
|
|
131
|
+
"params": "()",
|
|
132
|
+
"returns": "ParagraphStyleSummary[] JSON",
|
|
133
|
+
"kind": "read",
|
|
134
|
+
"summary": "Paragraph styles — the source of valid styleRefs for applyStyle."
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"name": "paged.characterStyles",
|
|
138
|
+
"params": "()",
|
|
139
|
+
"returns": "CharacterStyleSummary[] JSON",
|
|
140
|
+
"kind": "read",
|
|
141
|
+
"summary": "Character styles."
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"name": "paged.objectStyles",
|
|
145
|
+
"params": "()",
|
|
146
|
+
"returns": "ObjectStyleSummary[] JSON",
|
|
147
|
+
"kind": "read",
|
|
148
|
+
"summary": "Object styles."
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
"name": "paged.gradients",
|
|
152
|
+
"params": "()",
|
|
153
|
+
"returns": "GradientSummary[] JSON",
|
|
154
|
+
"kind": "read",
|
|
155
|
+
"summary": "Gradients."
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"name": "paged.colorGroups",
|
|
159
|
+
"params": "()",
|
|
160
|
+
"returns": "ColorGroupSummary[] JSON",
|
|
161
|
+
"kind": "read",
|
|
162
|
+
"summary": "Colour groups."
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
"name": "paged.links",
|
|
166
|
+
"params": "()",
|
|
167
|
+
"returns": "LinkSummary[] JSON",
|
|
168
|
+
"kind": "read",
|
|
169
|
+
"summary": "Placed-asset links."
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"name": "paged.conditions",
|
|
173
|
+
"params": "()",
|
|
174
|
+
"returns": "ConditionSummary[] JSON",
|
|
175
|
+
"kind": "read",
|
|
176
|
+
"summary": "Conditional-text conditions."
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"name": "paged.conditionSets",
|
|
180
|
+
"params": "()",
|
|
181
|
+
"returns": "ConditionSetSummary[] JSON",
|
|
182
|
+
"kind": "read",
|
|
183
|
+
"summary": "Condition sets."
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"name": "paged.collection",
|
|
187
|
+
"params": "(name)",
|
|
188
|
+
"returns": "Summary[] JSON",
|
|
189
|
+
"kind": "read",
|
|
190
|
+
"summary": "Generic typed-collection read by name; unknown name → \"[]\" + warning."
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"name": "paged.documentMeta",
|
|
194
|
+
"params": "()",
|
|
195
|
+
"returns": "DocumentMeta JSON",
|
|
196
|
+
"kind": "read",
|
|
197
|
+
"summary": "Document metadata (name/creator/modified/page count)."
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"name": "paged.selection",
|
|
201
|
+
"params": "()",
|
|
202
|
+
"returns": "ElementId[] JSON",
|
|
203
|
+
"kind": "read",
|
|
204
|
+
"summary": "Current element selection."
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"name": "paged.contentSelection",
|
|
208
|
+
"params": "()",
|
|
209
|
+
"returns": "ContentSelection JSON | null",
|
|
210
|
+
"kind": "read",
|
|
211
|
+
"summary": "Current text caret / range."
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"name": "paged.deletePage",
|
|
215
|
+
"params": "(pageId)",
|
|
216
|
+
"returns": "bool",
|
|
217
|
+
"kind": "author",
|
|
218
|
+
"summary": "Delete a page."
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"name": "paged.duplicatePage",
|
|
222
|
+
"params": "(pageId)",
|
|
223
|
+
"returns": "string | null",
|
|
224
|
+
"kind": "author",
|
|
225
|
+
"summary": "Duplicate a single-page spread after the source; returns the new page selfId."
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"name": "paged.resizePage",
|
|
229
|
+
"params": "(pageId, [t,l,b,r])",
|
|
230
|
+
"returns": "bool",
|
|
231
|
+
"kind": "write",
|
|
232
|
+
"summary": "Set a page's GeometricBounds in page-inner points."
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"name": "paged.applyMasterToPage",
|
|
236
|
+
"params": "(pageId, masterId?)",
|
|
237
|
+
"returns": "bool",
|
|
238
|
+
"kind": "write",
|
|
239
|
+
"summary": "Apply a master to a page (omit/null detaches)."
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"name": "paged.deleteElement",
|
|
243
|
+
"params": "(id)",
|
|
244
|
+
"returns": "bool",
|
|
245
|
+
"kind": "author",
|
|
246
|
+
"summary": "Delete a page item (kind:id address or bare self id)."
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "paged.dissolveGroup",
|
|
250
|
+
"params": "(groupId)",
|
|
251
|
+
"returns": "bool",
|
|
252
|
+
"kind": "author",
|
|
253
|
+
"summary": "Ungroup; members return to the group's paint slot."
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "paged.moveFrame",
|
|
257
|
+
"params": "(frameId, [a,b,c,d,tx,ty])",
|
|
258
|
+
"returns": "bool",
|
|
259
|
+
"kind": "write",
|
|
260
|
+
"summary": "Set a frame's affine placement transform."
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"name": "paged.resizeFrame",
|
|
264
|
+
"params": "(frameId, [t,l,b,r])",
|
|
265
|
+
"returns": "bool",
|
|
266
|
+
"kind": "write",
|
|
267
|
+
"summary": "Set a frame's content-box bounds (re-paginating resize)."
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"name": "paged.linkFrames",
|
|
271
|
+
"params": "(fromId, toId)",
|
|
272
|
+
"returns": "bool",
|
|
273
|
+
"kind": "author",
|
|
274
|
+
"summary": "Thread fromId's overflow into the empty frame toId."
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
"name": "paged.unlinkFrames",
|
|
278
|
+
"params": "(frameId)",
|
|
279
|
+
"returns": "bool",
|
|
280
|
+
"kind": "author",
|
|
281
|
+
"summary": "Break the text thread leaving a frame."
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "paged.insertLine",
|
|
285
|
+
"params": "(pageId, [x1,y1], [x2,y2])",
|
|
286
|
+
"returns": "string | null",
|
|
287
|
+
"kind": "author",
|
|
288
|
+
"summary": "Insert a two-anchor open GraphicLine."
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
"name": "paged.insertOval",
|
|
292
|
+
"params": "(pageId, [t,l,b,r])",
|
|
293
|
+
"returns": "string | null",
|
|
294
|
+
"kind": "author",
|
|
295
|
+
"summary": "Insert an Oval."
|
|
296
|
+
},
|
|
297
|
+
{
|
|
298
|
+
"name": "paged.insertPath",
|
|
299
|
+
"params": "(pageId, anchors, open, smooth?)",
|
|
300
|
+
"returns": "string | null",
|
|
301
|
+
"kind": "author",
|
|
302
|
+
"summary": "Insert an arbitrary path; anchors = [{anchor:[x,y],left:[x,y],right:[x,y]}, …]."
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"name": "paged.pathPointInsert",
|
|
306
|
+
"params": "(elemId, index, anchor, subpathStarts?)",
|
|
307
|
+
"returns": "bool",
|
|
308
|
+
"kind": "author",
|
|
309
|
+
"summary": "Insert an anchor into a path's flat PathPointArray at index."
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
"name": "paged.pathPointRemove",
|
|
313
|
+
"params": "(elemId, index)",
|
|
314
|
+
"returns": "bool",
|
|
315
|
+
"kind": "author",
|
|
316
|
+
"summary": "Remove the anchor at flat index."
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"name": "paged.pathPointCurveType",
|
|
320
|
+
"params": "(elemId, index, smooth)",
|
|
321
|
+
"returns": "bool",
|
|
322
|
+
"kind": "write",
|
|
323
|
+
"summary": "Toggle an anchor between corner and smooth."
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"name": "paged.pathPointSet",
|
|
327
|
+
"params": "(elemId, index, role, [x,y])",
|
|
328
|
+
"returns": "bool",
|
|
329
|
+
"kind": "write",
|
|
330
|
+
"summary": "Write one Bezier handle (role = anchor|left|right)."
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
"name": "paged.pathOpenAt",
|
|
334
|
+
"params": "(elemId, index)",
|
|
335
|
+
"returns": "bool",
|
|
336
|
+
"kind": "write",
|
|
337
|
+
"summary": "Cut the path at the anchor at flat index."
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"name": "paged.outlineStroke",
|
|
341
|
+
"params": "(elemId, width, cap, join, miter)",
|
|
342
|
+
"returns": "bool",
|
|
343
|
+
"kind": "write",
|
|
344
|
+
"summary": "Replace the path with its stroke-expansion outline."
|
|
345
|
+
},
|
|
346
|
+
{
|
|
347
|
+
"name": "paged.offsetPath",
|
|
348
|
+
"params": "(elemId, delta, join, miter)",
|
|
349
|
+
"returns": "bool",
|
|
350
|
+
"kind": "write",
|
|
351
|
+
"summary": "Inset (delta<0) / outset (delta>0) a single closed contour."
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"name": "paged.simplifyPath",
|
|
355
|
+
"params": "(elemId, tolerance)",
|
|
356
|
+
"returns": "bool",
|
|
357
|
+
"kind": "write",
|
|
358
|
+
"summary": "Re-express the path with fewer anchors within tolerance pt."
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"name": "paged.pathfinderBoolean",
|
|
362
|
+
"params": "(keptId, [otherIds], kind)",
|
|
363
|
+
"returns": "bool",
|
|
364
|
+
"kind": "author",
|
|
365
|
+
"summary": "Pathfinder boolean (kind = union|intersect|subtract|exclude)."
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
"name": "paged.insertField",
|
|
369
|
+
"params": "(storyId, offset, fieldKind)",
|
|
370
|
+
"returns": "bool",
|
|
371
|
+
"kind": "author",
|
|
372
|
+
"summary": "Insert a field marker; fieldKind = \"pageNumber\" | \"nextPageNumber\" | { placeholder: { plugin, key, value? } }."
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
"name": "paged.setFieldValue",
|
|
376
|
+
"params": "(storyId, offset, value?)",
|
|
377
|
+
"returns": "bool",
|
|
378
|
+
"kind": "write",
|
|
379
|
+
"summary": "Update a placeholder field's cached display value (null ⇒ unresolved)."
|
|
380
|
+
},
|
|
381
|
+
{
|
|
382
|
+
"name": "paged.replaceImageBytes",
|
|
383
|
+
"params": "(frameId, bytes?)",
|
|
384
|
+
"returns": "bool",
|
|
385
|
+
"kind": "write",
|
|
386
|
+
"summary": "Commit inline image bytes (number[] of u8) on a graphic frame; null clears."
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "paged.insertTable",
|
|
390
|
+
"params": "(storyId, spec)",
|
|
391
|
+
"returns": "string | null",
|
|
392
|
+
"kind": "author",
|
|
393
|
+
"summary": "Create a <Table> at the end of a story; spec = { rows, cols, headerRows?, footerRows?, columnWidths?, rowHeights? }. Returns the table id."
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"name": "paged.setRowHeight",
|
|
397
|
+
"params": "(storyId, tableId, row, height?)",
|
|
398
|
+
"returns": "bool",
|
|
399
|
+
"kind": "write",
|
|
400
|
+
"summary": "Set/clear a table row height in pt."
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
"name": "paged.setColumnWidth",
|
|
404
|
+
"params": "(storyId, tableId, col, width?)",
|
|
405
|
+
"returns": "bool",
|
|
406
|
+
"kind": "write",
|
|
407
|
+
"summary": "Set/clear a table column width in pt."
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"name": "paged.insertTableRow",
|
|
411
|
+
"params": "(storyId, tableId, at)",
|
|
412
|
+
"returns": "bool",
|
|
413
|
+
"kind": "author",
|
|
414
|
+
"summary": "Insert an empty body row at index."
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"name": "paged.deleteTableRow",
|
|
418
|
+
"params": "(storyId, tableId, at)",
|
|
419
|
+
"returns": "bool",
|
|
420
|
+
"kind": "author",
|
|
421
|
+
"summary": "Delete the body row at index."
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "paged.insertTableColumn",
|
|
425
|
+
"params": "(storyId, tableId, at)",
|
|
426
|
+
"returns": "bool",
|
|
427
|
+
"kind": "author",
|
|
428
|
+
"summary": "Insert an empty column at index."
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "paged.deleteTableColumn",
|
|
432
|
+
"params": "(storyId, tableId, at)",
|
|
433
|
+
"returns": "bool",
|
|
434
|
+
"kind": "author",
|
|
435
|
+
"summary": "Delete the column at index."
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"name": "paged.insertHeaderRow",
|
|
439
|
+
"params": "(storyId, tableId)",
|
|
440
|
+
"returns": "bool",
|
|
441
|
+
"kind": "author",
|
|
442
|
+
"summary": "Insert a header-band row."
|
|
443
|
+
},
|
|
444
|
+
{
|
|
445
|
+
"name": "paged.removeHeaderRow",
|
|
446
|
+
"params": "(storyId, tableId)",
|
|
447
|
+
"returns": "bool",
|
|
448
|
+
"kind": "author",
|
|
449
|
+
"summary": "Remove the first header row."
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
"name": "paged.insertFooterRow",
|
|
453
|
+
"params": "(storyId, tableId)",
|
|
454
|
+
"returns": "bool",
|
|
455
|
+
"kind": "author",
|
|
456
|
+
"summary": "Insert a footer-band row."
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"name": "paged.removeFooterRow",
|
|
460
|
+
"params": "(storyId, tableId)",
|
|
461
|
+
"returns": "bool",
|
|
462
|
+
"kind": "author",
|
|
463
|
+
"summary": "Remove the last footer row."
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"name": "paged.setCellSpan",
|
|
467
|
+
"params": "(storyId, tableId, row, col, rowSpan, columnSpan)",
|
|
468
|
+
"returns": "bool",
|
|
469
|
+
"kind": "write",
|
|
470
|
+
"summary": "Set a cell's row/column span."
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"name": "paged.createParagraphStyle",
|
|
474
|
+
"params": "({id?,name?,basedOn?})",
|
|
475
|
+
"returns": "string | null",
|
|
476
|
+
"kind": "author",
|
|
477
|
+
"summary": "Create a paragraph style; returns its selfId."
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
"name": "paged.renameParagraphStyle",
|
|
481
|
+
"params": "(styleId, name)",
|
|
482
|
+
"returns": "bool",
|
|
483
|
+
"kind": "write",
|
|
484
|
+
"summary": "Rename a paragraph style."
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
"name": "paged.deleteParagraphStyle",
|
|
488
|
+
"params": "(styleId)",
|
|
489
|
+
"returns": "bool",
|
|
490
|
+
"kind": "author",
|
|
491
|
+
"summary": "Delete a paragraph style."
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"name": "paged.createCharacterStyle",
|
|
495
|
+
"params": "({id?,name?,basedOn?})",
|
|
496
|
+
"returns": "string | null",
|
|
497
|
+
"kind": "author",
|
|
498
|
+
"summary": "Create a character style; returns its selfId."
|
|
499
|
+
},
|
|
500
|
+
{
|
|
501
|
+
"name": "paged.renameCharacterStyle",
|
|
502
|
+
"params": "(styleId, name)",
|
|
503
|
+
"returns": "bool",
|
|
504
|
+
"kind": "write",
|
|
505
|
+
"summary": "Rename a character style."
|
|
506
|
+
},
|
|
507
|
+
{
|
|
508
|
+
"name": "paged.deleteCharacterStyle",
|
|
509
|
+
"params": "(styleId)",
|
|
510
|
+
"returns": "bool",
|
|
511
|
+
"kind": "author",
|
|
512
|
+
"summary": "Delete a character style."
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"name": "paged.createObjectStyle",
|
|
516
|
+
"params": "({id?,name?,basedOn?})",
|
|
517
|
+
"returns": "string | null",
|
|
518
|
+
"kind": "author",
|
|
519
|
+
"summary": "Create an object style; returns its selfId."
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "paged.renameObjectStyle",
|
|
523
|
+
"params": "(styleId, name)",
|
|
524
|
+
"returns": "bool",
|
|
525
|
+
"kind": "write",
|
|
526
|
+
"summary": "Rename an object style."
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"name": "paged.deleteObjectStyle",
|
|
530
|
+
"params": "(styleId)",
|
|
531
|
+
"returns": "bool",
|
|
532
|
+
"kind": "author",
|
|
533
|
+
"summary": "Delete an object style."
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
"name": "paged.createCellStyle",
|
|
537
|
+
"params": "({id?,name?,basedOn?})",
|
|
538
|
+
"returns": "string | null",
|
|
539
|
+
"kind": "author",
|
|
540
|
+
"summary": "Create a cell style; returns its selfId."
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"name": "paged.renameCellStyle",
|
|
544
|
+
"params": "(styleId, name)",
|
|
545
|
+
"returns": "bool",
|
|
546
|
+
"kind": "write",
|
|
547
|
+
"summary": "Rename a cell style."
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"name": "paged.deleteCellStyle",
|
|
551
|
+
"params": "(styleId)",
|
|
552
|
+
"returns": "bool",
|
|
553
|
+
"kind": "author",
|
|
554
|
+
"summary": "Delete a cell style."
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"name": "paged.createTableStyle",
|
|
558
|
+
"params": "({id?,name?,basedOn?})",
|
|
559
|
+
"returns": "string | null",
|
|
560
|
+
"kind": "author",
|
|
561
|
+
"summary": "Create a table style; returns its selfId."
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"name": "paged.renameTableStyle",
|
|
565
|
+
"params": "(styleId, name)",
|
|
566
|
+
"returns": "bool",
|
|
567
|
+
"kind": "write",
|
|
568
|
+
"summary": "Rename a table style."
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
"name": "paged.deleteTableStyle",
|
|
572
|
+
"params": "(styleId)",
|
|
573
|
+
"returns": "bool",
|
|
574
|
+
"kind": "author",
|
|
575
|
+
"summary": "Delete a table style."
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"name": "paged.setStyleProperty",
|
|
579
|
+
"params": "(collection, styleId, path, value)",
|
|
580
|
+
"returns": "bool",
|
|
581
|
+
"kind": "write",
|
|
582
|
+
"summary": "Set one property on a style definition (collection = paragraph|character|object|cell|table; path = a settablePaths name)."
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"name": "paged.createNumberingList",
|
|
586
|
+
"params": "(spec)",
|
|
587
|
+
"returns": "string | null",
|
|
588
|
+
"kind": "author",
|
|
589
|
+
"summary": "Create a <NumberingList>; returns its id."
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
"name": "paged.editNumberingList",
|
|
593
|
+
"params": "(listId, spec)",
|
|
594
|
+
"returns": "bool",
|
|
595
|
+
"kind": "write",
|
|
596
|
+
"summary": "Edit a <NumberingList>."
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"name": "paged.deleteNumberingList",
|
|
600
|
+
"params": "(listId)",
|
|
601
|
+
"returns": "bool",
|
|
602
|
+
"kind": "author",
|
|
603
|
+
"summary": "Delete a <NumberingList>."
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
"name": "paged.insertSection",
|
|
607
|
+
"params": "(pageId, {prefix?,style?,start?})",
|
|
608
|
+
"returns": "bool",
|
|
609
|
+
"kind": "author",
|
|
610
|
+
"summary": "Anchor a <Section> at a page."
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"name": "paged.editSection",
|
|
614
|
+
"params": "(sectionId, {prefix?,style?,start?})",
|
|
615
|
+
"returns": "bool",
|
|
616
|
+
"kind": "write",
|
|
617
|
+
"summary": "Edit a <Section>; prefix/start are tri-state (omit ⇒ leave, null ⇒ clear)."
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
"name": "paged.deleteSection",
|
|
621
|
+
"params": "(sectionId)",
|
|
622
|
+
"returns": "bool",
|
|
623
|
+
"kind": "author",
|
|
624
|
+
"summary": "Delete a <Section>."
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"name": "paged.setConditionVisible",
|
|
628
|
+
"params": "(conditionId, visible)",
|
|
629
|
+
"returns": "bool",
|
|
630
|
+
"kind": "write",
|
|
631
|
+
"summary": "Flip a condition's visibility."
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"name": "paged.activateConditionSet",
|
|
635
|
+
"params": "(setId)",
|
|
636
|
+
"returns": "bool",
|
|
637
|
+
"kind": "write",
|
|
638
|
+
"summary": "Activate one <ConditionSet> (\"show only this set\")."
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
"name": "paged.layerInsert",
|
|
642
|
+
"params": "(position, name)",
|
|
643
|
+
"returns": "bool",
|
|
644
|
+
"kind": "author",
|
|
645
|
+
"summary": "Append a layer at the zero-based stacking index."
|
|
646
|
+
},
|
|
647
|
+
{
|
|
648
|
+
"name": "paged.layerRemove",
|
|
649
|
+
"params": "(layerId)",
|
|
650
|
+
"returns": "bool",
|
|
651
|
+
"kind": "author",
|
|
652
|
+
"summary": "Remove a layer."
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"name": "paged.layerMove",
|
|
656
|
+
"params": "(layerId, newIndex)",
|
|
657
|
+
"returns": "bool",
|
|
658
|
+
"kind": "write",
|
|
659
|
+
"summary": "Reorder a layer to a new zero-based index."
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"name": "paged.insertGuide",
|
|
663
|
+
"params": "(spreadId, orientation, position, pageIndex?)",
|
|
664
|
+
"returns": "bool",
|
|
665
|
+
"kind": "author",
|
|
666
|
+
"summary": "Insert a ruler guide (orientation = vertical|horizontal)."
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "paged.moveGuide",
|
|
670
|
+
"params": "(guideId, position)",
|
|
671
|
+
"returns": "bool",
|
|
672
|
+
"kind": "write",
|
|
673
|
+
"summary": "Move a guide along its perpendicular axis."
|
|
674
|
+
},
|
|
675
|
+
{
|
|
676
|
+
"name": "paged.deleteGuide",
|
|
677
|
+
"params": "(guideId)",
|
|
678
|
+
"returns": "bool",
|
|
679
|
+
"kind": "author",
|
|
680
|
+
"summary": "Delete a guide."
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "paged.setDocumentDefaults",
|
|
684
|
+
"params": "({fill?,stroke?,weight?})",
|
|
685
|
+
"returns": "bool",
|
|
686
|
+
"kind": "write",
|
|
687
|
+
"summary": "Set the new-object fill/stroke/weight defaults (whole-triple)."
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
"name": "paged.setColorSettings",
|
|
691
|
+
"params": "({cmykProfileName?,rgbPolicy?,intent?,bpc?})",
|
|
692
|
+
"returns": "bool",
|
|
693
|
+
"kind": "write",
|
|
694
|
+
"summary": "Replace the document colour-management settings."
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"name": "paged.setProofSetup",
|
|
698
|
+
"params": "({profileName?,simulatePaperWhite?,intent?})",
|
|
699
|
+
"returns": "bool",
|
|
700
|
+
"kind": "write",
|
|
701
|
+
"summary": "Soft-proofing configuration (profileName null turns proofing off)."
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"name": "paged.importSwatchLibrary",
|
|
705
|
+
"params": "(bytes, groupName?)",
|
|
706
|
+
"returns": "bool",
|
|
707
|
+
"kind": "author",
|
|
708
|
+
"summary": "Import an .ase swatch library (bytes = number[]) as one undoable op."
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
"name": "paged.setInkSetting",
|
|
712
|
+
"params": "(spotId, {convertToProcess?,aliasTo?})",
|
|
713
|
+
"returns": "bool",
|
|
714
|
+
"kind": "write",
|
|
715
|
+
"summary": "Replace one ink's output-time settings."
|
|
716
|
+
},
|
|
717
|
+
{
|
|
718
|
+
"name": "paged.setUseStandardLabForSpots",
|
|
719
|
+
"params": "(enabled)",
|
|
720
|
+
"returns": "bool",
|
|
721
|
+
"kind": "write",
|
|
722
|
+
"summary": "Prefer spots' Lab primary over their CMYK alternate in previews."
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"name": "paged.setPluginMetadata",
|
|
726
|
+
"params": "(elemId, key, value?, caller?)",
|
|
727
|
+
"returns": "bool",
|
|
728
|
+
"kind": "write",
|
|
729
|
+
"summary": "Write one Label key/value pair on a leaf page item (value null deletes)."
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
"name": "paged.batch",
|
|
733
|
+
"params": "([mutations])",
|
|
734
|
+
"returns": "bool",
|
|
735
|
+
"kind": "author",
|
|
736
|
+
"summary": "Apply an array of { op, args } mutation objects as ONE undoable step."
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"name": "paged.setElementSelection",
|
|
740
|
+
"params": "([id, ...])",
|
|
741
|
+
"returns": "bool",
|
|
742
|
+
"kind": "write",
|
|
743
|
+
"summary": "Replace the element selection with the parseable ids."
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
"name": "paged.clearSelection",
|
|
747
|
+
"params": "()",
|
|
748
|
+
"returns": "bool",
|
|
749
|
+
"kind": "write",
|
|
750
|
+
"summary": "Clear the element selection."
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
"name": "paged.setContentSelection",
|
|
754
|
+
"params": "({storyId,start,end} | null)",
|
|
755
|
+
"returns": "bool",
|
|
756
|
+
"kind": "write",
|
|
757
|
+
"summary": "Set or clear the text caret/range."
|
|
758
|
+
},
|
|
759
|
+
{
|
|
760
|
+
"name": "console.log",
|
|
761
|
+
"params": "(...)",
|
|
762
|
+
"returns": "undefined",
|
|
763
|
+
"kind": "console",
|
|
764
|
+
"summary": "Append a line to the captured output log (also warn/error/info)."
|
|
765
|
+
}
|
|
766
|
+
],
|
|
767
|
+
"idGrammar": [
|
|
768
|
+
{
|
|
769
|
+
"form": "textFrame:<id>",
|
|
770
|
+
"example": "textFrame:u123",
|
|
771
|
+
"note": "A text frame. Same scheme: rectangle:/oval:/polygon:/graphicLine:/group:."
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"form": "group:<id>",
|
|
775
|
+
"example": "group:u88",
|
|
776
|
+
"note": "A group. `paged.set(\"group:<id>\", \"groupTransform\", [a,b,c,d,tx,ty])` moves it as a unit."
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"form": "storyRange:<storyId>@<start>..<end>",
|
|
780
|
+
"example": "storyRange:Story/u1@0..6",
|
|
781
|
+
"note": "A character range within a story (half-open). storyId comes from paged.stories()[].selfId."
|
|
782
|
+
}
|
|
783
|
+
],
|
|
784
|
+
"settablePaths": [
|
|
785
|
+
"frameBounds",
|
|
786
|
+
"frameFillColor",
|
|
787
|
+
"frameStrokeColor",
|
|
788
|
+
"frameStrokeWeight",
|
|
789
|
+
"frameOpacity",
|
|
790
|
+
"frameTransform",
|
|
791
|
+
"imageContentTransform",
|
|
792
|
+
"framePathPoint",
|
|
793
|
+
"pathPointInsert",
|
|
794
|
+
"pathPointRemove",
|
|
795
|
+
"pathPointCurveType",
|
|
796
|
+
"layerVisible",
|
|
797
|
+
"layerLocked",
|
|
798
|
+
"layerPrintable",
|
|
799
|
+
"layerName",
|
|
800
|
+
"characterFontSize",
|
|
801
|
+
"characterLeading",
|
|
802
|
+
"characterTracking",
|
|
803
|
+
"characterFillColor",
|
|
804
|
+
"paragraphSpaceBefore",
|
|
805
|
+
"paragraphSpaceAfter",
|
|
806
|
+
"paragraphFirstLineIndent",
|
|
807
|
+
"appliedParagraphStyle",
|
|
808
|
+
"appliedCharacterStyle",
|
|
809
|
+
"appliedObjectStyle",
|
|
810
|
+
"appliedCellStyle",
|
|
811
|
+
"appliedTableStyle",
|
|
812
|
+
"appliedConditions",
|
|
813
|
+
"frameInsetSpacing",
|
|
814
|
+
"paragraphJustification",
|
|
815
|
+
"paragraphStyleNextStyle",
|
|
816
|
+
"paragraphAppliedNumberingList",
|
|
817
|
+
"frameStrokeEndCap",
|
|
818
|
+
"frameStrokeStartArrowhead",
|
|
819
|
+
"frameStrokeEndArrowhead",
|
|
820
|
+
"frameTextWrapMode",
|
|
821
|
+
"frameTextWrapOffsets",
|
|
822
|
+
"frameTextWrapContourType",
|
|
823
|
+
"frameTextWrapContourIncludeInside",
|
|
824
|
+
"frameFittingCrops",
|
|
825
|
+
"frameFittingType",
|
|
826
|
+
"frameDropShadow",
|
|
827
|
+
"frameDropShadowMode",
|
|
828
|
+
"frameDropShadowXOffset",
|
|
829
|
+
"frameDropShadowYOffset",
|
|
830
|
+
"frameDropShadowSize",
|
|
831
|
+
"frameDropShadowOpacity",
|
|
832
|
+
"frameDropShadowColor",
|
|
833
|
+
"framePath",
|
|
834
|
+
"frameFillTint",
|
|
835
|
+
"frameNonprinting",
|
|
836
|
+
"frameGradientFillAngle",
|
|
837
|
+
"frameGradientFillLength",
|
|
838
|
+
"frameGradientStrokeAngle",
|
|
839
|
+
"frameGradientStrokeLength",
|
|
840
|
+
"textFrameColumnCount",
|
|
841
|
+
"textFrameColumnGutter",
|
|
842
|
+
"textFrameColumnBalance",
|
|
843
|
+
"textFrameVerticalJustification",
|
|
844
|
+
"textFrameAutoSizing",
|
|
845
|
+
"textFrameFirstBaseline",
|
|
846
|
+
"frameTextWrapInvert",
|
|
847
|
+
"frameFittingReferencePoint",
|
|
848
|
+
"frameAutoFit",
|
|
849
|
+
"frameStrokeType",
|
|
850
|
+
"frameStrokeJoin",
|
|
851
|
+
"frameStrokeMiterLimit",
|
|
852
|
+
"frameStrokeAlignment",
|
|
853
|
+
"frameStrokeGapColor",
|
|
854
|
+
"frameStrokeGapTint",
|
|
855
|
+
"frameStrokeDashArray",
|
|
856
|
+
"frameCornerOptionTopLeft",
|
|
857
|
+
"frameCornerOptionTopRight",
|
|
858
|
+
"frameCornerOptionBottomLeft",
|
|
859
|
+
"frameCornerOptionBottomRight",
|
|
860
|
+
"frameCornerRadiusTopLeft",
|
|
861
|
+
"frameCornerRadiusTopRight",
|
|
862
|
+
"frameCornerRadiusBottomLeft",
|
|
863
|
+
"frameCornerRadiusBottomRight",
|
|
864
|
+
"frameRotationAngle",
|
|
865
|
+
"frameScaleX",
|
|
866
|
+
"frameScaleY",
|
|
867
|
+
"frameFlipH",
|
|
868
|
+
"frameFlipV",
|
|
869
|
+
"frameOverprintFill",
|
|
870
|
+
"frameOverprintStroke",
|
|
871
|
+
"frameInnerShadow",
|
|
872
|
+
"frameInnerShadowBlendMode",
|
|
873
|
+
"frameInnerShadowColor",
|
|
874
|
+
"frameInnerShadowOpacity",
|
|
875
|
+
"frameInnerShadowAngle",
|
|
876
|
+
"frameInnerShadowDistance",
|
|
877
|
+
"frameInnerShadowSize",
|
|
878
|
+
"frameInnerShadowChoke",
|
|
879
|
+
"frameInnerShadowNoise",
|
|
880
|
+
"frameOuterGlow",
|
|
881
|
+
"frameOuterGlowBlendMode",
|
|
882
|
+
"frameOuterGlowColor",
|
|
883
|
+
"frameOuterGlowOpacity",
|
|
884
|
+
"frameOuterGlowSpread",
|
|
885
|
+
"frameOuterGlowSize",
|
|
886
|
+
"frameOuterGlowNoise",
|
|
887
|
+
"frameInnerGlow",
|
|
888
|
+
"frameInnerGlowBlendMode",
|
|
889
|
+
"frameInnerGlowColor",
|
|
890
|
+
"frameInnerGlowOpacity",
|
|
891
|
+
"frameInnerGlowChoke",
|
|
892
|
+
"frameInnerGlowSize",
|
|
893
|
+
"frameInnerGlowSource",
|
|
894
|
+
"frameInnerGlowNoise",
|
|
895
|
+
"frameBevel",
|
|
896
|
+
"frameBevelStyle",
|
|
897
|
+
"frameBevelTechnique",
|
|
898
|
+
"frameBevelDepth",
|
|
899
|
+
"frameBevelDirection",
|
|
900
|
+
"frameBevelSize",
|
|
901
|
+
"frameBevelSoften",
|
|
902
|
+
"frameBevelAngle",
|
|
903
|
+
"frameBevelAltitude",
|
|
904
|
+
"frameBevelHighlightColor",
|
|
905
|
+
"frameBevelShadowColor",
|
|
906
|
+
"frameBevelHighlightOpacity",
|
|
907
|
+
"frameBevelShadowOpacity",
|
|
908
|
+
"frameSatin",
|
|
909
|
+
"frameSatinBlendMode",
|
|
910
|
+
"frameSatinColor",
|
|
911
|
+
"frameSatinOpacity",
|
|
912
|
+
"frameSatinAngle",
|
|
913
|
+
"frameSatinDistance",
|
|
914
|
+
"frameSatinSize",
|
|
915
|
+
"frameSatinInvert",
|
|
916
|
+
"frameFeather",
|
|
917
|
+
"frameFeatherWidth",
|
|
918
|
+
"frameFeatherCornerType",
|
|
919
|
+
"frameFeatherNoise",
|
|
920
|
+
"frameFeatherChoke",
|
|
921
|
+
"frameDirectionalFeather",
|
|
922
|
+
"frameDirectionalFeatherLeftWidth",
|
|
923
|
+
"frameDirectionalFeatherRightWidth",
|
|
924
|
+
"frameDirectionalFeatherTopWidth",
|
|
925
|
+
"frameDirectionalFeatherBottomWidth",
|
|
926
|
+
"frameDirectionalFeatherAngle",
|
|
927
|
+
"frameDirectionalFeatherNoise",
|
|
928
|
+
"frameDirectionalFeatherChoke",
|
|
929
|
+
"frameBlendMode",
|
|
930
|
+
"cellFillColor",
|
|
931
|
+
"cellFillTint",
|
|
932
|
+
"cellInsetTop",
|
|
933
|
+
"cellInsetLeft",
|
|
934
|
+
"cellInsetBottom",
|
|
935
|
+
"cellInsetRight",
|
|
936
|
+
"cellVerticalJustification",
|
|
937
|
+
"cellTopEdgeStrokeColor",
|
|
938
|
+
"cellTopEdgeStrokeWeight",
|
|
939
|
+
"cellTopEdgeStrokeTint",
|
|
940
|
+
"cellBottomEdgeStrokeColor",
|
|
941
|
+
"cellBottomEdgeStrokeWeight",
|
|
942
|
+
"cellBottomEdgeStrokeTint",
|
|
943
|
+
"cellLeftEdgeStrokeColor",
|
|
944
|
+
"cellLeftEdgeStrokeWeight",
|
|
945
|
+
"cellLeftEdgeStrokeTint",
|
|
946
|
+
"cellRightEdgeStrokeColor",
|
|
947
|
+
"cellRightEdgeStrokeWeight",
|
|
948
|
+
"cellRightEdgeStrokeTint",
|
|
949
|
+
"tableRowCount",
|
|
950
|
+
"tableColumnCount",
|
|
951
|
+
"pluginMetadata",
|
|
952
|
+
"anchoredPosition",
|
|
953
|
+
"anchorPoint",
|
|
954
|
+
"anchoredXOffset",
|
|
955
|
+
"anchoredYOffset",
|
|
956
|
+
"anchoredHorizontalReference",
|
|
957
|
+
"anchoredVerticalReference",
|
|
958
|
+
"anchoredHorizontalAlignment",
|
|
959
|
+
"anchoredVerticalAlignment",
|
|
960
|
+
"anchoredSpineRelative",
|
|
961
|
+
"anchoredLockPosition",
|
|
962
|
+
"elementVisible",
|
|
963
|
+
"elementLocked"
|
|
964
|
+
],
|
|
965
|
+
"constraints": [
|
|
966
|
+
"Scripts run in Boa (pure ECMAScript), NOT Node: no require/import, fetch, fs, setTimeout, or network. Use only paged.* and console.*.",
|
|
967
|
+
"Reads return JSON STRINGS, not live values: JSON.parse(paged.selection()/tree()/stories()/pages()/…) before you index. Parsed elements are { kind, id } objects — address one as the string `${kind}:${id}` (e.g. textFrame:u3) for paged.set / inspect / get.",
|
|
968
|
+
"Property writes (paged.set) return a boolean: true = applied, false = rejected (unknown id/path, bad value, or a failed precondition). The structural insert fns are the exception — see below. Always check the result and adapt.",
|
|
969
|
+
"Writes go through the editor's Operation channel, so paged.undo()/paged.redo() work exactly as in the UI.",
|
|
970
|
+
"Runtime budgets: ~10M loop iterations, recursion depth 512, and a ~2s wall-clock checked at every host call. Runaway scripts are aborted (non-catchable).",
|
|
971
|
+
"insertFrame/insertTextFrame return the new element's kind:id address (and auto-select it); insertPage returns the new page's selfId. Pass the returned id straight to paged.set / placeImage / insertText (use paged.pages() for a page id, paged.stories() for the minted story).",
|
|
972
|
+
"Bounds are page-local points in [top, left, bottom, right] order. The document works in points (1/72 inch)."
|
|
973
|
+
],
|
|
974
|
+
"elements": [
|
|
975
|
+
{
|
|
976
|
+
"name": "TextFrame",
|
|
977
|
+
"chapter": "frames-paths",
|
|
978
|
+
"summary": "A frame that pours a story. Geometry + fill/stroke like any page item, plus text-frame preferences (columns, inset, vertical justification).",
|
|
979
|
+
"attributes": [
|
|
980
|
+
{
|
|
981
|
+
"name": "Self",
|
|
982
|
+
"typeHint": "id",
|
|
983
|
+
"settablePath": null,
|
|
984
|
+
"summary": "The element's IDML id; how everything references it."
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"name": "ParentStory",
|
|
988
|
+
"typeHint": "story ref",
|
|
989
|
+
"settablePath": null,
|
|
990
|
+
"summary": "The story this frame pours; the threading link, not a settable property."
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "GeometricBounds",
|
|
994
|
+
"typeHint": "[t,l,b,r] points",
|
|
995
|
+
"settablePath": "frameBounds",
|
|
996
|
+
"summary": "Page-local bounds in points."
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"name": "ItemTransform",
|
|
1000
|
+
"typeHint": "affine [a,b,c,d,e,f]",
|
|
1001
|
+
"settablePath": "frameTransform",
|
|
1002
|
+
"summary": "The frame's affine placement transform."
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"name": "FillColor",
|
|
1006
|
+
"typeHint": "swatch ref",
|
|
1007
|
+
"settablePath": "frameFillColor",
|
|
1008
|
+
"summary": "Fill swatch (e.g. Color/Red)."
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"name": "StrokeColor",
|
|
1012
|
+
"typeHint": "swatch ref",
|
|
1013
|
+
"settablePath": "frameStrokeColor",
|
|
1014
|
+
"summary": "Stroke swatch."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "StrokeWeight",
|
|
1018
|
+
"typeHint": "points",
|
|
1019
|
+
"settablePath": "frameStrokeWeight",
|
|
1020
|
+
"summary": "Stroke weight in points."
|
|
1021
|
+
}
|
|
1022
|
+
]
|
|
1023
|
+
},
|
|
1024
|
+
{
|
|
1025
|
+
"name": "Rectangle",
|
|
1026
|
+
"chapter": "frames-paths",
|
|
1027
|
+
"summary": "A rectangular graphic frame — a vector shape that can also hold a placed image.",
|
|
1028
|
+
"attributes": [
|
|
1029
|
+
{
|
|
1030
|
+
"name": "Self",
|
|
1031
|
+
"typeHint": "id",
|
|
1032
|
+
"settablePath": null,
|
|
1033
|
+
"summary": "Element id."
|
|
1034
|
+
},
|
|
1035
|
+
{
|
|
1036
|
+
"name": "GeometricBounds",
|
|
1037
|
+
"typeHint": "[t,l,b,r] points",
|
|
1038
|
+
"settablePath": "frameBounds",
|
|
1039
|
+
"summary": "Page-local bounds in points."
|
|
1040
|
+
},
|
|
1041
|
+
{
|
|
1042
|
+
"name": "ItemTransform",
|
|
1043
|
+
"typeHint": "affine",
|
|
1044
|
+
"settablePath": "frameTransform",
|
|
1045
|
+
"summary": "Affine placement transform."
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "FillColor",
|
|
1049
|
+
"typeHint": "swatch ref",
|
|
1050
|
+
"settablePath": "frameFillColor",
|
|
1051
|
+
"summary": "Fill swatch."
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"name": "FillTint",
|
|
1055
|
+
"typeHint": "0–100",
|
|
1056
|
+
"settablePath": "frameFillTint",
|
|
1057
|
+
"summary": "Fill tint percentage."
|
|
1058
|
+
},
|
|
1059
|
+
{
|
|
1060
|
+
"name": "StrokeColor",
|
|
1061
|
+
"typeHint": "swatch ref",
|
|
1062
|
+
"settablePath": "frameStrokeColor",
|
|
1063
|
+
"summary": "Stroke swatch."
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"name": "StrokeWeight",
|
|
1067
|
+
"typeHint": "points",
|
|
1068
|
+
"settablePath": "frameStrokeWeight",
|
|
1069
|
+
"summary": "Stroke weight."
|
|
1070
|
+
}
|
|
1071
|
+
]
|
|
1072
|
+
},
|
|
1073
|
+
{
|
|
1074
|
+
"name": "Oval",
|
|
1075
|
+
"chapter": "frames-paths",
|
|
1076
|
+
"summary": "An elliptical graphic frame.",
|
|
1077
|
+
"attributes": [
|
|
1078
|
+
{
|
|
1079
|
+
"name": "GeometricBounds",
|
|
1080
|
+
"typeHint": "[t,l,b,r] points",
|
|
1081
|
+
"settablePath": "frameBounds",
|
|
1082
|
+
"summary": "Bounding box of the ellipse."
|
|
1083
|
+
},
|
|
1084
|
+
{
|
|
1085
|
+
"name": "ItemTransform",
|
|
1086
|
+
"typeHint": "affine",
|
|
1087
|
+
"settablePath": "frameTransform",
|
|
1088
|
+
"summary": "Affine placement transform."
|
|
1089
|
+
},
|
|
1090
|
+
{
|
|
1091
|
+
"name": "FillColor",
|
|
1092
|
+
"typeHint": "swatch ref",
|
|
1093
|
+
"settablePath": "frameFillColor",
|
|
1094
|
+
"summary": "Fill swatch."
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
"name": "StrokeColor",
|
|
1098
|
+
"typeHint": "swatch ref",
|
|
1099
|
+
"settablePath": "frameStrokeColor",
|
|
1100
|
+
"summary": "Stroke swatch."
|
|
1101
|
+
}
|
|
1102
|
+
]
|
|
1103
|
+
},
|
|
1104
|
+
{
|
|
1105
|
+
"name": "Polygon",
|
|
1106
|
+
"chapter": "frames-paths",
|
|
1107
|
+
"summary": "An arbitrary closed vector shape; may carry multiple GeometryPathType contours (compound paths).",
|
|
1108
|
+
"attributes": [
|
|
1109
|
+
{
|
|
1110
|
+
"name": "GeometricBounds",
|
|
1111
|
+
"typeHint": "[t,l,b,r] points",
|
|
1112
|
+
"settablePath": "frameBounds",
|
|
1113
|
+
"summary": "Bounding box."
|
|
1114
|
+
},
|
|
1115
|
+
{
|
|
1116
|
+
"name": "ItemTransform",
|
|
1117
|
+
"typeHint": "affine",
|
|
1118
|
+
"settablePath": "frameTransform",
|
|
1119
|
+
"summary": "Affine placement transform."
|
|
1120
|
+
},
|
|
1121
|
+
{
|
|
1122
|
+
"name": "FillColor",
|
|
1123
|
+
"typeHint": "swatch ref",
|
|
1124
|
+
"settablePath": "frameFillColor",
|
|
1125
|
+
"summary": "Fill swatch."
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"name": "StrokeColor",
|
|
1129
|
+
"typeHint": "swatch ref",
|
|
1130
|
+
"settablePath": "frameStrokeColor",
|
|
1131
|
+
"summary": "Stroke swatch."
|
|
1132
|
+
}
|
|
1133
|
+
]
|
|
1134
|
+
},
|
|
1135
|
+
{
|
|
1136
|
+
"name": "GraphicLine",
|
|
1137
|
+
"chapter": "frames-paths",
|
|
1138
|
+
"summary": "A straight or curved open path.",
|
|
1139
|
+
"attributes": [
|
|
1140
|
+
{
|
|
1141
|
+
"name": "GeometricBounds",
|
|
1142
|
+
"typeHint": "[t,l,b,r] points",
|
|
1143
|
+
"settablePath": "frameBounds",
|
|
1144
|
+
"summary": "Bounding box of the line."
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
"name": "ItemTransform",
|
|
1148
|
+
"typeHint": "affine",
|
|
1149
|
+
"settablePath": "frameTransform",
|
|
1150
|
+
"summary": "Affine placement transform."
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
"name": "StrokeColor",
|
|
1154
|
+
"typeHint": "swatch ref",
|
|
1155
|
+
"settablePath": "frameStrokeColor",
|
|
1156
|
+
"summary": "Stroke swatch."
|
|
1157
|
+
},
|
|
1158
|
+
{
|
|
1159
|
+
"name": "StrokeWeight",
|
|
1160
|
+
"typeHint": "points",
|
|
1161
|
+
"settablePath": "frameStrokeWeight",
|
|
1162
|
+
"summary": "Stroke weight."
|
|
1163
|
+
}
|
|
1164
|
+
]
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
"name": "Group",
|
|
1168
|
+
"chapter": "frames-paths",
|
|
1169
|
+
"summary": "A grouping container that transforms its children as a unit.",
|
|
1170
|
+
"attributes": [
|
|
1171
|
+
{
|
|
1172
|
+
"name": "Self",
|
|
1173
|
+
"typeHint": "id",
|
|
1174
|
+
"settablePath": null,
|
|
1175
|
+
"summary": "Element id."
|
|
1176
|
+
},
|
|
1177
|
+
{
|
|
1178
|
+
"name": "ItemTransform",
|
|
1179
|
+
"typeHint": "affine",
|
|
1180
|
+
"settablePath": "frameTransform",
|
|
1181
|
+
"summary": "The group's affine transform, applied to all children."
|
|
1182
|
+
}
|
|
1183
|
+
]
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
"name": "Layer",
|
|
1187
|
+
"chapter": "layers",
|
|
1188
|
+
"summary": "A document layer; controls visibility, lock, and print state for the items assigned to it.",
|
|
1189
|
+
"attributes": [
|
|
1190
|
+
{
|
|
1191
|
+
"name": "Name",
|
|
1192
|
+
"typeHint": "string",
|
|
1193
|
+
"settablePath": "layerName",
|
|
1194
|
+
"summary": "Layer name."
|
|
1195
|
+
},
|
|
1196
|
+
{
|
|
1197
|
+
"name": "Visible",
|
|
1198
|
+
"typeHint": "boolean",
|
|
1199
|
+
"settablePath": "layerVisible",
|
|
1200
|
+
"summary": "Whether the layer's items render."
|
|
1201
|
+
},
|
|
1202
|
+
{
|
|
1203
|
+
"name": "Locked",
|
|
1204
|
+
"typeHint": "boolean",
|
|
1205
|
+
"settablePath": "layerLocked",
|
|
1206
|
+
"summary": "Whether the layer's items are editable."
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"name": "Printable",
|
|
1210
|
+
"typeHint": "boolean",
|
|
1211
|
+
"settablePath": "layerPrintable",
|
|
1212
|
+
"summary": "Whether the layer prints/exports."
|
|
1213
|
+
}
|
|
1214
|
+
]
|
|
1215
|
+
},
|
|
1216
|
+
{
|
|
1217
|
+
"name": "Page",
|
|
1218
|
+
"chapter": "layout-model",
|
|
1219
|
+
"summary": "A single page within a spread.",
|
|
1220
|
+
"attributes": [
|
|
1221
|
+
{
|
|
1222
|
+
"name": "Self",
|
|
1223
|
+
"typeHint": "id",
|
|
1224
|
+
"settablePath": null,
|
|
1225
|
+
"summary": "Element id; the target for paged.insertTextFrame / insertFrame."
|
|
1226
|
+
},
|
|
1227
|
+
{
|
|
1228
|
+
"name": "GeometricBounds",
|
|
1229
|
+
"typeHint": "[t,l,b,r] points",
|
|
1230
|
+
"settablePath": null,
|
|
1231
|
+
"summary": "Page bounds in the spread's coordinate space."
|
|
1232
|
+
}
|
|
1233
|
+
]
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"name": "Spread",
|
|
1237
|
+
"chapter": "layout-model",
|
|
1238
|
+
"summary": "A spread: one or more pages laid out together, with its own page-item stacking order.",
|
|
1239
|
+
"attributes": [
|
|
1240
|
+
{
|
|
1241
|
+
"name": "Self",
|
|
1242
|
+
"typeHint": "id",
|
|
1243
|
+
"settablePath": null,
|
|
1244
|
+
"summary": "Element id."
|
|
1245
|
+
},
|
|
1246
|
+
{
|
|
1247
|
+
"name": "ItemTransform",
|
|
1248
|
+
"typeHint": "affine",
|
|
1249
|
+
"settablePath": null,
|
|
1250
|
+
"summary": "The spread's transform in pasteboard space."
|
|
1251
|
+
}
|
|
1252
|
+
]
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
"name": "Story",
|
|
1256
|
+
"chapter": "stories-text",
|
|
1257
|
+
"summary": "A flow of text, independent of the frame(s) that pour it. Edited by character offset, not by frame.",
|
|
1258
|
+
"attributes": [
|
|
1259
|
+
{
|
|
1260
|
+
"name": "Self",
|
|
1261
|
+
"typeHint": "id",
|
|
1262
|
+
"settablePath": null,
|
|
1263
|
+
"summary": "Story id; the target for paged.insertText / deleteRange / applyStyle."
|
|
1264
|
+
}
|
|
1265
|
+
]
|
|
1266
|
+
},
|
|
1267
|
+
{
|
|
1268
|
+
"name": "ParagraphStyleRange",
|
|
1269
|
+
"chapter": "styles",
|
|
1270
|
+
"summary": "A run of paragraphs sharing a paragraph style and overrides, inside a story.",
|
|
1271
|
+
"attributes": [
|
|
1272
|
+
{
|
|
1273
|
+
"name": "AppliedParagraphStyle",
|
|
1274
|
+
"typeHint": "style ref",
|
|
1275
|
+
"settablePath": "appliedParagraphStyle",
|
|
1276
|
+
"summary": "The paragraph style applied to the range."
|
|
1277
|
+
},
|
|
1278
|
+
{
|
|
1279
|
+
"name": "Justification",
|
|
1280
|
+
"typeHint": "enum",
|
|
1281
|
+
"settablePath": "paragraphJustification",
|
|
1282
|
+
"summary": "Paragraph alignment/justification."
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"name": "SpaceBefore",
|
|
1286
|
+
"typeHint": "points",
|
|
1287
|
+
"settablePath": "paragraphSpaceBefore",
|
|
1288
|
+
"summary": "Space above the paragraph."
|
|
1289
|
+
},
|
|
1290
|
+
{
|
|
1291
|
+
"name": "SpaceAfter",
|
|
1292
|
+
"typeHint": "points",
|
|
1293
|
+
"settablePath": "paragraphSpaceAfter",
|
|
1294
|
+
"summary": "Space below the paragraph."
|
|
1295
|
+
}
|
|
1296
|
+
]
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
"name": "CharacterStyleRange",
|
|
1300
|
+
"chapter": "styles",
|
|
1301
|
+
"summary": "A run of characters sharing a character style and overrides, inside a paragraph.",
|
|
1302
|
+
"attributes": [
|
|
1303
|
+
{
|
|
1304
|
+
"name": "AppliedCharacterStyle",
|
|
1305
|
+
"typeHint": "style ref",
|
|
1306
|
+
"settablePath": "appliedCharacterStyle",
|
|
1307
|
+
"summary": "The character style applied to the range."
|
|
1308
|
+
},
|
|
1309
|
+
{
|
|
1310
|
+
"name": "PointSize",
|
|
1311
|
+
"typeHint": "points",
|
|
1312
|
+
"settablePath": "characterFontSize",
|
|
1313
|
+
"summary": "Font size in points."
|
|
1314
|
+
},
|
|
1315
|
+
{
|
|
1316
|
+
"name": "Leading",
|
|
1317
|
+
"typeHint": "points | Auto",
|
|
1318
|
+
"settablePath": "characterLeading",
|
|
1319
|
+
"summary": "Line leading."
|
|
1320
|
+
},
|
|
1321
|
+
{
|
|
1322
|
+
"name": "Tracking",
|
|
1323
|
+
"typeHint": "1/1000 em",
|
|
1324
|
+
"settablePath": "characterTracking",
|
|
1325
|
+
"summary": "Letter tracking."
|
|
1326
|
+
},
|
|
1327
|
+
{
|
|
1328
|
+
"name": "FillColor",
|
|
1329
|
+
"typeHint": "swatch ref",
|
|
1330
|
+
"settablePath": "characterFillColor",
|
|
1331
|
+
"summary": "Text fill swatch."
|
|
1332
|
+
}
|
|
1333
|
+
]
|
|
1334
|
+
}
|
|
1335
|
+
]
|
|
1336
|
+
}
|