Skip to content
Stella ConnectDocs
Parts

Render a planar nesting as an image per sheet

POST{baseUrl}/v2.0/2d/parts/nesting/{NestId}/sheets/{SheetId}/rendering/planar

Renders a previously computed planar nesting to a PNG image per sheet, each returned as a base64-encoded string. Get a NestId by calling PlanarPartsNesting2D — the returned NestingId is what to pass here.

Authx-api-key

Field
Type
Required
Description
NestIduuidYes

Path parameter. The NestingId returned by PlanarPartsNesting2D.

SheetIduuidYes

Path parameter. Reserved for future per-sheet filtering. Currently ignored — every sheet in the nest is returned regardless of the value supplied. Retained in the URL for forward compatibility.

application/json
Field
Type
Required
Description
imageWidthintegerNo

Image width in pixels. Must be greater than zero. Defaults to 1280.

imageHeightintegerNo

Image height in pixels. Must be greater than zero. Defaults to 1024.

backgroundColorstringNo

Canvas background color as an HTML hex string (e.g. "#FFFFFF", "#000000"). Defaults to "#FFFFFF" (white).

shouldKeepRemnantbooleanNo

When true, draws the remnant crop overlay (the cut-line polygon that separates the retained remnant from the discarded scrap). Styled by Crop. The remnant geometry itself comes from the nest's RemnantCropType and its effective KeepRemnant decision. When false, no crop overlay is drawn.

shouldRenderFullSheetbooleanNo

Only meaningful when ShouldKeepRemnant is true. When false, the crop boundary is drawn at the actual used extent of the parts. When true, the boundary is extended to include the edge-clearance buffer, making the entire usable area appear as remnant rather than just the tight bounding rectangle around the placed parts.

cropobjectNo

Styling for the remnant crop overlay (the cut-line polygon and its fill). Only applied when ShouldKeepRemnant is true.

crop.fillColorstringNo

Fill color as an HTML hex string. Supports optional alpha: #RGB, #RRGGBB, or #AARRGGBB. Default: #00000000 (fully transparent).

crop.hatchStyleenum | nullNo

Hatch pattern applied on top of FillColor. Values are those of HatchStyle (e.g. Horizontal, Cross, ForwardDiagonal, Percent50). Null means no hatching.

Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
crop.strokeColorstringNo

Stroke color as an HTML hex string. Default: #000000 (black).

crop.strokeStyleenumNo

Stroke dash pattern. One of Solid, Dash, Dot, DashDot, DashDotDot, Custom. Default: Solid.

"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
deadZoneobjectNo

Styling for the no-nesting buffer zone at the sheet origin (the inset rectangle from the bottom-left where parts are not allowed to be placed). Only rendered when the nest has a non-zero dead-zone offset.

deadZone.fillColorstringNo

Fill color as an HTML hex string. Supports optional alpha: #RGB, #RRGGBB, or #AARRGGBB. Default: #00000000 (fully transparent).

deadZone.hatchStyleenum | nullNo

Hatch pattern applied on top of FillColor. Values are those of HatchStyle (e.g. Horizontal, Cross, ForwardDiagonal, Percent50). Null means no hatching.

Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
deadZone.strokeColorstringNo

Stroke color as an HTML hex string. Default: #000000 (black).

deadZone.strokeStyleenumNo

Stroke dash pattern. One of Solid, Dash, Dot, DashDot, DashDotDot, Custom. Default: Solid.

"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
partobjectNo

Styling for placed (used) parts on the sheet.

part.fillColorstringNo

Fill color as an HTML hex string. Supports optional alpha: #RGB, #RRGGBB, or #AARRGGBB. Default: #00000000 (fully transparent).

part.hatchStyleenum | nullNo

Hatch pattern applied on top of FillColor. Values are those of HatchStyle (e.g. Horizontal, Cross, ForwardDiagonal, Percent50). Null means no hatching.

Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
part.strokeColorstringNo

Stroke color as an HTML hex string. Default: #000000 (black).

part.strokeStyleenumNo

Stroke dash pattern. One of Solid, Dash, Dot, DashDot, DashDotDot, Custom. Default: Solid.

"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
remnantobjectNo

Styling for unused / leftover positions on the sheet.

remnant.fillColorstringNo

Fill color as an HTML hex string. Supports optional alpha: #RGB, #RRGGBB, or #AARRGGBB. Default: #00000000 (fully transparent).

remnant.hatchStyleenum | nullNo

Hatch pattern applied on top of FillColor. Values are those of HatchStyle (e.g. Horizontal, Cross, ForwardDiagonal, Percent50). Null means no hatching.

Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
remnant.strokeColorstringNo

Stroke color as an HTML hex string. Default: #000000 (black).

remnant.strokeStyleenumNo

Stroke dash pattern. One of Solid, Dash, Dot, DashDot, DashDotDot, Custom. Default: Solid.

"Solid""Dash""Dot""DashDot""DashDotDot""Custom"

Status
When
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

An unexpected error occurred on the server.

Field
Type
Required
Description
dataobject | nullNo

Response payload for the render-planar-nest endpoint. Returned inside a ConnectEnvelope<RenderPlanarNestResponse>. Every sheet in the nest is rendered — the SheetId path parameter is currently ignored.

data.nestIduuidNo

Echo of the NestId that was rendered.

data.images[]object[]No

One rendered image per sheet in the nest.

data.images[].sheetIduuidNo

Identifier of the sheet this image belongs to. Matches a Sheets[].SheetId from the originating nesting response.

data.images[].imageDatastringNo

Rendered sheet image, base64-encoded PNG. Decode to bytes to obtain the raw image. The data:image/png;base64, URI prefix has been stripped.

errors[]object[] | nullNo

One or more errors describing why the request failed. Absent (null) on success.

errors[].descriptionstring | nullNo

Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on.

errors[].errorIdstring | nullNo

Machine-readable, stable error identifier. Consumers should branch on this value rather than on Description. See ConnectErrorIds for the catalog.

pagingobject | nullNo

Paging metadata for list endpoints. Absent on single-item responses.

paging.limitintegerNo
paging.startintegerNo
paging.totalintegerNo

Example 200 response
{
  "data": {
    "nestId": "99d4d3b5-18a3-4e18-b6c3-a40bd48c02fa",
    "images": [
      {
        "sheetId": "1c65aa74-73fc-4fac-b8af-41acabfc39cc",
        "imageData": "string"
      }
    ]
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}