overlays

overlays/model/{model}/preview

Changed on

Get the per-pixel virtual-display coordinates for a model, for a lightweight layout preview. Sourced from config/virtualdisplaymap (the xLights-exported layout) and returned on demand so the UI never has to inline this data (which can be hundreds of thousands of points per model) for every model at once.

get/api/overlays/model/{model}/preview

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/overlays/model/{model}/preview
  • Auth
    none declared

Response

Object with a pixels array of [x, y, z, node] entries in node

Changes