Every method and property documented in this chapter - 624 in total, across 21 sections: the api object (iPrintessApi) in full, and the members of the ui object (iPrintessComponent) that a shop page calls. 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.
addToBasketcloseGenericDialogcurrentThemedisableGenericDialogButtonsenableGenericDialogButtonshidehideProgressOverlayloadThemeopenGenericDialogrefreshPriceDisplayshowshowProgressOverlayaddBuyerLogEntryattachAllHandlersdetachAllHandlersgenerateContentHashgetTemplateNamegetTemplateTitlehasUnsavedChangesimportTemplateisAttachedisBuyerisBuyerDesignerisInDesignerModeloadloadedFromRescueCopyloadedFromSaveTokenloadJsonloadSavedShopTemplatesloadTemplateloadTemplateAndFormFieldsloadTemplateWithExchangeTokenpersistExchangeStatesavesaveAndPublishsaveJsonsaveTemplateToShopsetCallbacksshopTokenshowAlertOnCloseshowSaveAndCloseButtonshowSaveButtonunexpireJsonbuyerCanHaveEmptySelectiondisplayStepNumbersgetStepgetStepByIndexgotoFirstStepgotoLastStepgotoNextPreviewDocumentgotoPreviewStepgotoPreviousPreviewDocumenthasEditableFramesWithoutStepshasNextStephasPreviewBackButtonhasPreviousStephasStepsis3dPreviewSelectedisCurrentStepActiveisNextStepPreviewlastStepnextSteppreviewStepsCountpreviousStepsetStepstepHeaderDisplaystepNumbersDisplayedtemplateHasEditableFramesWithoutStepsadjustMarginscanDuplicateSpreadduplicateSpreadenterBookMookPreviewgetAllDocsAndSpreadsgetAllSpreadsgetCurrentDocumentIdgetCurrentSpreadSizegetDocumentAspectgetDocumentAspectRatioNamegetDocumentSizegetMarginshasBuyerContentEditshasBuyerContentEditsInAnyDocumentOrFormFieldhasBuyerContentEditsLeftRightisDoublePageSpreadisInBookMookPreviewisInReadOnlyBuyerModeleaveBookMookPreviewmergeCurrentDocumentToTargetDocumentnextPagepageInfopageInfoSyncpageNavigationDisplaypreviousPageresizeSubDocAndBoxselectDocumentAndSpreadselectLastDocumentselectSpreadsetDocumentBleedsetDocumentSizeshowPageNavigationspreadCountupdateCutContoursOfSubDocumentcanDeleteSelectedFramescanMoveSelectedFramescanOpenSelectedGroupclearSelectionclearSelectionKeepZoomcopyFrameShapecurrentSpreadHasEditableFramesdeleteSelectedFrameseditSelectionenterExpertModefireSelectionChangeCallbackgetAllPropertiesgetAllPropertiesBySpreadIdgetFramePositionByNamegetNumberUigetSelectionPositionhasExpertButtonhasSelectionisGroupSelectedisInExpertModeleaveExpertModemirrorSelectionmoveSelectionLayeropenSelectedGroupresizeSelectionrotateSelectionselectFirstBuyerBoxOnFocusselectFramesselectFramesByClassselectFramesByExchangeIdselectNextFrameselectPrevFramesetNumberUiPropertysetPropertyshowExpertModeOnLoadtransformFrametransformSelectionaddGapAroundalignSplitterClustersToDocMarginapplyPhotoFrameSnippetapplySplitterCellSnippetcanSplitSelectedFramesconvertSplitterCellToImageconvertSplitterCellToTextcurrentSpreadSplitVariantIdgetAppliedLayoutsgetBackgroundColorPropertiesgetDiscardedContentOnLayoutAppliationgetInitialLayoutCategoryNamegetLastAppliedLayoutInfogetLayoutSnippetFilterMenugetLayoutSnippetKeywordsgetLayoutSnippetProductTypesgetMatchingCollageLayoutsgetMaxCollageImagesgetPhotoFrameSnippetsgetSelectedLayoutTopicIdgetSnippetFilterMenugetSplitterSnippetsgetTextFrameSnippetshasBackgroundhasBackgroundLayoutsTabhasLayoutSnippetImageCountFilterhasLayoutSnippetshasPhotoFrameSnippetshasScissorMenuhasSnippetMenuhasSplitterMenuhasSplittershasSplitterTextSnippetshasTextFrameSnippetsinsertGroupSnippetinsertLayoutAndAssignImagesinsertLayoutSnippetinsertTemplateAsLayoutSnippetisBackgroundSelectedisLastAppliedLayoutloadBackgroundLayoutsloadBackgroundLayoutsByKeywordsloadLayoutSnippetsByKeywordsloadStickerSnippetsByKeywordsnextGapActionremoveGapAroundselectBackgroundsetBackgroundColorsetSplitterGapsshowLayoutSnippetColorSchemessplitFramesplitterEdgesCountstickerCanReplaceFrametemplateHasSnippetsaddFrameaddSpreadToDocumentcreateDocumentduplicateDocumentexportDocumentexportFrameexportSpreadexportTemplatemodifyDocumentmodifyFormFieldmodifyFrameremoveDocumentremoveFrameremoveFrameImageremoveSpreadreplaceSpreadsetDocumentFlagssetFrameEffectssetFrameImagesetFrameShapesetFrameSimpleTextsetFrameTransformtemplateOutlineaddSerializedImageallowImageDownloadallowOnlyVectorImageUploadallowPdfUploadallowSvgUploadcreateAwsUploaderProvidercreateExternalImageUploadChanneldeleteImagesgetAllImagesgetDirectImageMetadataFinalizationPromisesgetImageByNamegetImageGroupsgetImageNamegetImagesgetImageThumbFitPropertygetPendingImageUploadsgetPendingImageUploadsCountgetSelectedImageRecommendedSizegetSerializedImagegetUploadedImagesCountgetUploadsInProgressimportImageFromUrlimportImagesFromExternalimportUserUploadedImagesisImageInUseopenImageUploadFromFrameBarsetShopInfosetUploadProvidershowImageCaptionsshowImagePreviewOverlayshowMobileUploadButtonshowSearchBarstartExternalImagePollinguploadAndDistributeImagesallowImageDistributionallowSimpleImageBorderalwaysRenderCroppedImageassignImageByIdToFrameByNameOrTitleassignImageByIdToFramesWithClassassignImageToNextPossibleFrameassignImageToSelectionOrInsertAsNewFrameassingImageByIdToFramesWithClassassingImageByNameToSelectioncanScalecropImagecurrentSelectionAllowsImageUploaddistributeImagesgetImageBordersOnCurrentSpreadgetImageByClassNamegetImageByFrameNamegetImageFrameInfosgetImageNameByClassNamegetImageScaleHintsgetImagesFromCurrentSpreadhasStaticImageFiltersimageDistributionModeinsertImageFrameresetImageFiltersrotateAndCropImagerotateImagesetImageBordersOnCurrentSpreadsetImageMetaPropertysetImagePlacementshowCropOverlayButtonsshowImageDistributionButtontransferImageByFrameNamecanUseClaudeDesigngenerateImagegenerateTextgetClaudeDesignSettingsgetImageAiByFrameNamegetImagePromptByFrameNamerunDesignAgentgetFormFieldgetFormFieldImageListgetFormFieldNameByExternalPropertyIdgetFormFieldsAsPropertiesgetFormFieldSelectedImagegetFormFieldValuehasFormFieldsisFontFormFieldisPropertyVisiblesetFormFieldListDisabledStatessetFormFieldPropertiessetFormFieldValuegetColorByColorSchemegetColorsgetColorSchemesgetFontGroupsgetFontsgetFontSizesInPercentgetFontSizesInPtgetHexColorgetParagraphStylesinvertColorloadFontsetStoryParagraphsallowZoomOptionsautoScaleDetailsautoScaleEnabledcenterSelectioncenterSpreadInViewforceZoomToSinglePageOnMobilegetZoomModeglobalScaleFactorhasAnimationhasZoomToSelectionButtonisAnimationPlayingisIPhoneisMobileisSoftwareKeyBoardExpandedisSpreadInViewplayAnimationredoredoCountreRenderresizePrintessresizePrintessExactsetExternalTopOffsetsetZoomModeshowGridButtonshowKeyboardShortcutsshowUndoRedostopAnimationtoggleGridundoundoCountzoomInzoomOutzoomToFramescallPriceChangeCallbackforceBasketButtonTextgetAllPriceRelevantFormFieldsgetAllPriceRelevantFormFieldsExtgetAnimationHtmlAsStringgetBasketButtonBehaviourgetBuyerFrameCountAndClassesgetBuyerFrameCountAndMarkersgetFormFieldPriceLabelByTaggetMaxmimumBasketHeightgetMaxmimumBasketWidthgetPriceRelevantDatagetProductInfoUrlgetSamplePriceDatanoBasketThumbnailrenderFirstPageImagerenderPageImagesrenderProofPdfssaveAndGenerateBasketThumbnailUrlsetPriceCategoryLabelsshowAddToBasketButtonshowProofButtoncloseDialogcloseMobileOverlaydisableDialogButtonsenableDialogButtonsgetResourcePathglhideProgressmountFormFieldPanelopenDialogopenPanelquerySelectorreadStateFromFormFieldshowProgresswriteStateToFormFieldaddSpreadsadjustBookanalyzePhotoscanAddSpreadscanReArrangeSpreadscanRemoveSpreadsdebossedCoverImageCountdistributeImagesOnCovergetDocInfoForPhotobookgetImagesBySpreadgetInsertSpreadSnippetsgetPhotobookDistributionModegetPhotobookDuplicateCountgetPhotobookFilteredCountgetPhotobookScreenshotCountgetPhotobookThemeMenuIdgetRenderClustersCoverImagesgetRenderClustersEstimationgetRenderClustersImagesgetSelectedPhotobookThemegetSelectedPhotobookThemeNamegetSpinegoToImageInBookhasCurPhotobookDatainsertCustomCoverImagesToCoverLayoutinsertPhotobookPagesisMagicPhotobookisNoOfPagesValidloadPhotobookThemeListlockCoverInsidereArrangeSpreadsremoveCurrentSpreadremoveSpreadsselectBookDocumentselectPhotobookThemesetBookInsidePagessetSpineFormularuseDebossedCoveruseExclusiveCoverImagesarrangeWallImagesgetSinglePhotoCountgetSinglePhotoLayoutSnippetshasSinglePhotoLayoutSnippetsinsertSinglePhotoLayoutSnippetisPhotoWallModeisSinglePhotoModeIsValidSinglePhotoPrintSelectedopenSinglePhotoDocsetSinglePhotoCountsinglePhotoCanEditDocumentsinglePhotoMaxImagessinglePhotoMinImagesacceptDefaultTextIfMandatoryaddStyleaddTableRowaddTableRowExtaddTableRowsaddTableRowsExtaiDesignKeywordsaiDesignModeaiTextEditOptionAllowsallowBackgroundFaceRemoveallowImageBackgroundRemoveallowImageUpscaleapplyImageFilterSnippetapplyNumOfColsToLayoutsDialogMobilebcuiLoadedbringErrorIntoViewbringErrorIntoViewV2canChangeTableRowIndexcanHaveDesktopFramePropertiesBarcanIgnoreLowImageResolutioncanPasteTableRowsJSONcanResizeFramecanUpscaleclosePropertiesOverlaycolorIntensitycreateCropUicreateCutContourcreateImageEditcreateText2ImagedebugeditTableFullscreenenableA11yForTableControlenableCustomColorsexecuteFormFieldScriptexecuteScriptfocusActiveTextEditorgenerateLiveTextFromAIgetAddToBasketCallbackgetAiDesignMakeDatagetAiDesignPropertiesgetAiImageEffectsgetAllRequiredPropertiesBySpreadIdSyncgetAllRequiredPropertiesSyncgetAspectControlgetAvailableFontSizesgetBackButtonCallbackgetButtonCircleModelgetColorInfogetContentEditablesgetErrorCallbackgetFirstLevelImageButtonsgetFrameUiHintPositiongetFreestylePhotobookWizardHeadlinegetImageBoxesForColorPalettegetImageFilterSnippetsgetInitialTabIdgetLetterGeneratorJsongetLetterGeneratorMenuTitlegetLoadTemplateButtonCallbackgetMagicPhotobookSettingsTabgetMagicPhotobookWizardHeadlinegetMaxUpscaleFactorgetMobileImageCropModeEnabledgetMobileUiBackgroundButtongetMobileUiButtonsgetMobileUiRecordNavigationArrowsgetMobileUiScissorsButtonsgetMobileUiSplitterGapButtongetMobileUiSplitterLayoutsButtongetMobileUiSplitterToImageButtongetMobileUiSplitterToTextButtongetPanelUiHintVisibilitygetPasteboardColorgetPhotoPlacementContextgetPhotoPlacementLayoutsgetRegExpgetSaveTemplateCallbackgetScaledFontSizegetScriptButtonsgetShopDataCallbackgetShopDataLoadedCallbackgetShopLoginCallbackgetShopProjectDisplayNameCallbackgetShopSavedDataCallbackgetSimilarImagesgetStyleValuegetTableGroupNavgetTableGroupTypegetTableRowIndexgetTableRowsToAddgetTableSelectListByFormFieldNamegetText2ImageStylesgetThemeDocIdgetThemeNamehasImageAssignActionhasImageLayoutSelectionhasImageSwaphasMetaPropertieshasOverlayTextEditinghasSimilarImagePickerhasSimilarImageshasTextOverflowhideDoneButtonInUiHelperhideOverlayimageSwapActiveisDataSourceisOffCanvasPropertyisPrintessSystemisScrolledToBottomisScrolledToTopisShopUserLoggedInCallbackisTabletLayoutisTextButtonisTextEditorOpenjumpToFormFieldsAfterLayoutApplylanguageLonglanguageShortlistScriptslogoutmodifyStyleneverHideMobileToolbarnumberOfColumnsplacePhotoInNewLayoutpopulateDesignraiseTabChangeEventreadScriptreadStylesremoveAiImageFramesFromPrimaryDocumentremoveBackgroundFaceremoveHandwritingImageremoveImageBackgroundremoveScriptremoveStylereportIgnoredErrorresetUndoBufferAfterInitialLayoutSelectionsaveScriptselectedFrameBarFeatureselectLayoutDialogHasBeenShownForCurrentSpreadselectLayoutsTabOneTimeselectTabsetBcuiMobilesetCustomIconssetCustomScriptssetDefaultHyphenationLanguagesetEditorTextsetIFrameViewPortsetStylesetTableCellsetTableCellV2setTableRowIndexsetTextStylePropertysetUserHasZoomedFlagshowAiImageEffectsshowAiTextEditOptionsshowColorDialogshowContextMenushowDocumentBackButtonshowEnterTextEditorButtonshowFormFieldTabsAsStepsshowLayoutsDialogshowLoadButtonshowMobileTabNavigationshowOverlayshowPagesOnLoadshowPhotoTabshowSimplifiedPagesViewshowSnippetPreviewOverlayshowTabNavigationshowTabNavigationSettingshowText2ImageshowTextEditorshowTextStyleCaptionsstartOrStopImageSwapstreamAnthropicPromptstreamPrompttoggleMobileImageCropModeEnableduiHintsDisplayupscaleImageuserInBuyerSidevalidatevalidateAsyncvalidateAsyncV2validateCurrentTabIdWcBc