IPlaceholderItemDefaultConfig Interface

A structure defining the default parameters of image placeholders.

You can apply these parameters to the placeholder object through either clientConfig.json or IConfiguration. The following example shows how you can allow your users to select images only from the europe_photos subfolder of the public folder and disable the cover mode.

example
{
    "defaultItemsConfig": {
        "placeholder": {
            "allowedPublicSubfolder": "europe_photos",
            "isCoverMode": false
        }
    }
}

Properties

Optional allowedPublicSubfolder

allowedPublicSubfolder: string

Defines a subfolder of the public gallery 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 borderColor

borderColor: string

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

Optional borderWidth

borderWidth: number

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

Optional contentResizeMode

contentResizeMode: number

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

Optional fillColor

fillColor: string

The shape fill color. The default value is "rgba(112,112,112,255)".

Optional isCoverMode

isCoverMode: boolean

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

Optional itemPermissions

itemPermissions: IItemPermissionsConfig

A structure defining the Item Menu for design elements.

Optional manipulationPermissions

manipulationPermissions: IManipulationPermissionsConfig

A structure defining the manipulation permissions for design elements.

Optional opacity

opacity: number

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

Optional placeholderPermissions

placeholderPermissions: IPlaceholderPermissionsConfig

Permissions for image 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 visualizationPermissions

visualizationPermissions: IVisualizationPermissionsConfig

A structure defining the visualization permissions for design elements.