Canvastype¶
Version: v1 Scope: global Owning service: studio-design-library
A Canvastype describes a logical multi-panel display surface built from a specific ordered set of ESL types. Where an ESL type describes a single electronic label, a canvas type describes a combined unit — for example, a three-panel shelf-edge strip assembled from three identical ESL types. The canvas type records the combined pixel dimensions of the whole surface, the palette that is compatible with all constituent ESL types, and both metric and imperial physical dimensions. Designs intended for multi-panel rendering reference a canvas type rather than individual ESL types.
ID pattern¶
canvastypes/{canvastypeid}
| Segment | Meaning |
|---|---|
canvastypes |
Fixed collection name |
{canvastypeid} |
Opaque or derived identifier assigned by studio-design-library |
Canvas types are global (not scoped per tenant) because the physical hardware characteristics they describe are tenant-independent.
Schema¶
| Field | Type | Description |
|---|---|---|
id |
string | Full resource name following the ID pattern above |
esltype_ids |
repeated string | Ordered list of ESL type IDs (lexicographically sorted) that make up this canvas. The same ESL type may appear multiple times if the canvas is built from identical panels. |
width_pixels |
uint32 | Combined pixel width of the entire canvas surface |
height_pixels |
uint32 | Combined pixel height of the entire canvas surface |
color_space |
ColorSpace enum | Deprecated — use palette_id instead |
palette_id |
string | Best palette compatible with all ESL types in this canvas, e.g. palettes/BWRY |
total_width_mm |
uint32 | Physical width of the device in millimeters |
total_width_32nd_inch |
uint32 | Physical width in 1/32nd-inch units (imperial measurement used by some ESL hardware specifications) |
total_height_mm |
uint32 | Physical height of the device in millimeters |
total_height_32nd_inch |
uint32 | Physical height in 1/32nd-inch units |
resolution_dpi |
uint32 | Display resolution in dots per inch |
ColorSpace enum (deprecated)¶
| Value | Meaning |
|---|---|
COLOR_SPACE_UNSPECIFIED (0) |
Default / unset |
BW (1) |
Black & White |
BWY (2) |
Black, White, Yellow |
BWR (3) |
Black, White, Red |
BWRY (4) |
Black, White, Red, Yellow |
Use palette_id instead.
Consumed by¶
| Service | Why |
|---|---|
| Studio UI | Enumerates canvas types to allow users to create canvas designs targeting the correct surface dimensions |
studio-design-library |
Validates that a new Canvasdesign has pixel dimensions matching the referenced canvas type |
Related DTOs¶
- canvasdesign — a design that references a canvas type via
compatible_canvastype_ids - palette — defines the exact RGB colors referenced by
palette_id