Skip to main content

Interface: FrameStepData

A placeable step is a step that can be placed on a canvas in a set of specific positions.

Extends​

Properties​

colorOption?​

optional colorOption?: OptionResource

Inherited from​

Colorable.colorOption

colorPickerEnabled?​

optional colorPickerEnabled?: boolean

disablePlaceholder?​

optional disablePlaceholder?: boolean

displayImageOnFinishStep?​

optional displayImageOnFinishStep?: boolean

displaySelectionOnFinishStep?​

optional displaySelectionOnFinishStep?: boolean

enableVariantCategories?​

optional enableVariantCategories?: boolean

focalBlur?​

optional focalBlur?: boolean

focalBlurRadius?​

optional focalBlurRadius?: number

focalBlurStrength?​

optional focalBlurStrength?: number

forceImageContain?​

optional forceImageContain?: boolean

forceImageCover?​

optional forceImageCover?: boolean

hideImageInCart?​

optional hideImageInCart?: boolean

hideSelectionInCart?​

optional hideSelectionInCart?: boolean

initialZoomLevel?​

optional initialZoomLevel?: number

lookAtAnimation?​

optional lookAtAnimation?: CameraAnimation

Inherited from​

Animatable.lookAtAnimation

markImageAsCustomField?​

optional markImageAsCustomField?: boolean

markSelectionAsCustomField?​

optional markSelectionAsCustomField?: boolean

maxColors?​

optional maxColors?: number

modelAnimation?​

optional modelAnimation?: ModelAnimation

Inherited from​

Animatable.modelAnimation

overlayImageKey?​

optional overlayImageKey?: string

placeholderImageKey?​

optional placeholderImageKey?: string

placeholderImageUrl?​

optional placeholderImageUrl?: string

regions​

regions: Region[]

Inherited from​

Placeable.regions

shouldVectorize?​

optional shouldVectorize?: boolean

varySelection?​

optional varySelection?: boolean

varyUpload?​

optional varyUpload?: boolean

vectorizationMinimumPixelThreshold?​

optional vectorizationMinimumPixelThreshold?: number

vectorizeMaxColors?​

optional vectorizeMaxColors?: number

whitelistedExtensions​

whitelistedExtensions: string[]