Skip to content

ImpositionSpecState ​

Type: Object

An imposition specification for a component — describes how pages are arranged on a press sheet

Fields ​

NameTypeArgsDescriptionDeprecated
bindingTypeBindingTypeHow the section is bound. Page order on a folded signature depends on it (saddle-stitch nests, perfect-bound gathers); without it the sheet can only be imposed sequentially.
componentComponentStateParent component. Requires component:read permission.
componentIdComponentID!Parent component ID
createdAtString!Creation timestamp (ISO8601)
descriptionStringDescription of this imposition scenario
gutterHLengthHorizontal gutter between up-positions; each Length carries its own unit.
gutterVLengthVertical gutter between up-positions.
idImpositionSpecID!Unique identifier
isPrimaryBoolean!Whether this is the selected imposition plan for assessment
layoutSheetLayoutFull sheet placement geometry (cells, fold lines, trim marks, surfaces). Computed by the imposing engine, or reconstructed from pagesUp/scheme/orientation for a hand-authored spec. Read layoutStatus before trusting it.
layoutStatusImpositionLayoutStatus!Provenance of layout — and the gate on imposing this spec. ENGINE and SYNTHESIZED are renderable; PROVISIONAL (press sheet inferred, no substrate on the component) and NONE are refused by the impose_pdf workflow node.
nameStringOptional name for this imposition scenario
orientationImpositionOrientationPage orientation for planning
pagesUpIntPages per sheet (up-count)
schemeImpositionSchemeSheet-work scheme
sheetsPerFormIntSheets required per form run
sortOrderInt!Sort order within the component's imposition specs
totalFormsIntTotal number of form runs
totalPagesIntTotal page count
updatedAtString!Last update timestamp (ISO8601)

Relationships ​

Connect machines, automate workflows, and build custom apps for print production.