Interface IChannelContainerDefinition

A structure holding settings to create a channel container.

Package: @aurigma/design-editor-iframe

Remarks

For details, see the Defining Channel Containers topic.

Examples

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

name

A unique container name.

Declaration

name?: string;

Property Value

Type	Description
string	A unique container name.

outputColor

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

Declaration

outputColor?: string;

Property Value

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

previewColor

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

Declaration

previewColor?: string;

Property Value

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

texture

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.

Declaration

texture?: string;

Property Value

Type	Description
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.

translationKey

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

Declaration

translationKey?: string;

Property Value

Type	Description
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.

type

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

Declaration

type?: ChannelContainerType;

Property Value

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