Every iPrintessApi method and property documented in this chapter - 558 in total, across 18 categories. New to the JS API? Start with the Javascript API chapter for how to obtain this reference and the api/ui split, then use this page as an outline.
addBuyerLogEntryattachAllHandlersdetachAllHandlersgenerateContentHashgetTemplateNamegetTemplateTitlehasUnsavedChangesimportTemplateisAttachedisBuyerisBuyerDesignerisInDesignerModeloadloadedFromSaveTokenloadJsonloadSavedShopTemplatesloadTemplateloadTemplateAndFormFieldsloadTemplateWithExchangeTokenpersistExchangeStatesavesaveAndPublishsaveJsonsaveTemplateToShopsetCallbacksshopTokenshowAlertOnCloseshowSaveAndCloseButtonshowSaveButtonunexpireJsonbuyerCanHaveEmptySelectiondisplayStepNumbersgetStepgetStepByIndexgotoFirstStepgotoLastStepgotoNextPreviewDocumentgotoPreviewStepgotoPreviousPreviewDocumenthasEditableFramesWithoutStepshasNextStephasPreviewBackButtonhasPreviousStephasStepsis3dPreviewSelectedisCurrentStepActiveisNextStepPreviewlastStepnextSteppreviewStepsCountpreviousStepsetStepstepHeaderDisplaystepNumbersDisplayedtemplateHasEditableFramesWithoutStepsadjustMarginscanDuplicateSpreadduplicateSpreadenterBookMookPreviewgetAllDocsAndSpreadsgetAllSpreadsgetCurrentDocumentIdgetCurrentSpreadSizegetDocumentAspectgetDocumentAspectRatioNamegetDocumentSizegetMarginshasBuyerContentEditshasBuyerContentEditsInAnyDocumentOrFormFieldhasBuyerContentEditsLeftRightisDoublePageSpreadisInBookMookPreviewisInReadOnlyBuyerModeleaveBookMookPreviewmergeCurrentDocumentToTargetDocumentnextPagepageInfopageInfoSyncpageNavigationDisplaypreviousPageresizeSubDocAndBoxselectDocumentAndSpreadselectLastDocumentselectSpreadsetDocumentBleedsetDocumentSizeshowPageNavigationspreadCountcanDeleteSelectedFramescanMoveSelectedFramescanOpenSelectedGroupclearSelectionclearSelectionKeepZoomcurrentSpreadHasEditableFramesdeleteSelectedFrameseditSelectionenterExpertModefireSelectionChangeCallbackgetAllPropertiesgetAllPropertiesBySpreadIdgetFramePositionByNamegetNumberUigetSelectionPositionhasExpertButtonhasSelectionisInExpertModeleaveExpertModemirrorSelectionmoveSelectionLayeropenSelectedGroupresizeSelectionrotateSelectionselectFirstBuyerBoxOnFocusselectFramesselectFramesByClassselectFramesByExchangeIdselectNextFrameselectPrevFramesetNumberUiPropertysetPropertyshowExpertModeOnLoadtransformFrametransformSelectionaddGapAroundalignSplitterClustersToDocMarginapplyPhotoFrameSnippetapplySplitterCellSnippetcanSplitSelectedFramesconvertSplitterCellToImageconvertSplitterCellToTextcurrentSpreadSplitVariantIdgetAppliedLayoutsgetBackgroundColorPropertiesgetDiscardedContentOnLayoutAppliationgetInitialLayoutCategoryNamegetLastAppliedLayoutInfogetLayoutSnippetFilterMenugetLayoutSnippetKeywordsgetLayoutSnippetProductTypesgetMatchingCollageLayoutsgetMaxCollageImagesgetPhotoFrameSnippetsgetSelectedLayoutTopicIdgetSnippetFilterMenugetSplitterSnippetsgetTextFrameSnippetshasBackgroundhasBackgroundLayoutsTabhasLayoutSnippetImageCountFilterhasLayoutSnippetshasPhotoFrameSnippetshasScissorMenuhasSnippetMenuhasSplitterMenuhasSplittershasSplitterTextSnippetshasTextFrameSnippetsinsertGroupSnippetinsertLayoutAndAssignImagesinsertLayoutSnippetinsertTemplateAsLayoutSnippetisBackgroundSelectedisLastAppliedLayoutloadBackgroundLayoutsloadBackgroundLayoutsByKeywordsloadLayoutSnippetsByKeywordsloadStickerSnippetsByKeywordsnextGapActionremoveGapAroundselectBackgroundsetBackgroundColorsetSplitterGapsshowLayoutSnippetColorSchemessplitFramesplitterEdgesCountstickerCanReplaceFrametemplateHasSnippetsaddSerializedImageallowImageDownloadallowOnlyVectorImageUploadallowPdfUploadallowSvgUploadcreateAwsUploaderProvidercreateExternalImageUploadChanneldeleteImagesgetAllImagesgetDirectImageMetadataFinalizationPromisesgetImageByNamegetImageGroupsgetImageNamegetImagesgetImageThumbFitPropertygetPendingImageUploadsgetPendingImageUploadsCountgetSelectedImageRecommendedSizegetSerializedImagegetUploadedImagesCountgetUploadsInProgressimportImageFromUrlimportImagesFromExternalimportUserUploadedImagesisImageInUsesetShopInfosetUploadProvidershowImageCaptionsshowImagePreviewOverlayshowMobileUploadButtonshowSearchBarstartExternalImagePollinguploadAndDistributeImagesallowImageDistributionallowSimpleImageBorderalwaysRenderCroppedImageassignImageByIdToFrameByNameOrTitleassignImageByIdToFramesWithClassassignImageToNextPossibleFrameassignImageToSelectionOrInsertAsNewFrameassingImageByIdToFramesWithClassassingImageByNameToSelectioncanScalecropImagecurrentSelectionAllowsImageUploaddistributeImagesgetImageBordersOnCurrentSpreadgetImageByClassNamegetImageByFrameNamegetImageFrameInfosgetImageNameByClassNamegetImagesFromCurrentSpreadhasStaticImageFiltersimageDistributionModeinsertImageFrameresetImageFiltersrotateAndCropImagerotateImagesetImageBordersOnCurrentSpreadsetImageMetaPropertysetImagePlacementshowCropOverlayButtonsshowImageDistributionButtontransferImageByFrameNamegetFormFieldgetFormFieldImageListgetFormFieldNameByExternalPropertyIdgetFormFieldsAsPropertiesgetFormFieldSelectedImagegetFormFieldValuehasFormFieldsisFontFormFieldisPropertyVisiblesetFormFieldListDisabledStatessetFormFieldPropertiessetFormFieldValuegetColorByColorSchemegetColorsgetColorSchemesgetFontsgetFontSizesInPercentgetFontSizesInPtgetHexColorgetParagraphStylesinvertColorloadFontsetStoryParagraphsallowZoomOptionsautoScaleDetailsautoScaleEnabledcenterSelectioncenterSpreadInViewforceZoomToSinglePageOnMobilegetZoomModeglobalScaleFactorhasAnimationhasZoomToSelectionButtonisAnimationPlayingisIPhoneisMobileisSoftwareKeyBoardExpandedisSpreadInViewplayAnimationredoredoCountreRenderresizePrintessresizePrintessExactsetExternalTopOffsetsetZoomModeshowGridButtonshowKeyboardShortcutsshowUndoRedostopAnimationtoggleGridundoundoCountzoomInzoomOutzoomToFramescallPriceChangeCallbackforceBasketButtonTextgetAllPriceRelevantFormFieldsgetAllPriceRelevantFormFieldsExtgetAnimationHtmlAsStringgetBasketButtonBehaviourgetBuyerFrameCountAndClassesgetBuyerFrameCountAndMarkersgetFormFieldPriceLabelByTaggetMaxmimumBasketHeightgetMaxmimumBasketWidthgetPriceRelevantDatagetProductInfoUrlgetSamplePriceDatanoBasketThumbnailrenderFirstPageImagerenderPageImagesrenderProofPdfssaveAndGenerateBasketThumbnailUrlsetPriceCategoryLabelsshowAddToBasketButtonshowProofButtoncloseDialogcloseMobileOverlaydisableDialogButtonsenableDialogButtonsgetResourcePathglhideProgressmountFormFieldPanelopenDialogopenPanelquerySelectorreadStateFromFormFieldshowProgresswriteStateToFormFieldaddSpreadsadjustBookanalyzePhotoscanAddSpreadscanReArrangeSpreadscanRemoveSpreadsdebossedCoverImageCountdistributeImagesOnCovergetDocInfoForPhotobookgetImagesBySpreadgetInsertSpreadSnippetsgetPhotobookDistributionModegetPhotobookDuplicateCountgetPhotobookFilteredCountgetPhotobookScreenshotCountgetPhotobookThemeMenuIdgetRenderClustersCoverImagesgetRenderClustersEstimationgetRenderClustersImagesgetSelectedPhotobookThemegetSelectedPhotobookThemeNamegetSpinegoToImageInBookhasCurPhotobookDatainsertCustomCoverImagesToCoverLayoutinsertPhotobookPagesisMagicPhotobookisNoOfPagesValidloadPhotobookThemeListlockCoverInsidereArrangeSpreadsremoveCurrentSpreadremoveSpreadsselectBookDocumentselectPhotobookThemesetBookInsidePagessetSpineFormularuseDebossedCoveruseExclusiveCoverImagesarrangeWallImagesgetSinglePhotoCountgetSinglePhotoLayoutSnippetshasSinglePhotoLayoutSnippetsinsertSinglePhotoLayoutSnippetisPhotoWallModeisSinglePhotoModeIsValidSinglePhotoPrintSelectedopenSinglePhotoDocsetSinglePhotoCountsinglePhotoCanEditDocumentsinglePhotoMaxImagessinglePhotoMinImagesacceptDefaultTextIfMandatoryaddTableRowaddTableRowExtaddTableRowsaddTableRowsExtaiDesignKeywordsaiDesignModeaiTextEditOptionAllowsallowImageBackgroundRemoveallowImageUpscaleapplyImageFilterSnippetapplyNumOfColsToLayoutsDialogMobilebcuiLoadedbringErrorIntoViewbringErrorIntoViewV2canChangeTableRowIndexcanHaveDesktopFramePropertiesBarcanIgnoreLowImageResolutioncanPasteTableRowsJSONcanUseClaudeDesigncanUseClaudeDevStuffclosePropertiesOverlaycolorIntensitycreateCropUicreateCutContourcreateImageEditcreateText2ImagedebugeditTableFullscreenenableA11yForTableControlenableCustomColorsexecuteFormFieldScriptexecuteScriptfocusActiveTextEditorgenerateLiveTextFromAIgetAddToBasketCallbackgetAiDesignMakeDatagetAiDesignPropertiesgetAiImageEffectsgetAllRequiredPropertiesBySpreadIdSyncgetAllRequiredPropertiesSyncgetAspectControlgetAvailableFontSizesgetBackButtonCallbackgetButtonCircleModelgetClaudeDesignSettingsgetColorInfogetContentEditablesgetErrorCallbackgetFirstLevelImageButtonsgetFrameUiHintPositiongetFreestylePhotobookWizardHeadlinegetImageBoxesForColorPalettegetImageFilterSnippetsgetInitialTabIdgetLetterGeneratorJsongetLetterGeneratorMenuTitlegetLoadTemplateButtonCallbackgetMagicPhotobookSettingsTabgetMagicPhotobookWizardHeadlinegetMobileImageCropModeEnabledgetMobileUiBackgroundButtongetMobileUiButtonsgetMobileUiRecordNavigationArrowsgetMobileUiScissorsButtonsgetMobileUiSplitterGapButtongetMobileUiSplitterLayoutsButtongetMobileUiSplitterToImageButtongetMobileUiSplitterToTextButtongetPanelUiHintVisibilitygetPasteboardColorgetRegExpgetSaveTemplateCallbackgetScaledFontSizegetScriptButtonsgetShopDataCallbackgetShopDataLoadedCallbackgetShopLoginCallbackgetShopProjectDisplayNameCallbackgetShopSavedDataCallbackgetStyleValuegetTableGroupTypegetTableRowIndexgetTableRowsToAddgetTableSelectListByFormFieldNamegetText2ImageStylesgetThemeDocIdgetThemeNamehasImageLayoutSelectionhasImageSwaphasMetaPropertieshasOverlayTextEditinghasTextOverflowhideDoneButtonInUiHelperhideOverlayimageSwapActiveisDataSourceisOffCanvasPropertyisPrintessSystemisScrolledToBottomisScrolledToTopisShopUserLoggedInCallbackisTextButtonisTextEditorOpenjumpToFormFieldsAfterLayoutApplylanguageLonglanguageShortlogoutneverHideMobileToolbarnumberOfColumnspopulateDesignraiseTabChangeEventremoveAiImageFramesFromPrimaryDocumentremoveBackgroundFaceremoveHandwritingImageremoveImageBackgroundresetUndoBufferAfterInitialLayoutSelectionrunClaudeDesignselectedFrameBarFeatureselectLayoutDialogHasBeenShownForCurrentSpreadselectLayoutsTabOneTimeselectTabsetBcuiMobilesetCustomIconssetCustomScriptssetDefaultHyphenationLanguagesetEditorTextsetIFrameViewPortsetTableCellsetTableCellV2setTableRowIndexsetTextStylePropertysetUserHasZoomedFlagshowAiImageEffectsshowAiTextEditOptionsshowColorDialogshowContextMenushowDocumentBackButtonshowEnterTextEditorButtonshowFormFieldTabsAsStepsshowLayoutsDialogshowLoadButtonshowMobileTabNavigationshowOverlayshowPagesOnLoadshowPhotoTabshowSimplifiedPagesViewshowSnippetPreviewOverlayshowTabNavigationshowTabNavigationSettingshowText2ImageshowTextEditorshowTextStyleCaptionsstartOrStopImageSwapstreamAnthropicPromptstreamPrompttoggleMobileImageCropModeEnableduiHintsDisplayupscaleImageuserInBuyerSidevalidatevalidateAsyncvalidateAsyncV2validateCurrentTabIdWcBc