CreatorSE.Composition Data Type

Represents a design composition resource within the Creator SE platform. The CreatorSE.Composition resource serves as a container for design elements and is associated with a specific product area.

Available Since
1.3.0
Properties
Name Type Description
productArea CreatorSE.ProductArea Represents the product area associated with this design composition. The product area defines contextual information such as product dimensions and assignments relevant to the composition.
previewResource CreatorSE.ResourceFile Represents the preview resource associated with the design composition in the Creator SE platform.

The `previewResource` field contains a reference to a `ResourceFileCse` object which provides a file-based implementation of the preview data. It is typically used to store preview-specific content such as image previews or other renderable resources associated with the design composition.

creatorse_designElementMotive array of CreatorSE.DesignElementMotive Represents an array of design elements associated with a design composition in the Creator SE platform.

The `elements` field serves as a container for design elements that form part of the composition. Each design element can represent specific types such as motives or DDF (Direct Data Format) components.

The following design element types are currently supported:

  • DesignElementMotive: Represents a motive component in the design composition.
  • DesignElementDdf: Represents a design element with associated preview and production resources.
  • DesignElementDecoration: Represents a decoration element.
  • creatorse_designElementDdf array of CreatorSE.DesignElementDdf Represents an array of design elements associated with a design composition in the Creator SE platform.

    The `elements` field serves as a container for design elements that form part of the composition. Each design element can represent specific types such as motives or DDF (Direct Data Format) components.

    The following design element types are currently supported:

  • DesignElementMotive: Represents a motive component in the design composition.
  • DesignElementDdf: Represents a design element with associated preview and production resources.
  • DesignElementDecoration: Represents a decoration element.
  • creatorse_designElementDecoration array of CreatorSE.DesignElementDecoration Represents an array of design elements associated with a design composition in the Creator SE platform.

    The `elements` field serves as a container for design elements that form part of the composition. Each design element can represent specific types such as motives or DDF (Direct Data Format) components.

    The following design element types are currently supported:

  • DesignElementMotive: Represents a motive component in the design composition.
  • DesignElementDdf: Represents a design element with associated preview and production resources.
  • DesignElementDecoration: Represents a decoration element.
  • CreatorSE.Composition (JSON)
    {
      "creatorse_composition" : {
        "productArea" : {
          "id" : 12345,
          "name" : "...",
          "assignedView" : {
            "id" : 12345,
            "view" : { }
          },
          "realSize" : {
            "width" : 12345.0,
            "height" : 12345.0
          }
        },
        "previewResource" : {
          "attachment" : "...",
          "filename" : "...",
          "url" : "..."
        },
        "elements" : [ {
          "creatorse_designElementMotive" : {
            "motive" : {
              "id" : 12345,
              "attachment" : "...",
              "filename" : "...",
              "url" : "..."
            },
            "position" : {
              "horizontalCenter" : "...",
              "verticalCenter" : "...",
              "left" : "10%",
              "right" : "10%",
              "top" : "10%",
              "bottom" : "..."
            },
            "printTechnology" : {
              "id" : 12345,
              "name" : "DTG"
            },
            "layers" : {
              "creatorse_designElementLayer" : [ {
                "name" : "...",
                "text" : "...",
                "rgbColor" : "..."
              }, {
                "name" : "...",
                "text" : "...",
                "rgbColor" : "..."
              } ]
            }
          }
        }, {
          "creatorse_designElementDdf" : {
            "previewResource" : {
              "attachment" : "...",
              "filename" : "...",
              "url" : "..."
            },
            "productionResource" : {
              "attachment" : "...",
              "filename" : "...",
              "url" : "..."
            },
            "position" : {
              "horizontalCenter" : "...",
              "verticalCenter" : "...",
              "left" : "10%",
              "right" : "10%",
              "top" : "10%",
              "bottom" : "..."
            },
            "printTechnology" : {
              "id" : 12345,
              "name" : "DTG"
            },
            "layers" : {
              "creatorse_designElementLayer" : [ {
                "name" : "...",
                "text" : "...",
                "rgbColor" : "..."
              }, {
                "name" : "...",
                "text" : "...",
                "rgbColor" : "..."
              } ]
            }
          }
        }, {
          "creatorse_designElementDecoration" : {
            "sku" : "STICKER-WOVEN-001",
            "placement" : "chest-left",
            "position" : {
              "horizontalCenter" : "...",
              "verticalCenter" : "...",
              "left" : "10%",
              "right" : "10%",
              "top" : "10%",
              "bottom" : "..."
            },
            "printTechnology" : {
              "id" : 12345,
              "name" : "DTG"
            },
            "layers" : {
              "creatorse_designElementLayer" : [ {
                "name" : "...",
                "text" : "...",
                "rgbColor" : "..."
              }, {
                "name" : "...",
                "text" : "...",
                "rgbColor" : "..."
              } ]
            }
          }
        } ]
      }
    }
    CreatorSE.Composition Data Type

    Represents a design composition resource within the Creator SE platform. The CreatorSE.Composition resource serves as a container for design elements and is associated with a specific product area.

    Available Since
    1.3.0
    Properties
    Name Type Description
    creatorse_designElementDdf CreatorSE.DesignElementDdf Represents an array of design elements associated with a design composition in the Creator SE platform.

    The `elements` field serves as a container for design elements that form part of the composition. Each design element can represent specific types such as motives or DDF (Direct Data Format) components.

    The following design element types are currently supported:

  • DesignElementMotive: Represents a motive component in the design composition.
  • DesignElementDdf: Represents a design element with associated preview and production resources.
  • DesignElementDecoration: Represents a decoration element.
  • creatorse_designElementDecoration CreatorSE.DesignElementDecoration Represents an array of design elements associated with a design composition in the Creator SE platform.

    The `elements` field serves as a container for design elements that form part of the composition. Each design element can represent specific types such as motives or DDF (Direct Data Format) components.

    The following design element types are currently supported:

  • DesignElementMotive: Represents a motive component in the design composition.
  • DesignElementDdf: Represents a design element with associated preview and production resources.
  • DesignElementDecoration: Represents a decoration element.
  • creatorse_designElementMotive CreatorSE.DesignElementMotive Represents an array of design elements associated with a design composition in the Creator SE platform.

    The `elements` field serves as a container for design elements that form part of the composition. Each design element can represent specific types such as motives or DDF (Direct Data Format) components.

    The following design element types are currently supported:

  • DesignElementMotive: Represents a motive component in the design composition.
  • DesignElementDdf: Represents a design element with associated preview and production resources.
  • DesignElementDecoration: Represents a decoration element.
  • previewResource CreatorSE.ResourceFile Represents the preview resource associated with the design composition in the Creator SE platform.

    The `previewResource` field contains a reference to a `ResourceFileCse` object which provides a file-based implementation of the preview data. It is typically used to store preview-specific content such as image previews or other renderable resources associated with the design composition.

    productArea CreatorSE.ProductArea Represents the product area associated with this design composition. The product area defines contextual information such as product dimensions and assignments relevant to the composition.
    CreatorSE.Composition (XML)
    <creatorse_composition>
      <productArea>
        <id>...</id>
        <name>...</name>
        <assignedView>
          <id>...</id>
          <view/>
        </assignedView>
        <realSize>
          <width>...</width>
          <height>...</height>
        </realSize>
      </productArea>
      <previewResource>
        <attachment>...</attachment>
        <filename>...</filename>
        <url>...</url>
      </previewResource>
      <elements>
        <creatorse_designElementMotive>
          <motive>
            <id>...</id>
            <attachment>...</attachment>
            <filename>...</filename>
            <url>...</url>
          </motive>
          <position/>
          <printTechnology/>
          <layers>
            <creatorse_designElementLayer/>
          </layers>
        </creatorse_designElementMotive>
        <creatorse_designElementDdf>
          <previewResource>
            <attachment>...</attachment>
            <filename>...</filename>
            <url>...</url>
          </previewResource>
          <productionResource>
            <attachment>...</attachment>
            <filename>...</filename>
            <url>...</url>
          </productionResource>
          <position/>
          <printTechnology/>
          <layers>
            <creatorse_designElementLayer/>
          </layers>
        </creatorse_designElementDdf>
        <creatorse_designElementDecoration>
          <sku>STICKER-WOVEN-001</sku>
          <placement>chest-left</placement>
          <position/>
          <printTechnology/>
          <layers>
            <creatorse_designElementLayer/>
          </layers>
        </creatorse_designElementDecoration>
      </elements>
    </creatorse_composition>