Scripting (paged.*)
Settable paths & id grammar
The property paths accepted by paged.set, and the id grammar for addressing elements — generated from the engine's scripting catalog.
ProIIIreference
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:.group:<id>e.g.group:u88— A group. `paged.set("group:<id>", "groupTransform", [a,b,c,d,tx,ty])` moves it as a unit.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.
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.
175 of 175 settable paths — the second argument to paged.set(id, path, value), grouped by theme.
Anchored objects & text wrap demo ▸
frameTextWrapModeframeTextWrapOffsetsframeTextWrapContourTypeframeTextWrapContourIncludeInsideframeTextWrapInvertanchoredPositionanchorPointanchoredXOffsetanchoredYOffsetanchoredHorizontalReferenceanchoredVerticalReferenceanchoredHorizontalAlignmentanchoredVerticalAlignmentanchoredSpineRelativeanchoredLockPositionTables & cells demo ▸
appliedCellStyleappliedTableStylecellFillColorcellFillTintcellInsetTopcellInsetLeftcellInsetBottomcellInsetRightcellVerticalJustificationcellTopEdgeStrokeColorcellTopEdgeStrokeWeightcellTopEdgeStrokeTintcellBottomEdgeStrokeColorcellBottomEdgeStrokeWeightcellBottomEdgeStrokeTintcellLeftEdgeStrokeColorcellLeftEdgeStrokeWeightcellLeftEdgeStrokeTintcellRightEdgeStrokeColorcellRightEdgeStrokeWeightcellRightEdgeStrokeTinttableRowCounttableColumnCountText & paragraph demo ▸
characterFontSizepointsFont size in points.characterLeadingpoints | AutoLine leading.characterTracking1/1000 emLetter tracking.characterFillColorswatch refText fill swatch.paragraphSpaceBeforepointsSpace above the paragraph.paragraphSpaceAfterpointsSpace below the paragraph.paragraphFirstLineIndentappliedParagraphStylestyle refThe paragraph style applied to the range.appliedCharacterStylestyle refThe character style applied to the range.frameInsetSpacingparagraphJustificationenumParagraph alignment/justification.paragraphStyleNextStyleparagraphAppliedNumberingListtextFrameColumnCounttextFrameColumnGuttertextFrameColumnBalancetextFrameVerticalJustificationtextFrameAutoSizingtextFrameFirstBaselineEffects demo ▸
frameDropShadowframeDropShadowModeframeDropShadowXOffsetframeDropShadowYOffsetframeDropShadowSizeframeDropShadowOpacityframeDropShadowColorframeInnerShadowframeInnerShadowBlendModeframeInnerShadowColorframeInnerShadowOpacityframeInnerShadowAngleframeInnerShadowDistanceframeInnerShadowSizeframeInnerShadowChokeframeInnerShadowNoiseframeOuterGlowframeOuterGlowBlendModeframeOuterGlowColorframeOuterGlowOpacityframeOuterGlowSpreadframeOuterGlowSizeframeOuterGlowNoiseframeInnerGlowframeInnerGlowBlendModeframeInnerGlowColorframeInnerGlowOpacityframeInnerGlowChokeframeInnerGlowSizeframeInnerGlowSourceframeInnerGlowNoiseframeBevelframeBevelStyleframeBevelTechniqueframeBevelDepthframeBevelDirectionframeBevelSizeframeBevelSoftenframeBevelAngleframeBevelAltitudeframeBevelHighlightColorframeBevelShadowColorframeBevelHighlightOpacityframeBevelShadowOpacityframeSatinframeSatinBlendModeframeSatinColorframeSatinOpacityframeSatinAngleframeSatinDistanceframeSatinSizeframeSatinInvertframeFeatherframeFeatherWidthframeFeatherCornerTypeframeFeatherNoiseframeFeatherChokeframeDirectionalFeatherframeDirectionalFeatherLeftWidthframeDirectionalFeatherRightWidthframeDirectionalFeatherTopWidthframeDirectionalFeatherBottomWidthframeDirectionalFeatherAngleframeDirectionalFeatherNoiseframeDirectionalFeatherChokeCorners & fitting demo ▸
frameFittingCropsframeFittingTypeframeFittingReferencePointframeAutoFitframeCornerOptionTopLeftframeCornerOptionTopRightframeCornerOptionBottomLeftframeCornerOptionBottomRightframeCornerRadiusTopLeftframeCornerRadiusTopRightframeCornerRadiusBottomLeftframeCornerRadiusBottomRightStrokes & dashes demo ▸
frameStrokeColorswatch refStroke swatch.frameStrokeWeightpointsStroke weight in points.frameStrokeEndCapframeStrokeStartArrowheadframeStrokeEndArrowheadframeGradientStrokeAngleframeGradientStrokeLengthframeStrokeTypeframeStrokeJoinframeStrokeMiterLimitframeStrokeAlignmentframeStrokeGapColorframeStrokeGapTintframeStrokeDashArrayframeOverprintStrokeFills & gradients demo ▸
frameFillColorswatch refFill swatch (e.g. Color/Red).frameFillTint0–100Fill tint percentage.frameGradientFillAngleframeGradientFillLengthframeOverprintFillTransform & geometry demo ▸
frameBounds[t,l,b,r] pointsPage-local bounds in points.frameTransformaffine [a,b,c,d,e,f]The frame's affine placement transform.imageContentTransformframePathPointpathPointInsertpathPointRemovepathPointCurveTypeframePathframeRotationAngleframeScaleXframeScaleYframeFlipHframeFlipVBlend & opacity demo ▸
frameOpacityframeNonprintingframeBlendModeStyles, layers & visibility demo ▸
appliedObjectStyleappliedConditionspluginMetadataelementVisibleelementLockedHost functions
Every paged.* host function available to scripts, grouped by kind — generated directly from the engine's scripting catalog.
Path showcases
The 175 settable paths, grouped into ten themed playgrounds — fills, strokes, transforms, effects, corners, text, tables, anchoring, blend, and styles — each a runnable demo against a starter document.