Settable paths & id grammar

In short How you address an element (the id grammar) and what you can change on it (the settable paths, the second argument to paged.set). Both are generated from the engine catalog and stay in lockstep with the mutation layer.

Addressing elements

• textFrame:<id> e.g. textFrame:u123 — A text frame. Same scheme: rectangle:/oval:/polygon:/graphicLine:/group:.
• rectangle:<id> e.g. rectangle:u12 — A rectangle (graphic frame).
• oval:<id> e.g. oval:u13 — An oval.
• polygon:<id> e.g. polygon:u14 — A polygon or open path.
• graphicLine:<id> e.g. graphicLine:u15 — A graphic line.
• group:<id> e.g. group:u88 — A group. `paged.set("group:<id>", "groupTransform", [a,b,c,d,tx,ty])` moves it as a unit.
• frame:<id> e.g. frame:u123 — Any page item, kind unknown (alias). paged.address / paged.query resolve it to the kind-specific form.
• storyRange:<storyId>@<start>..<end> e.g. storyRange:Story/u1@0..6 — A character range within a story (half-open). storyId comes from paged.stories()[].selfId. Alias: story:<storyId>@<start>..<end>.
• doc e.g. doc — The document itself.
• page:<id> e.g. page:u1a2 — A body page, by its Self id (paged.pages()[].selfId), or page:#<n> for the n-th page (1-based).
• spread:<id> e.g. spread:u1a1 — A spread, by its Self id.
• layer:<id> e.g. layer:ub3 — A layer, by its Self id (paged.layers()).
• master:<id> e.g. master:ua9 — A master spread. `master:<id> > textFrame:<id>` names an item on it.
• story:<id> e.g. story:Story/u1 — A story, by its Self id.
• field:<storyId>@<offset> e.g. field:Story/u1@12 — A text field anchored at a story character offset (paged.placeholders / RequestDocumentPlaceholders).
• table:<id> e.g. table:u2f — A table, by its Self id (unique per document).
• cell:<tableId>/<row>,<col> e.g. cell:u2f/0,1 — A table cell, zero-based row and column.
• style:<family>/<selfId> e.g. style:paragraph/ParagraphStyle/Body — A style; family is paragraph | character | object | cell | table. The display name is accepted in place of the Self id.
• swatch:<id> e.g. swatch:Color/Red — A colour or swatch, by its Self id.
• gradient:<id> e.g. gradient:Gradient/u1 — A gradient, by its Self id.
• colorGroup:<id> e.g. colorGroup:ColorGroup/u7 — A colour group.
• numberingList:<id> e.g. numberingList:NumberingList/Steps — A numbering list.
• guide:<id> e.g. guide:u5c — A ruler guide.
• condition:<id> e.g. condition:Condition/Draft — A text condition.
• conditionSet:<id> e.g. conditionSet:u3d — A condition set.
• section:<id> e.g. section:u4e — A numbering section.
• hyperlink:<id> e.g. hyperlink:u6a — A hyperlink.
• textVariable:<id> e.g. textVariable:dTextVariablenFile Name — A text variable, by its Self id (the designmap's TextVariable). Its name is accepted in a selector: textVariable[name="Running Head"].
• plugin:<pluginId>/<kind>/<id> e.g. plugin:paged.image/layer/7 — An object a plugin owns. Opaque to core and carried through unchanged.
• $h:<name> e.g. $h:newFrame — A batch handle bound earlier in the same batch.

Settable property paths

Grouped by theme, with the IDML type hint and description where a path maps to a known attribute. Each group links to its runnable showcase.