Skip to content

API reference / Common / Engine types / ShapePlaceholder

Interface: ShapePlaceholder ​

Properties ​

PropertyDescription
kind
ShapePlaceholderType
@type — which kind of placeholder this fills (ST_PlaceholderType).
index
number | null
@idx — disambiguates two placeholders of the same kind on one layout (e.g. two body placeholders). Absent is the implicit 0.
size
ShapePlaceholderSize
@sz — the placeholder's relative size hint (ST_PlaceholderSize).
orientation
ShapePlaceholderOrientation
@orient — text flow orientation (ST_Direction).
hasCustomPrompt
boolean
@hasCustomPrompt — whether this placeholder's own p:txBody holds a custom prompt (author-supplied sample text) rather than relying on the application's default. The format stores no prompt string: when this is false (the default) and the placeholder is empty, the app supplies the default prompt for its kind; when true, the placeholder's regular text body is the prompt and renders as-is.