Single Photo Prints

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

arrangeWallImages

arrangeWallImages(): Promise<boolean>

Photo-wall mode only: starts the automatic arrangement of the wall images.

Returns: Promise<boolean> — true if the arrangement ran, false when not in photo-wall mode

getSinglePhotoCount

getSinglePhotoCount(docId: string): number

Gets the per-document print count of a single photo-print document.

Parameter	Type	Description
`docId`	`string`

Returns: number — the count, or -1 if the document cannot be found

getSinglePhotoLayoutSnippets

getSinglePhotoLayoutSnippets(): Promise<Array<iExternalSnippetCluster>>

Loads the layout-snippet clusters defined on the first spread of the “photo-template” document. These are the layouts a buyer can apply to their single photo prints. Returns an empty array when not in single-photo (“photo”) mode.

Returns: Promise<Array<iExternalSnippetCluster>>

hasSinglePhotoLayoutSnippets

hasSinglePhotoLayoutSnippets(): boolean

True when the “photo-template” document offers layout-snippets for single photo prints.

Returns: boolean

insertSinglePhotoLayoutSnippet

insertSinglePhotoLayoutSnippet(snippetUrl: string, allDocs: boolean): Promise<void>

Single-photo mode (“photo”) only: applies a layout-snippet to the targeted photo-print document(s), takes over the previously placed image and refreshes the overview thumbnails.

Parameter	Type	Description
`snippetUrl`	`string`	the layout-snippet to apply
`allDocs`	`boolean`	apply to every photo-print document (true) or only the current one (false)

Returns: Promise<void>

isPhotoWallMode

isPhotoWallMode(): boolean

Indicates photo-wall order mode: returns true when the template’s single-photo mode is set to “wall”.

Returns: boolean

isSinglePhotoMode

isSinglePhotoMode(): boolean

Indicates single photo print order mode: returns true when the template’s single-photo mode is set to “photo”.

Returns: boolean

IsValidSinglePhotoPrintSelected

This method is deprecated.

IsValidSinglePhotoPrintSelected(): boolean

Returns true if the currently selected document is an actual photo-print document (neither the primary document nor the “photo-template”).

Returns: boolean

openSinglePhotoDoc

openSinglePhotoDoc(docId: string): Promise<void>

Opens a single photo-print document for full editing from the single-photo pages overview. Returns to the overview via selectLastDocument() (back button surfaces automatically).

Parameter	Type	Description
`docId`	`string`

Returns: Promise<void>

setSinglePhotoCount

setSinglePhotoCount(docId: string, count: number): Promise<void>

Sets the per-document print count of a single photo-print document (values below 1 are clamped to 1). Persists the change and fires the external price-change callback.

Parameter	Type	Description
`docId`	`string`	id of the photo-print document
`count`	`number`	new print count for this document

Returns: Promise<void>

singlePhotoCanEditDocument

singlePhotoCanEditDocument(): boolean

Single photo “photo” mode: whether the buyer may open a photo-print for full document editing.

Returns: boolean

singlePhotoMaxImages

singlePhotoMaxImages(): number

Maximum number of images allowed in single-photo or photo-wall mode. Returns 99 while the template is not yet loaded.

Returns: number

singlePhotoMinImages

singlePhotoMinImages(): number

Minimum number of images required in single-photo or photo-wall mode. Returns 99 while the template is not yet loaded.

Returns: number