Interface: IChannelContainerDefinition

A structure holding settings to create a channel container.

Remarks

For details, see the Defining Channel Containers topic.

Example

const productDefinition = {
  surfaces: [
    {
      printAreas: [
        {
          designFile: "texture",
          containers: [
            {
              name: "foil",
              type: "texture",
              texture: "texture.jpg",
            },
            {
              name: "spot",
              type: "spotColor",
              previewColor: "rgba(255,255,0,1)",
            },
          ],
        },
      ],
    },
  ],
};

Properties

type?

optional type?: ChannelContainerType

A type of the channel container, either texture or spot color.

---

name?

optional name?: string

A unique container name.

---

translationKey?

optional translationKey?: string

The translation key of the channel tab caption in the Object Inspector. The corresponding string should be defined in the ~/Configuration/translations.json file.

---

previewColor?

optional previewColor?: string

An RGB color representing a spot color on the canvas and proof images.

---

texture?

optional texture?: string

A texture image used for rendering elements of the container on the canvas and proof images. This value is relative to the ~/assets/helpers/ folder.

---

outputColor?

optional outputColor?: string

The color that is used in hires. This could be, for example, black rgb or cmyk color, or some specific Spot color.