docs/CANVAS.md is the source of truth (owner-approved 2026-08-03): the normalised square was never a sheet of paper, only a coordinate system, and users who drew past its edge could not place devices there. Storage does not change and there is no migration. What changes is what the renderers DERIVE from it: - space-geometry.ts gains contentFrame() — one item per drawn object, a rank-based outlier vote (median centre, 75th-percentile spread, 10x threshold, majority veto) and a fit-everything box beside the opening view. contentBounds() is now a thin wrapper over it; the old -25%..125% envelope is gone — it WAS the bug that made a plan drawn at 1.5..3.0 frame empty canvas. - spaceFrame()/spaceCenter() make view_box an optional first-frame hint used only when there is nothing to frame; iconUnit() keeps auto placement spacing in proportion (NORM_W for anything inside the old square, so no layout moves); gridLevels() picks a legible grid step. - validation.py: coordinates ±4 -> ±5000, sizes 0.001..5000, decor -1..2 -> ±5000, opening length <= 5000. Garbage insurance, not a frame — a stored 1e100 is still refused. Units: test/canvas.test.mjs covers the plan past the square, the outlier (and the three ways NOT to declare one), corruption, empty space, a lone marker, image plans and the adaptive grid. Backend: the limits, and that a config from any released version validates untouched.
13 KiB
Infinite canvas — the spec (source of truth)
Status: approved by the owner 2026-08-03. Dev-branch feature, no release. Scope decisions final: there is no "plan size" any more, the canvas is conceptually unbounded, storage does not change, and the opening view is always derived from what is actually drawn.
The problem it closes
Several users drew plans that ran past the edge of the grid and then
could not place devices outside it. The only workaround was to redraw
the whole plan. The card behaved as if the normalised unit square
(0..1, rendered as NORM_W x NORM_W = 1000 x 1000 units) were a
sheet of paper with edges. It is not a sheet of paper — it is just the
coordinate system.
Principle
- Coordinates keep their meaning. Rooms, openings, decor and
device positions are still stored normalised.
1.0is still the same distance it always was;cell_cmstill ties a grid cell to real centimetres. No data migration. An existing plan opens as before (the one deliberate exception is icon size — see §6). 0..1is not a boundary, it is an origin. Any finite coordinate is legal.2.7simply means "2.7 canvas widths to the right of the origin".- Nothing in the product may say "you cannot go past the edge". No clamp on drawing, dragging, decor or device placement stops at a rectangle.
- What is stored is only where something is drawn. There is no stored extent to keep in sync.
Model
| Concept | Before | Now |
|---|---|---|
| Canvas | square 0..1, rendered 0..1000 |
unbounded plane, same units |
space.view_box |
the frame; everything was clamped into it | an OPTIONAL hint for the very first frame; used only when there is nothing to frame |
| "fit" rectangle | view_box (or the content bbox in view mode) |
always the content frame (§4) |
| Zoom out floor | ZOOM_MIN = 0.4 (fraction of view_box) |
3x the content frame (MIN_ZOOM = 1/3) |
| Pan bounds | content must cover the scene | content frame + one screen of slack in each direction |
| Icon size | % of view_box, i.e. grew with zoom |
% of the visible viewport (§6) |
| Validation range | +/-4 |
+/-5000 (§3) |
Render frame vs. view
- Frame (
_baseVb()/spaceFrame()) — the rectangle that "fit to screen" fits and that zoom1means. It is recomputed from content, never stored. - View (
_view) — the SVGviewBoxactually painted. It is in absolute render units, so recomputing the frame never teleports the plan; it only changes what zoom100 %means and where panning stops.
§3 Validation limits
custom_components/houseplan/validation.py:
| Symbol | Before | Now | What it is |
|---|---|---|---|
_COORD (layout x/y) |
-4 .. 4 |
-5000 .. 5000 |
coordinate |
_GEOM (room x/y, poly points, opening x/y, view_box origin) |
-4 .. 4 |
-5000 .. 5000 |
coordinate |
_EXTENT (room w/h, view_box w/h) |
0.001 .. 4 |
0.001 .. 5000 |
size — strictly positive |
_NORM (decor x/y/w/h) |
-1 .. 2 |
-5000 .. 5000 |
coordinate |
opening length |
0.001 .. 1 |
0.001 .. 5000 |
size — strictly positive |
+/-5000 is garbage insurance, not a frame. At the product's own
scale (cell_cm = 5 by default, 240 grid cells across the unit width)
one canvas width is ~12 m, so 5000 is ~60 km of plan — unreachable
in a home, while still stopping a stored 1e100 from making the plan
invisible for every client (the failure HP-1500-03 / HP-1501-01
closed). Sizes stay strictly positive because SVG divides by them and
viewBox="0 0 0 0" paints nothing (HP-1502-01).
§4 The content frame
contentFrame(items, opts) in src/space-geometry.ts — pure, unit
tested. Input is a list of items, one per drawn/placed object:
- every room (its own bounding box — polygon or legacy rect);
- the backdrop image rectangle, when the space has one;
- every opening (door/window) end-to-end segment;
- every decor shape;
- every device the layout actually places in this space.
Output:
{ core: Rect | null, all: Rect | null, outliers: number }
core— bbox of the main mass, padded. This is the opening view.all— bbox of everything, padded. This is what "show the far objects" fits.outliers— how many items were left out ofcore.
Both rectangles are padded by pad (default 0.05) of the longer
side, and degenerate axes are inflated (see §4.2).
For a space with a backdrop image the image rectangle is one of the items, so the image still sets the extent — cropping to the rooms would hide the parts of the picture nobody has outlined yet (owner, point 2).
Fallback order when there are no items at all: the stored view_box
(the "hint"), then the legacy unit square. This is the only place
view_box is still read for framing.
§4.1 Outlier rejection
An object standing an order of magnitude further away than the rest must not decide the opening view, but must still be reachable. The criterion is deliberately rank-based (medians/percentiles), so a single absurd value cannot move it:
- Items whose coordinates fall outside the sane range
(
+/-CANVAS_LIMIT, i.e. the same+/-5000the backend accepts) are dropped outright — that is corruption, not content. - With fewer than
MIN_VOTERS = 4items no outlier is declared: with two objects there is no majority to be far from. m= component-wise median of the item centres.d_i= Chebyshev distancemax(|x_i-m_x|, |y_i-m_y|)fromm.spread= the 75th percentile ofd, floored atMIN_SPREAD = 0.05 * NORM_W(50 render units, about a small room), so a tightly clustered plan does not call its own neighbour an outlier.- Item
iis an outlier iffd_i > OUTLIER_K * spread, withOUTLIER_K = 10— literally "an order of magnitude further than the bulk". - Majority veto: if more than a third of the items came out as
outliers, this is not a plan with strays — it is a spread-out plan.
No outliers are declared and
core = all.
When outliers > 0 the card shows an unobtrusive inline hint (no
modal) — "there are objects far from the plan" with a Show action
that fits all.
§4.2 Degenerate frames
An SVG viewBox with a zero axis paints nothing, so a frame still has
a floor:
- an axis shorter than
DEGENERATE = 0.03 * NORM_Wis grown toFLOOR = 0.2 * NORM_W, centred on itself.
That covers "one lone marker" and "a collinear row of markers". A real
thin shape (a 100-unit corridor) is well above the threshold and keeps
its tight frame. This is the only survivor of the old safety props —
the -25 % .. 125 % envelope that used to reject far content is gone,
replaced by §4.1 (the envelope WAS the bug: content past the old square
was silently excluded from the frame).
§5 Zoom and pan
- Zoom in — unchanged,
ZOOM_MAX = 8. - Zoom out —
MIN_ZOOM = 1/3: you can see three times the content frame and no further. Empty space beyond that is not information. - Pan — bounded by the content frame inflated by
PAN_SLACK = 1.0ofmax(view, frame)on each side. You can walk off the plan (there is no edge), but not into infinity. - "Home is that way" arrow — when the content frame is entirely outside the current view, a small pointer appears at the view edge in the frame's direction. Clicking it fits the content. Cheap insurance against getting lost in the empty plane.
§6 Icon size — from the viewport
Changed behaviour, owner is aware. Before:
--icon-size: iconPct * vb.w / view.w (cqw)
so an icon grew as you zoomed in — at 8x zoom a marker covered a whole room. Now:
--icon-size: iconPct * kioskScale (cqw)
An icon is a fixed percentage of the visible viewport: zooming changes how much plan you see, not how big the markers are. Side effects, all intended:
- the full card and the static
houseplan-space-cardnow use the identical expression — the two renderers finally agree at every zoom; - the per-device multiplier
marker.sizeand the kiosk icon/font scales are untouched: they still feed--dev-size, and every satellite (badges, LQI chips, presence rings, ripples) still derives from--dev-sizeexactly as before.
Auto-placement spacing (defaultPositions -> declump) is measured
in render units, so it needs the icon's render-unit footprint, which is
now frame-relative. iconUnit(space) = max(NORM_W, roomsExtent) is
used instead of a bare NORM_W: for any plan that fits the old square
this is exactly NORM_W (bit-identical placement, no churn), and for a
plan three canvases wide the spacing grows with it. Both renderers call
the same helper, so the static card and the full card stay in step.
§7 Adaptive grid
The drawing grid is a dot pattern at pitch = NORM_W / GRID_N. On a
plan several canvases wide, zoomed out, the dots merged into a grey
wash. gridLevels(pitch, pxPerUnit, minPx) (pure, unit tested) picks:
fine— the smallest multiplier from1, 2, 5, 10, 20, 50, 100, 200, 500, 1000whose on-screen step is at leastminPx(7 px); finer dots are simply not drawn;coarse— the next multiplier that is at least5 x fine, drawn bigger/darker, so the eye keeps a scale reference (the usual CAD every-5th/10th-line convention);nullwhen even the coarsest step would be sub-pixel — then there is no grid at all rather than a grey fog.
The grid rectangle also follows the view, not the old view_box,
so it is there wherever you pan.
§8 Toolbar
The middle button of the zoom control was "Reset zoom" (_resetZoom,
disabled at zoom 1). It is the fit-everything action, so it was
re-labelled rather than duplicated: title.zoom_fit — "Fit all" /
«Вписать всё», icon unchanged (mdi:fit-to-page-outline), and it is no
longer disabled at zoom 1 (at zoom 1 off-centre it still has work to
do). It fits core — the same rectangle the plan opens with. Far
objects are reached through the outlier hint's Show action, which
fits all.
Every place that assumed the unit square
| Place | Assumption | Decision |
|---|---|---|
contentBounds envelope -25 %..125 % |
content outside the square does not count | removed — replaced by §4.1 outlier rejection |
_baseVb() if (mode !== 'view') return m.vb |
editors need the whole square to have room to draw | removed — the content frame plus §5 pan slack and 3x zoom-out gives more room than the square ever did |
_baseVb() if (m.bg) return m.vb |
image plans frame on the square | image rect is now just one content item (§4) |
--icon-size scaled by vb.w / view.w |
icon is a fraction of the canvas | §6 |
defaultPositions minDist from NORM_W |
one canvas = one plan | iconUnit() (§6) |
markerPos / _pos fallback = view_box centre |
a device with no position belongs in the middle of the square | spaceCenter() — the middle of the content |
grid <rect> over vb |
the grid ends with the square | rect follows the view (§7) |
| grid pitch fixed | fine at 1 canvas wide | gridLevels() (§7) |
_clampView pinned content over the scene |
you cannot pan past the edge | §5 pan slack |
ZOOM_MIN = 0.4 |
fraction of the square | MIN_ZOOM = 1/3 of the content frame (§5) |
_decorMoveUpdate clamp -0.25 .. 1.25 |
decor may hang a quarter past the edge | clamp widened to the sane range (+/-CANVAS_LIMIT) — corruption insurance, not a frame |
static card aspect-ratio + viewBox from space.vb |
the static card frames the square | spaceFrame() — same content frame as the full card |
validation.py +/-4, _EXTENT <= 4, decor -1..2, opening length <= 1 |
the square plus slack | §3 |
safeViewBox fallback [0,0,1,1] |
a broken view_box means the square |
kept — it is only the last-resort hint (§4) |
fitInSquare (image placement) |
image is centred in the square | kept — it defines the image's own rectangle in canvas units, which is exactly what §4 wants as a content item |
_spaceH / _decorH = NORM_W |
the canvas is square | kept — this is the coordinate system's aspect, not a frame |
_gridPitch = NORM_W / GRID_N |
grid pitch is tied to the canvas unit | kept — the pitch is the real-world cell (cell_cm), it must not change with the plan's size |
| sun wedges / glow radii / resize maths | all in render units, relative to their own geometry | unaffected — verified: no NORM_W-relative constants |
What is deliberately NOT done
- No new stored field. The frame is derived every time; there is nothing to migrate, nothing to keep in sync, nothing to corrupt.
view_boxis still WRITTEN as[0,0,1,1]on space creation and is still required by the schema — removing a required field is a breaking storage change for old clients and buys nothing.- The outlier hint has no "hide this object" action. Deciding what to do with a stray marker is the device editor's job.