Monogram objects

Monogram objects

The monogram_objects element lets you modify existing monogram objects inside a design. Use it with editDesign or editDesignTrueview APIs. Whether a design has monogram objects is shown by designInfo or designTrueview.


XML structure

<monogram_objects>
      <monogram_object index="0">
            <monogram_lettering ... >   <!-- Optional: modify lettering -->
                  <thread ... />          <!-- Optional: modify lettering color -->
            </monogram_lettering>
            <monogram_ornament ... />   <!-- Note: modifying ornaments is NOT supported yet -->
      </monogram_object>
      <monogram_object index="n">
            <monogram_lettering ... >
                  <thread ... />
            </monogram_lettering>
            <monogram_ornament ... />
            </monogram_object>
</monogram_objects>


Usage

Each <monogram_object> block targets one monogram object in your design:
  1. index → the zero-based index of the monogram in the design.
You can change:
  1. text (text)
  2. font (alphabet_name)
  3. height
  4. thread color (<thread>)

InfoChanging ornaments is not supported yet.·        

  1. Multiple <monogram_object> edits can be done in one request.
  2. Only the parameters you supply are changed. If you only change text, nothing else is touched.
  3. Special fonts with embedded colors/functions may restrict color changes.


Examples

Change the color of the first monogram:

<monogram_objects>
      <monogram_object index="0">
            <monogram_lettering>
                  <thread color="65535" code="xx" brand="xx" description="xx"
                  />
            </monogram_lettering>
      </monogram_object>
</monogram_objects>

Change the text of the first monogram:

<monogram_objects>
      <monogram_object index="0">
            <monogram_lettering text="XYZ"/>
      </monogram_object>
</monogram_objects>

Change text, style, and font of monogram; text and color of second monogram:

<monogram_objects>
      <monogram_object index="0">
            <monogram_lettering text="XYZ" style="style_17" alphabet_name="AGATHA"/>
      </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>


Remarks

The font used must be supported by EWA:
  1. If you change alphabet_name, the new font (alphabet) must be valid.
  2. If you only change other attributes, the original font must be valid.
Thread colors:
  1. If the color exists in the palette, it’s reused.
  2. If not, the API adds it with the supplied color, code, brand and description.
Multiple colorways:
  1. If the design has more than one, only the appointed colorway (or the current one if not specified) is changed.

  1. EWA design recipe
  2. EWA API methods overview
  3. EWA data packages overview