Monogram Objects

<monogram_objects>				
   <monogram_object index="0">		
      <monogram_lettering... >		//optional change lettering parameters
         <thread... />			//optional change lettering color
      </monogram_lettering>
      <monogram_ornament ... />		//change ornament is not supported yet
   </monogram_object>
   <monogram_object index="n">		
      <monogram_lettering... >			
            <thread... />		
      </monogram_lettering>
      <monogram_ornament … />		
   </monogram_object>
</monogram_objects >

If a design contains monogram objects, they can be modified by using monogram_objects parameter by calling editDesign or editDesignTrueview.  Whether a design contains monogram objects can be determined in design_info which is returned by several API methods like designInfo or designTrueview.

Multiple monogram objects can be modified in one call. Each monogram_object specifies a modification for a single monogram object. The index specifies the ordinal zero-based index of the monogram object in the design that should be modified.

The system supports modification of monogram lettering parameters (using monogram_lettering) as well as modification of lettering color (using thread). Modify ornament properties is not supported yet. There is a limitation to change color for some special alphabets that have letters with saved colors/functions, see Letters created with unchecked remove functions.

The subset of monogram_lettering parameters supported for modification is text, alphabet_name, and height.

All parameters inside monogram_object are optional and the system will modify only the ones which are supplied. Thus, it is possible to say only change the text, or only the color, or only the text and the alphabet.

For example:

  1. Modify the color of the first monogram lettering object in a design:
<monogram_objects>
   <monogram_object index="0">
      <monogram_lettering>
         <thread color="65535" code="xx" brand="xx" description="xx"  />
      </monogram_lettering>
   </monogram_object>
</monogram_objects>
  1. Modify the text of the first monogram lettering object in a design
<monogram_objects>
   <monogram_object index="0">
      <monogram_lettering text="XYZ"/>          
   </monogram_object>
</monogram_objects>
  1. Modify the text, alphabet, and style of the first object; and the text and color of the second monogram object in a design
<monogram_objects>
   <monogram_object index="0">
      <monogram_lettering text="XYZ" style="style_17" alphabet_name="AGATHA" >            
      </monogram_lettering>
   </monogram_object>
   <monogram_object index="1">
      <monogram_lettering text="789">
         <thread color="65535" code="xx" brand="xx" description="xx" />
      </monogram_lettering>
   </monogram_object>
</monogram_objects>

Client side must guarantee the alphabet used by editDesign/editDesignTrueview is supported by EWA in both of following scenarios:

  • Modified alphabet_name of monogram_object must be supported by EWA.
  • When modify other attributes than alphabet_name for a monogram_object, the original alphabet of the monogram_object must be supported by EWA.

API searches the color in palette of the design if a thread color is appointed when calling editDesign/editDesignTrueview. If the color is found, the corresponding stop of the lettering object will use the index of the found color. Otherwise, API will create new thread color with supplied color, value, code, brand and description in the palette of the design, and the corresponding stop of the lettering object will use the index of the new thread color.

For the design has more than 1 colorways, the editDesign/editDesignTrueview only works on one colorway: appointed colorway (by colorway of design) or current colorway (no colorway appointed).