ProductArea Data Type

A printable area defined on one side of a product. Describes the position, dimensions, and print constraints (e.g. maximum motive size) for a given product view.

Available Since
1.3.0
Subtypes
ProductAreaExpanded
Properties
Name Type Description
id number Unique numeric identifier for the ProductArea.
boundsXTwips number Area shape anchor x position [twips].
boundsYTwips number Area shape anchor y position [twips].
boundsWidthTwips number Area shape width [twips].
boundsHeightTwips number Area shape height [twips].
name string Name of the area derived from the Product View.
default boolean Whether this is the default print area for the view, pre-selected in the design creator.
xHotSpotTwips number X coordinate of the default motive placement hotspot within this area [twips].
yHotSpotTwips number Y coordinate of the default motive placement hotspot within this area [twips].
sizeHotSpotTwips number Default motive size at the hotspot position [twips]. Defines the initial scale when a motive is first placed.
enabled boolean Whether this print area is active and available for design placement.
ProductArea (JSON) 
{
  "productArea" : {
    "id" : 12345,
    "boundsXTwips" : 3390,
    "boundsYTwips" : 3990,
    "boundsWidthTwips" : 3500,
    "boundsHeightTwips" : 5980,
    "name" : "Front",
    "default" : true,
    "xHotSpotTwips" : 12345,
    "yHotSpotTwips" : 12345,
    "sizeHotSpotTwips" : 12345,
    "enabled" : true
  }
}
ProductArea Data Type

A printable area defined on one side of a product. Describes the position, dimensions, and print constraints (e.g. maximum motive size) for a given product view.

Available Since
1.3.0
Subtypes
ProductAreaExpanded
Properties
Name Type Description
boundsHeightTwips short Area shape height [twips].
boundsWidthTwips short Area shape width [twips].
boundsXTwips short Area shape anchor x position [twips].
boundsYTwips short Area shape anchor y position [twips].
default boolean Whether this is the default print area for the view, pre-selected in the design creator.
enabled boolean Whether this print area is active and available for design placement.
id int Unique numeric identifier for the ProductArea.
name string Name of the area derived from the Product View.
sizeHotSpotTwips short Default motive size at the hotspot position [twips]. Defines the initial scale when a motive is first placed.
xHotSpotTwips short X coordinate of the default motive placement hotspot within this area [twips].
yHotSpotTwips short Y coordinate of the default motive placement hotspot within this area [twips].
ProductArea (XML) 
<productArea>
  <id>...</id>
  <boundsXTwips>3390</boundsXTwips>
  <boundsYTwips>3990</boundsYTwips>
  <boundsWidthTwips>3500</boundsWidthTwips>
  <boundsHeightTwips>5980</boundsHeightTwips>
  <name>Front</name>
  <default>...</default>
  <xHotSpotTwips>...</xHotSpotTwips>
  <yHotSpotTwips>...</yHotSpotTwips>
  <sizeHotSpotTwips>...</sizeHotSpotTwips>
  <enabled>...</enabled>
</productArea>