View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IGalleryDialogConfigParsed Interface

Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation

A structure defining settings of the Image Gallery. For details, refer to the Using the Image Gallery topic.

example

clientConfig.json

"GalleryDialog": {
    "defaultTabName": "Public",
    "tabs": [
      {
          "name": "User",
          "type": "user",
          "translationKey": "GalleryDialog.TAB_USER",
          "canEdit": true,
          "canUpload": true
      },
      {
          "name": "Public",
          "type": "public",
          "subFolderName": "Flyers",
          "canEdit": true
      },
      {
          "name": "Facebook",
          "type": "facebook",
          "canEdit": true,
          "appKey": "123456789012345"
      }
    ]
}

Properties

Optional allowedExtensions

allowedExtensions: string []

The file extensions that a user is allowed to upload to the Gallery. This array may contain any combination of "jpg", "jpeg", "png", "bmp", "gif", "tiff", "svg", "pdf", "ai", "psd". The default value is ["jpg", "jpeg", "png", "bmp", "gif", "svg", "pdf"].

Optional autoInsertUploadedFile

autoInsertUploadedFile: boolean

If true, the Gallery closes as soon as it uploads a user image. After that, this image is automatically inserted into the placeholder or image layer. The default value is false.

Optional backgroundColorPickerEnabled

backgroundColorPickerEnabled: boolean

Enables the Color Picker when selecting a background. The default value is false.

Optional defaultTab

defaultTab: GalleryDialogTabType

Outdated, use the defaultTabName property instead. The default tab opened in Gallery; it can have one of the following values: "user", "public", "background", "facebook", "instagram". The default value is "user".

Optional defaultTabName

defaultTabName: string

The default tab opened in Gallery; it should be one of ITabDescriptorParsed.name.

Optional downloadPsdAsImage

downloadPsdAsImage: boolean

Allows for merging PSD files with design elements placed on the canvas. If false, then PSD layers of the uploading templates, all but the background and foreground layers, are embedded into the canvas. By default, this value is true, and Customer's Canvas embeds PSD templates as a raster image.

Optional insertToAllButtonEnabled

insertToAllButtonEnabled: boolean

Allows for changing backgrounds of all product surfaces at once. The default value is false.

Optional overwriteExistingFiles

overwriteExistingFiles: boolean

Allows for overwriting images with existing names in the Gallery. The default value is false.

Optional publicFolderName

publicFolderName: string

Outdated, use the tabs array instead. Sets a subfolder of the ~\PublicGalleryFolder\ folder containing graphics files displayed in the Public files tab in the Gallery. By default, the entire ~\PublicGalleryFolder\ folder content is displayed.

Optional publicTabEnabled

publicTabEnabled: boolean

Outdated, use the tabs array instead. Enables the Public files tab in the Gallery. The default value is true.

Optional saveAllowedTabAfterInsert

saveAllowedTabAfterInsert: boolean

Allows you to restrict the image selection only to the gallery tab from which an image was selected. If true, your users cannot open another tab. The default value is false.

Optional showTabsInRestrictedMode

showTabsInRestrictedMode: boolean

Enables an ability to upload photos and select private photos even if the <IASF> marker is used. The default value is false.

Optional socialNetworkAppIds

socialNetworkAppIds: ISocialNetworkAppIdsParsed

Outdated, use appKey of the tabs array instead. The Instagram and/or Facebook identifiers for your application. For details, see the Integration with Facebook and Instagram topic.

Optional tabs

tabs: ITabDescriptorParsed []

The array of tabs available in the Image Gallery. If you define the tabs array, then the outdated properties are ignored.

Optional userTabEnabled

userTabEnabled: boolean

Outdated, use the tabs array instead. Enables the My files tab in the Gallery. The default value is true.