Automated Computed Embroidery

TrueView

POST

The optional TrueView object sets the look of the PNG preview: CreatePNG, CreateStatPNG and the PreviewData of CreateTC with "WithPreview": true. It does not change the embroidery data.

Rules

Omit the object, or any single field, to use the defaults below.
Every field can be sent with its English or its German name. The German names are used in older examples. If both names of a field are sent, the English one is used.
Field names are case-sensitive. A misspelled field is ignored without an error, and its default is used.
Values may be sent as strings, as in the example.
The server does not check the ranges; they are the limits of the TrueView settings in the ZSK embroidery software.

Fields

Field	German name	Type	Default	Range	Description
`LineThickness`	`Strichdicke`	int	300	10 – 9900	Line thickness of the stitches in 1/1000 mm.
`Brightness`	`Helligkeit`	int	100	0 – 200	Brightness in percent.
`LightingOn`	`BeleuchtungEin`	int	1	0 / 1	1 lights the stitches from the direction in LightingAngle, 0 switches the lighting direction off.
`LightingAngle`	`BeleuchtungWinkel`	int	90	0 – 360	Direction of the light in degrees. Only used with LightingOn = 1.
`HideStitches`	`AusblendenAktiv`	int	1	0 / 1	1 hides stitches that are longer than HideStitchesFrom, 0 draws all stitches.
`HideStitchesFrom`	`AusblendenAb`	int	127	1 – 99999	Stitch length in 1/10 mm above which stitches are hidden. Only used with HideStitches = 1.

Parameters

Parameter	Type	Description	Required
`LineThickness`	int	Line thickness of the stitches in 1/1000 mm. German name: Strichdicke. Default 300.	No
`Brightness`	int	Brightness in percent. German name: Helligkeit. Default 100.	No
`LightingOn`	int	1 lights the stitches from the direction in LightingAngle, 0 switches the lighting direction off. German name: BeleuchtungEin. Default 1.	No
`LightingAngle`	int	Direction of the light in degrees. Only used with LightingOn = 1. German name: BeleuchtungWinkel. Default 90.	No
`HideStitches`	int	1 hides stitches that are longer than HideStitchesFrom, 0 draws all stitches. German name: AusblendenAktiv. Default 1.	No
`HideStitchesFrom`	int	Stitch length in 1/10 mm above which stitches are hidden. Only used with HideStitches = 1. German name: AusblendenAb. Default 127.	No

Example

  "TrueView": {
    "LineThickness": "300",
    "Brightness": "100",
    "LightingOn": "1",
    "LightingAngle": "90",
    "HideStitches": "1",
    "HideStitchesFrom": "127"
  }