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

IPrivateSourceConfig Interface

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

A structure defining properties of the private user gallery.

example

clientConfig.json

{
  "assetSources": {
    "My files": {
      "type": "PrivateSource",
      "allowedExtensions": [ "jpg", "jpeg", "png", "bmp", "svg", "pdf" ],
      "groupingByDateEnabled": true,
      "autoInsertUploadedFile": true,
      "overwrite": true,
      "path": "order_3",
      "actionMode": {
        "pdf": "Shape",
        "svg": "Shape"
      }
    }
  }
}

Modules

Name Description
IGallerySourceConfig

A structure defining properties of asset sources.

Properties

Optional actionMode

actionMode: IActionModeParsed

allowedExtensions

allowedExtensions: string []

Optional autoInsertUploadedFile

autoInsertUploadedFile: boolean

If true, the Asset Manager 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 groupingByDateEnabled

groupingByDateEnabled: boolean

If true, arranges images by date. The list of dates when the user uploaded the images appears in the Categories. The default value is false.

Optional overwrite

overwrite: boolean

Allows for overwriting images with existing names. If false, the name of the uploaded file is changed by adding _1, _2, etc. to it. The default value is false.

Optional path

path: string

A subfolder of userdata/user/images, where the Asset Manager saves uploaded files. By default, this is an empty string, and images are saved in the userdata/user/images folder.

Optional rootCategory

rootCategory: ICategory

type

type: "PublicSource" | "PrivateSource"