IGalleryItemConfig Interface

A structure defining the default parameters of gallery tabs.

Properties

Optional addImageAsPlaceholder

addImageAsPlaceholder: boolean

Allows adding images to the canvas as placeholders. The default value is false.

Optional allowedSubfolder

allowedSubfolder: string

Defines a subfolder of \assets\images\ from which the user can select images for placeholders. When you specify this property, the gallery shows images only from the corresponding public subfolder, and no other tabs are available. By default, your users can select images from any gallery tab or public subfolder.

Optional allowedTabs

allowedTabs: string []

Defines an array of gallery tab names from which the user can select images for placeholders. For example, to open only the Public and My files tabs for image placeholders, set allowedTabs to ["Public", "User"]. By default, your users can select images from any gallery tab.

Optional angle

angle: number

An angle, which design elements are rotated to. By default, this value is 0.

Optional barcodeContent

barcodeContent: BarcodeContentType

Defines the barcode content type.

Optional barcodeFormat

barcodeFormat: BarcodeFormat

Defines the barcode format.

Optional borderColor

borderColor: string

The border color. The default value is "rgba(0,0,0,1)".

Optional borderWidth

borderWidth: number

The border width, in points. The default value is 1.

Optional contentImageUrl

contentImageUrl: string

Defines a link to an image used as the placeholder's content. You can define URLs ("https://example.com/logo.png" ), links to private images ("user:someprivateimage.png"), and images from the public gallery ("public:logos/logo.png").

Optional contentPermissions

contentPermissions: IContentPermissionsConfig

Defines permissions for the content of placeholders.

Optional contentResizeMode

contentResizeMode: ContentResizeMode

Defines the resize mode for image placeholders. It can be either fill, fit, or original. For details, refer to the Image Placeholders topic. The default value is fill.

Optional fillColor

fillColor: string

The fill color. The default value is "rgba(0, 0, 0, 0)".

Optional fixedStubContentSize

fixedStubContentSize: boolean

Maintains the size of stub images while resizing image placeholders. The default value is false.

Optional height

height: string | number

The height of design elements being added to the canvas, in points or percent. For QR codes, the width value is used for both width and height.

Optional imagePermissions

imagePermissions: IImagePermissionsConfig

Defines permissions for images being added to the canvas.

Optional imageUrl

imageUrl: string

A link to the default image.

Optional isCoverMode

isCoverMode: boolean

Enables the cover mode for image placeholders. The default value is true.

Optional isStubContent

isStubContent: boolean

Defines whether this is a stub placeholder. The default value is false.

Optional isVariable

isVariable: boolean

Marks a design element as a variable item. The default value is false.

Optional itemPermissions

itemPermissions: IItemPermissionsConfig

A structure defining the Item Menu and the Floating item toolbar for design elements.

Optional location

The location of design elements being added to the canvas. By default, you can add them to the center of your product.

Optional manipulationPermissions

manipulationPermissions: IManipulationPermissionsConfig

A structure defining the manipulation permissions for design elements.

Optional maskOpacity

maskOpacity: number

The mask opacity of an item. The default value is 0.45.

Optional name

name: string

The name of design elements being added to the canvas.

Optional opacity

opacity: number

An opacity applied to design elements. This value can be from 0 to 1. By default, it is 1.

Optional overlayColor

overlayColor: string

Defines an overlay color for images being added to the canvas.

Optional placeholderPermissions

placeholderPermissions: IPlaceholderPermissionsConfig

Defines permissions for placeholders.

Optional shapePermissions

shapePermissions: IShapePermissionsConfig

Defines permissions for shapes.

Optional textWrappingMode

textWrappingMode: WrappingModeType

A wrapping mode applied to wrap text around design elements. By default, it is "none".

Optional themeBinding

themeBinding: IThemeBindingConfig

A style or a color applied to new design elements.

Optional visualizationPermissions

visualizationPermissions: IVisualizationPermissionsConfig

A structure defining the visualization permissions for design elements.

Optional width

width: string | number

The width of design elements being added to the canvas, in points or percent.