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

IAssetSources Module

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

A structure defining sources for the Asset Manager. For details, see The Asset Manager topic.

example

clientConfig.json

{
  "assetSources": {
    "My files": {
      "type": "PrivateSource",
      "allowedExtensions": [ "jpg", "jpeg", "png" ]
    },
    "External urls": {
      "type": "MemorySource",
      "rootCategory": {
        "assets": [
          {
            "title": "Square",
            "preview": "http://example.com/images/preview/2.jpg",
            "source": "http://example.com/images/2.jpg"
          },
          {
            "title": "Buildings",
            "preview": "http://example.com/images/preview/4.jpg",
            "source": "http://example.com/images/4.jpg"
          }
        ],
        "categories": [
          {
            "name": "Stock images",
            "assets": [
              {
                "title": "Winter",
                "preview": "http://example.com/images/preview/16.jpg",
                "source": "http://example.com/images/16.jpg"
              },
              {
                "title": "Skating",
                "preview": "http://example.com/images/preview/20.jpg",
                "source": "http://example.com/images/20.jpg"
              }
            ]
          }
        ]
      }
    }
  },
  "widgets": {
    "AssetManager": {
      "tabs": [
        {
          "name": "My files",
          "assetSourceInstance": "My files",
          "iconClassName": "cc-icon-uploadable",
          "controls": { "toolbarEnabled": false }
        },
        {
          "name": "The gallery based on external urls",
          "assetSourceInstance": "External urls",
          "iconClassName": "cc-icon-add-image"
        }
      ]
    }
  }
}

Indexable

[sourceInstanceName: string ]: IAssetSourceConfig

A set of sources of the Asset Manager.

Modules

Name	Description
IGallerySourceConfig	A structure defining properties of asset sources.
IMemorySourceConfig	A structure defining asset sources through direct URLs.
IRemoteSourceConfig	A structure defining properties of the Google Drive and Amazon S3 sources.

Interfaces

Name	Description
IAssetSourceConfig	A structure defining the source type of the Asset Manager.
IDepositPhotosConfig	A structure defining properties of the Depositphotos source.
IPrivateSourceConfig	A structure defining properties of the private user gallery.
ISocialNetworkSourceConfig	A structure defining the API key of social networking services.