Learning in public — this reference is being written in the open. Unfinished pages are excluded from search engines.
paged.IDML Reference
Scripting (paged.*)

Path showcases

The 179 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.

Tier: IntermediateIntermediateIIhow-to

In short paged.set(id, path, value) accepts 179 settable paths. They are grouped below into ten themes; each theme is a runnable playground that writes a few of its paths so you can see them take effect. The full, filterable list lives in Settable paths.

Every showcase starts from a seeded document with a frame already selected, so the script can read the selection (JSON.parse(paged.selection())) and address it as `${kind}:${id}`. Edit any snippet and press Run.

Fills & gradients #

Solid fills, tints, gradient fills, and overprint. · 5 paths

frameFillColorframeFillTintframeGradientFillAngleframeGradientFillLengthframeOverprintFill
Open ↗paged.* · seed: one-text-frame-selected
Loading editor…
Look for: The frame fills with a 60% tint of red.
Console
Run a script to see console output here.

Strokes & dashes #

Stroke colour, weight, type, joins, caps, arrowheads, and gradient strokes. · 15 paths

frameStrokeColorframeStrokeWeightframeStrokeEndCapframeStrokeStartArrowheadframeStrokeEndArrowheadframeGradientStrokeAngleframeGradientStrokeLengthframeStrokeTypeframeStrokeJoinframeStrokeMiterLimitframeStrokeAlignmentframeStrokeGapColorframeStrokeGapTintframeStrokeDashArrayframeOverprintStroke
Open ↗paged.* · seed: one-text-frame-selected
Loading editor…
Look for: The frame gains a thick dashed black border.
Console
Run a script to see console output here.

Transform & geometry #

Bounds, rotation, scale, flips, the vector path, and image content placement. · 13 paths

frameBoundsframeTransformimageContentTransformframePathPointpathPointInsertpathPointRemovepathPointCurveTypeframePathframeRotationAngleframeScaleXframeScaleYframeFlipHframeFlipV
Open ↗paged.* · seed: one-text-frame-selected
Loading editor…
Look for: The frame rotates 15° and scales up slightly.
Console
Run a script to see console output here.

Corners & fitting #

Rounded/fancy corner options and image-fitting behaviour. · 12 paths

frameFittingCropsframeFittingTypeframeFittingReferencePointframeAutoFitframeCornerOptionTopLeftframeCornerOptionTopRightframeCornerOptionBottomLeftframeCornerOptionBottomRightframeCornerRadiusTopLeftframeCornerRadiusTopRightframeCornerRadiusBottomLeftframeCornerRadiusBottomRight
Open ↗paged.* · seed: one-text-frame-selected
Loading editor…
Look for: The frame’s top-left corner becomes rounded.
Console
Run a script to see console output here.

Effects #

Drop shadow, inner shadow, glows, bevel, satin, and feathering. · 65 paths

frameDropShadowframeDropShadowModeframeDropShadowXOffsetframeDropShadowYOffsetframeDropShadowSizeframeDropShadowOpacityframeDropShadowColorframeInnerShadowframeInnerShadowBlendModeframeInnerShadowColorframeInnerShadowOpacityframeInnerShadowAngleframeInnerShadowDistanceframeInnerShadowSizeframeInnerShadowChokeframeInnerShadowNoiseframeOuterGlowframeOuterGlowBlendModeframeOuterGlowColorframeOuterGlowOpacityframeOuterGlowSpreadframeOuterGlowSizeframeOuterGlowNoiseframeInnerGlowframeInnerGlowBlendModeframeInnerGlowColorframeInnerGlowOpacityframeInnerGlowChokeframeInnerGlowSizeframeInnerGlowSourceframeInnerGlowNoiseframeBevelframeBevelStyleframeBevelTechniqueframeBevelDepthframeBevelDirectionframeBevelSizeframeBevelSoftenframeBevelAngleframeBevelAltitudeframeBevelHighlightColorframeBevelShadowColorframeBevelHighlightOpacityframeBevelShadowOpacityframeSatinframeSatinBlendModeframeSatinColorframeSatinOpacityframeSatinAngleframeSatinDistanceframeSatinSizeframeSatinInvertframeFeatherframeFeatherWidthframeFeatherCornerTypeframeFeatherNoiseframeFeatherChokeframeDirectionalFeatherframeDirectionalFeatherLeftWidthframeDirectionalFeatherRightWidthframeDirectionalFeatherTopWidthframeDirectionalFeatherBottomWidthframeDirectionalFeatherAngleframeDirectionalFeatherNoiseframeDirectionalFeatherChoke
Open ↗paged.* · seed: one-text-frame-selected
Loading editor…
Look for: A soft drop shadow appears behind the frame.
Console
Run a script to see console output here.

