Steps & Workflow

Generated reference for the iPrintessApi methods tagged #ai-api:steps-workflow in printess-editor.d.ts. Custom types referenced below (parameter and return shapes) are documented on the Types reference.

buyerCanHaveEmptySelection

buyerCanHaveEmptySelection(): boolean

Return true if buyer can deselect an item on the current spread. Which means that either there are non-step frames to select or the spread can add new group-snippets/stickers Important to keep buyer in the step-logic

Returns: boolean

displayStepNumbers

displayStepNumbers(display: boolean): Promise<void>

Turns the display of step numbers on or off

Parameter	Type	Description
`display`	`boolean`

Returns: Promise<void>

getStep

getStep(): iBuyerStep | null

Returns the current buyer step, or null if there is no current step.

Returns: iBuyerStep | null

getStepByIndex

getStepByIndex(index: number): iBuyerStep | null

Returns step information

Parameter	Type	Description
`index`	`number`	Index of the step to retrieve

Returns: iBuyerStep | null

gotoFirstStep

gotoFirstStep(zoom?: "frame" | "spread"): Promise<void>

Returns to the first step, helpful if you want to exit the preview step.

Parameter	Type	Description
`zoom?`	`“frame” \| “spread”`	overrides the frames zoom settings for all devices

Returns: Promise<void>

gotoLastStep

gotoLastStep(zoom?: "frame" | "spread", offset?: number): Promise<void>

Returns to the last step, helpful if you want to skip steps.

Parameter	Type	Description
`zoom?`	`“frame” \| “spread”`	overrides the frames zoom settings for all devices
`offset?`	`number`	helps to get to the step before last step (offset = 1), default offset is 0

Returns: Promise<void>

gotoNextPreviewDocument

gotoNextPreviewDocument(zoomDuration?: number): Promise<void>

Jumps to the next available preview document if there is one.

Parameter	Type	Description
`zoomDuration?`	`number`

Returns: Promise<void>

gotoPreviewStep

gotoPreviewStep(previewIndex?: number, zoom?: "frame" | "spread"): Promise<void>

Goes directly to the preview-step-index

Parameter	Type	Description
`previewIndex?`	`number`	Zero based index of the preview steps. See also: previewStepsCount()
`zoom?`	`“frame” \| “spread”`	overrides the frames zoom settings for all devices

Returns: Promise<void>

gotoPreviousPreviewDocument

gotoPreviousPreviewDocument(zoomDuration?: number): Promise<void>

Jumps to the previous available preview document if there is one.

Parameter	Type	Description
`zoomDuration?`	`number`

Returns: Promise<void>

hasEditableFramesWithoutSteps

hasEditableFramesWithoutSteps(): boolean

Returns true if buyer can select any frame on the current spread. Which means that either there are non-step frames to select or the spread can add new group-snippets/stickers Important to keep buyer in the step-logic

Returns: boolean

hasNextStep

hasNextStep(): boolean

Returns true if a next step is available

Returns: boolean

hasPreviewBackButton

hasPreviewBackButton(): boolean

Tells the ui if it should show a Back-Button from preview to edit. It’s true if the currently displayed document is a preview document

Returns: boolean

hasPreviousStep

hasPreviousStep(): boolean

Returns true if a previous step is available

Returns: boolean

hasSteps

hasSteps(): boolean

Indicates if the current template has buyer-steps

Returns: boolean

is3dPreviewSelected

is3dPreviewSelected(): boolean

Returns true if current doc is a 3D Preview

Returns: boolean

isCurrentStepActive

isCurrentStepActive(): boolean

Indicates if the current step has become inactive, because the user has selected other frames TRUE if the current step is part of the selection.

Returns: boolean

isNextStepPreview

isNextStepPreview(): boolean

Indicates if the next step is the preview document.

Returns: boolean

lastStep

lastStep(): iBuyerStep | null

Retrieves last step

Returns: iBuyerStep | null

nextStep

nextStep(zoom?: "frame" | "spread"): Promise<void>

Goes to the next available step (if any)

Parameter	Type	Description
`zoom?`	`“frame” \| “spread”`	overrides the frames zoom settings for all devices

Returns: Promise<void>

previewStepsCount

previewStepsCount(): number

Returns the total amount of available preview-steps. 0 indicates no preview

Returns: number

previousStep

previousStep(zoom?: "frame" | "spread"): Promise<void>

Goes to the previous step (if any)

Parameter	Type	Description
`zoom?`	`“frame” \| “spread”`	overrides the frames zoom settings for all devices

Returns: Promise<void>

setStep

setStep(index: number, zoom?: "frame" | "spread"): Promise<void>

Jumps directly to the step with the given index.

Parameter	Type	Description
`index`	`number`	Index of the step to go to
`zoom?`	`“frame” \| “spread”`	overrides the frames zoom settings for all devices

Returns: Promise<void>

stepHeaderDisplay

stepHeaderDisplay(): "never" | "only title" | "only badge" | "title and badge" | "badge list" | "tabs list"

Returns the template settings for display of steps header on desktop and mobile

stepNumbersDisplayed

stepNumbersDisplayed(): boolean

Returns if step numbers are displayed

Returns: boolean

templateHasEditableFramesWithoutSteps

templateHasEditableFramesWithoutSteps(): boolean

Returns true if buyer can select any frame on any document / spread. Which means that either there are non-step frames to select or the spread can add new group-snippets/stickers

Returns: boolean