Vectors

Format

/1/Vectors/[design component]

Design component can be Lettering, a design, a template, a compound or a AutoDigitize.

Description

Renders a design component and returns the vector data with palette information.

Parameters

• Format - Format of the return response is JSON.
• Parameters are same as Render. Additional parameter/s is/are listed below.
• IsMaintainTemplate - Default value is true.
  • true - Will return vectors of whole designs as an element regardless of how many elements are configured in it.
  • false - Will return vectors of designs for each elements in it.
    • Add X and Y position for each elements using TranslateX (mm) and TranslateY (mm) parameters while Generating file.

Example

/1/Vectors/Lettering?Text=ABC

Response Parameters - Returns list of elements in JSON format

• Name - Name of the Element.
• Text - Default/Personalized text of the element.
• IsText - For text element value is true otherwise false.
• Bounds - Returns the bounds of designs for non named element.
• Fonts - List of font names.
• Height - Height of the design for named element.
• X1,Y1 - Represents the start coordinates of the stitches in millimeter (mm).
• X,Y - Represents the end coordinates of the stitches in millimeter (mm).
• RelColor - Color index of Palette. It always sets to 0 unless value of the code is 4.
• Code - Color changes are required when it sets to 4.
  • Example - RelColor is 7 and Code is 4 then select the color from the thread palette at index 7.
• Palette - R,G,B value of the Colors, Code, Name, Manufacture and, Value of the colors from the design.

Output

    {
	    "Elements": [
		    {
			    "Name": "string",
			    "Text": "string",
			    "IsText": true,
			    "Bounds": {
				    "Top": 0,
				    "Bottom": 0,
				    "Left": 0,
				    "Right": 0
			    },
			    "Fonts": [{"Name":"string"}],
			    "Height": 0,
			    "Stitches": [
				    {
					    "X": 0,
					    "Y": 0,
					    "X1": 0,
					    "Y1": 0,
					    "RelColor": 0,
					    "Code": 0
				    }
			    ],
			    "Palette": [
				    {
					    "Blue": 0,
					    "Red": 0,
					    "Green": 0,
					    "Code": "string",
					    "Name": "string",
					    "Manufacturer": "string",
				    }
			    ]
		    }
	    ]
    }

---