Blend & opacity #

Frame opacity, blend mode, and non-printing. · 3 paths

frameOpacityframeNonprintingframeBlendMode
Open ↗paged.* · seed: one-text-frame-selected
Loading editor…
Look for: The frame becomes semi-transparent with a Multiply blend.
Console
Run a script to see console output here.

Text & paragraph #

Character size/leading/tracking/colour, paragraph spacing/justification, and text-frame columns. · 19 paths

characterFontSizecharacterLeadingcharacterTrackingcharacterFillColorparagraphSpaceBeforeparagraphSpaceAfterparagraphFirstLineIndentappliedParagraphStyleappliedCharacterStyleframeInsetSpacingparagraphJustificationparagraphStyleNextStyleparagraphAppliedNumberingListtextFrameColumnCounttextFrameColumnGuttertextFrameColumnBalancetextFrameVerticalJustificationtextFrameAutoSizingtextFrameFirstBaseline
Open ↗paged.* · seed: styled-story
Loading editor…
Look for: The story’s type grows and gains space after each paragraph.
Console
Run a script to see console output here.

Tables & cells #

Cell fills, insets, edge strokes, and table row/column structure. · 23 paths

appliedCellStyleappliedTableStylecellFillColorcellFillTintcellInsetTopcellInsetLeftcellInsetBottomcellInsetRightcellVerticalJustificationcellTopEdgeStrokeColorcellTopEdgeStrokeWeightcellTopEdgeStrokeTintcellBottomEdgeStrokeColorcellBottomEdgeStrokeWeightcellBottomEdgeStrokeTintcellLeftEdgeStrokeColorcellLeftEdgeStrokeWeightcellLeftEdgeStrokeTintcellRightEdgeStrokeColorcellRightEdgeStrokeWeightcellRightEdgeStrokeTinttableRowCounttableColumnCount
Open ↗paged.* · seed: a-table
Loading editor…
Look for: The console reports the table’s row and column counts.
Console
Run a script to see console output here.

Anchored objects & text wrap #

How a frame anchors into text and how surrounding text flows around it. · 15 paths

frameTextWrapModeframeTextWrapOffsetsframeTextWrapContourTypeframeTextWrapContourIncludeInsideframeTextWrapInvertanchoredPositionanchorPointanchoredXOffsetanchoredYOffsetanchoredHorizontalReferenceanchoredVerticalReferenceanchoredHorizontalAlignmentanchoredVerticalAlignmentanchoredSpineRelativeanchoredLockPosition
Open ↗paged.* · seed: one-text-frame-selected
Loading editor…
Look for: The frame gains a text-wrap boundary with an offset on all sides.
Console
Run a script to see console output here.

Styles, layers & visibility #

Applied object styles, conditions, layer attributes, lock/visibility, and plugin metadata. · 9 paths

layerVisiblelayerLockedlayerPrintablelayerNameappliedObjectStyleappliedConditionspluginMetadataelementVisibleelementLocked
Open ↗paged.* · seed: one-text-frame-selected
Loading editor…
Look for: The frame is hidden, then shown again.
Console
Run a script to see console output here.