Back to Website
Show / Hide Table of Contents

Interface ICategory

A structure defining an asset category.

Package: IframeApi
Examples
{
  "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"
        }
      ]
    }
  }
}

Properties

assets

An array of links to assets of this category.

Declaration
assets: IUrlAsset[]
Property Value
Type Description
IUrlAsset[]

categories

An array of embedded categories.

Declaration
categories: ICategory[]
Property Value
Type Description
ICategory[]

name

A category name.

Declaration
name?: string
Property Value
Type Description
string
Back to top Copyright © 2001–2022 Aurigma, Inc. All rights reserved.
Loading...