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/[email protected]— A character range within a story (half-open). storyId comes from paged.stories()[].selfId.
Settable property paths
179 of 179 settable paths — the second argument to paged.set(id, path, value).
frameBoundsframeFillColorframeStrokeColorframeStrokeWeightframeOpacityframeTransformimageContentTransformframePathPointpathPointInsertpathPointRemovepathPointCurveTypelayerVisiblelayerLockedlayerPrintablelayerNamecharacterFontSizecharacterLeadingcharacterTrackingcharacterFillColorparagraphSpaceBeforeparagraphSpaceAfterparagraphFirstLineIndentappliedParagraphStyleappliedCharacterStyleappliedObjectStyleappliedCellStyleappliedTableStyleappliedConditionsframeInsetSpacingparagraphJustificationparagraphStyleNextStyleparagraphAppliedNumberingListframeStrokeEndCapframeStrokeStartArrowheadframeStrokeEndArrowheadframeTextWrapModeframeTextWrapOffsetsframeTextWrapContourTypeframeTextWrapContourIncludeInsideframeFittingCropsframeFittingTypeframeDropShadowframeDropShadowModeframeDropShadowXOffsetframeDropShadowYOffsetframeDropShadowSizeframeDropShadowOpacityframeDropShadowColorframePathframeFillTintframeNonprintingframeGradientFillAngleframeGradientFillLengthframeGradientStrokeAngleframeGradientStrokeLengthtextFrameColumnCounttextFrameColumnGuttertextFrameColumnBalancetextFrameVerticalJustificationtextFrameAutoSizingtextFrameFirstBaselineframeTextWrapInvertframeFittingReferencePointframeAutoFitframeStrokeTypeframeStrokeJoinframeStrokeMiterLimitframeStrokeAlignmentframeStrokeGapColorframeStrokeGapTintframeStrokeDashArrayframeCornerOptionTopLeftframeCornerOptionTopRightframeCornerOptionBottomLeftframeCornerOptionBottomRightframeCornerRadiusTopLeftframeCornerRadiusTopRightframeCornerRadiusBottomLeftframeCornerRadiusBottomRightframeRotationAngleframeScaleXframeScaleYframeFlipHframeFlipVframeOverprintFillframeOverprintStrokeframeInnerShadowframeInnerShadowBlendModeframeInnerShadowColorframeInnerShadowOpacityframeInnerShadowAngleframeInnerShadowDistanceframeInnerShadowSizeframeInnerShadowChokeframeInnerShadowNoiseframeOuterGlowframeOuterGlowBlendModeframeOuterGlowColorframeOuterGlowOpacityframeOuterGlowSpreadframeOuterGlowSizeframeOuterGlowNoiseframeInnerGlowframeInnerGlowBlendModeframeInnerGlowColorframeInnerGlowOpacityframeInnerGlowChokeframeInnerGlowSizeframeInnerGlowSourceframeInnerGlowNoiseframeBevelframeBevelStyleframeBevelTechniqueframeBevelDepthframeBevelDirectionframeBevelSizeframeBevelSoftenframeBevelAngleframeBevelAltitudeframeBevelHighlightColorframeBevelShadowColorframeBevelHighlightOpacityframeBevelShadowOpacityframeSatinframeSatinBlendModeframeSatinColorframeSatinOpacityframeSatinAngleframeSatinDistanceframeSatinSizeframeSatinInvertframeFeatherframeFeatherWidthframeFeatherCornerTypeframeFeatherNoiseframeFeatherChokeframeDirectionalFeatherframeDirectionalFeatherLeftWidthframeDirectionalFeatherRightWidthframeDirectionalFeatherTopWidthframeDirectionalFeatherBottomWidthframeDirectionalFeatherAngleframeDirectionalFeatherNoiseframeDirectionalFeatherChokeframeBlendModecellFillColorcellFillTintcellInsetTopcellInsetLeftcellInsetBottomcellInsetRightcellVerticalJustificationcellTopEdgeStrokeColorcellTopEdgeStrokeWeightcellTopEdgeStrokeTintcellBottomEdgeStrokeColorcellBottomEdgeStrokeWeightcellBottomEdgeStrokeTintcellLeftEdgeStrokeColorcellLeftEdgeStrokeWeightcellLeftEdgeStrokeTintcellRightEdgeStrokeColorcellRightEdgeStrokeWeightcellRightEdgeStrokeTinttableRowCounttableColumnCountpluginMetadataanchoredPositionanchorPointanchoredXOffsetanchoredYOffsetanchoredHorizontalReferenceanchoredVerticalReferenceanchoredHorizontalAlignmentanchoredVerticalAlignmentanchoredSpineRelativeanchoredLockPositionelementVisibleelementLockedHost functions
Every paged.* host function available to scripts, grouped by kind — generated directly from the engine's scripting catalog.
Sandbox & budgets
The execution model for paged.* scripts — a pure ECMAScript sandbox with no I/O, plus the runtime budgets that keep scripts safe — generated from the engine catalog.