Skip to main content

ViewHighlight

One row of a view's highlight grid. The list endpoint returns only rows

idstring

Unique identifier of the highlight row.

panoIdinteger

Pano ID assigned to the slot. Null when the row is in the "empty" state.

rotationnumber

Pano rotation in radians. Null when no pano is assigned.

slotIdstring

Identifier of the slot this row is bound to. Slot definitions come from the schema endpoint.

slotKeystring

Stable per-schema key for the slot (e.g. "kitchen"). Null when the slot is unkeyed.

slotLabelstring

Operator-facing label for the slot (e.g. "Kitchen").

slotPositioninteger

Slot ordering position within the schema. List rows are sorted by this ascending.

sourcestring

Origin of the row: "operator" (manually bound) or "algorithm" (auto-computed).

Possible values: [operator, algorithm]

statestring

Computed state: "default" for algorithm rows, "bound" for operator rows with a pano, or "empty" for operator rows where the slot was explicitly cleared.

Possible values: [default, bound, empty]

thumbnailUrlstring

URL to the highlight thumbnail. Null when no pano is assigned.

viewerUrlstring

Deep link to the viewer at the highlighted pano and rotation. Always present.

ViewHighlight
{
"id": "string",
"panoId": 0,
"rotation": 0,
"slotId": "string",
"slotKey": "string",
"slotLabel": "string",
"slotPosition": 0,
"source": "operator",
"state": "default",
"thumbnailUrl": "string",
"viewerUrl": "string"
}