ZSK Web API · Preview

Embroidery design & text position

Optionally combine the monogram texts with an existing embroidery design. The texts are placed around the design, at the position and distance chosen here.

Add embroidery file

Loads the design (.tbf, .tc / .z00, .dst, .dsz). It is sent with the request as EmbroideryType, EmbroideryBase64 and EmbroideryName. × removes it again.

Needle assignment file

Optional .nas (JSON) file that assigns needles to the design's color sequence. Its content is sent unchanged as SeqAssignmentJson. × removes it again.

Get needle info / Add needles

Only available for ZSK Z00 and TBF designs. Get needle info reads the needle colors stored in the design and lists them in the dropdown (the swatch shows the selected color). Add needles replaces the Needle colors list with these colors (max 24).

If you do not want to define needle colors yourself, tick Use embroidery colors in the Needle colors section instead.

Text position to design

The 12 buttons around the design icon choose where the text block sits:

• Top / bottom row – text above or below the design, aligned to its left edge, center or right edge.
• Left / right column – text beside the design, aligned to its top edge, middle or bottom edge.

Sent as TextAlignment.Mode (Top, Bottom, Left, Right) and TextAlignment.Alignment (0, 1, 2). Default: bottom center.

Distance to design

Gap between the design and the text in mm, sent as TextAlignment.DistanceMM. Whole millimeters only (the service expects an integer); a typed fraction is rounded.

Monogram texts

Up to 9 text lines. Each line is sent as one entry of Monograms and keeps its own settings. Click a line to select it; the panel below the list then edits that line only.

Load fonts / Load settings

• Load fonts – requests GetFontList from the service and fills the FontFamily picker.
• Load settings – requests GetFontSettings and replaces the stitch parameter choices (default: Premium, Standard, Fast) with the presets on the server.

Text lines

+ Add text adds a line (max 9), × removes one; at least one line always remains.

Settings for the selected line

• FontFamily – click the field to choose from the loaded fonts, or type a name (FontFamily).
• Needle – the needle the line is stitched with, an entry of the Needle colors list (UsedNeedle).
• Stitch parameter – the stitch preset (TextStitchParameter).
• Alignment – left, center or right alignment of the line (HorizontalAlignment 0, 1, 2).
• Stitching sequence – left to right, right to left or from the middle (StitchingSequence 0, 1, 2).
• Size – letter height, 8–38 mm (FontSizeMM).
• Line spacing – 0–100 mm; sent in the top-level LineSpacing array, one entry per line.
• Bend – arcs the line, −100 to +100 % (TextBendProcent).
• Char spacing – −100 to +100 %; only sent when not 0 (CustomTextStitchParameter.ZeichenAbstand).
• Pull compensation – relative in % (PullRel) and absolute in mm (PullAbs).
• Activate kerning (TFONT) – optical kerning for this line. The service picks the kerning table from the FontFamily; Kerning strength (50–300 %) is only sent while the box is ticked (KerningStrength).

Needle colors

Up to 24 needles. They are sent as the Needle list (Red, Green, Blue, Name). A text line's Needle number refers to this list.

Use embroidery colors

Enabled once an embroidery design is added; works only with ZSK Z00 / TBF designs. When ticked, the colors stored in the design are used instead of the list below (UseEmbroideryColors).

Thread cones

Pick colors from a real thread range:

• Load – loads the manufacturers (GetThreadConeManufacturer).
• Manufacturer – choosing one loads its cone series (GetThreadConeSeries).
• Cone series – choosing one loads its colors (GetThreadConeList).

Needle rows

• Color no. – click to choose a cone of the selected series (swatch + ID), or type a number; an exact match fills the swatch and name. The number itself is not sent, only the RGB color and the name.
• Swatch – opens a color picker for any RGB color.
• Name – free text sent as the needle's Name.
• × removes a needle (at least one always remains); + Add needle adds one (max 24).

The needle colors of a Z00 / TBF design can also be copied into this list with Get needle info → Add needles in the Embroidery design section.

Settings

Endpoint

Service URL – address of the ZSK Web API service, ending in .svc. Every request (preview, files, fonts, thread cones, needle info) is sent as POST <Service URL>/StitchJob, so enter it without /StitchJob.

TrueView

Rendering settings for the PNG preview, sent as the TrueView object. They do not change the stitch data.

• Thread thickness – drawn thread width in 1/1000 mm; 300 = 0.3 mm (Strichdicke).
• Brightness – in %, 100 = normal (Helligkeit).
• Lighting on – shades the threads as lit from one direction (BeleuchtungEin).
• Lighting angle – direction the light comes from; only used while Lighting on is ticked (BeleuchtungWinkel).
• Fade-out active – hides stitches longer than Fade-out from (AusblendenAktiv).
• Fade-out from – stitch length in 1/10 mm from which stitches are hidden; 127 = 12.7 mm (AusblendenAb).

Output

• PngResolution – resolution of the PNG preview in dpi; 254 dpi = 10 pixels per mm (PngResolution).
• ServerVersion – API version the requests are sent for, default 3 (ServerVersion).