type · ui.layout
canvas
Viewport-filling non-movable panel for a spatial surface behind frame panels.
mode = canvas- Stable ID
ui.layout.canvas- Owner
- app.ScriptUiPanel
- Authority
- presentation
- Timing
- composition
- Availability
- Phase 19Q9F Empire view
- Side effects
- Records detached presentation intent.
- Determinism
- Resolved from the current reserved world viewport.
- Introduced
- 1.19.0
Usage
Fill the current world viewport with one fixed script-owned presentation canvas. Use it for a regional map beneath movable inspectors; it does not reserve or mutate World state.
Parameters
- None
Returns
A full-viewport presentation layout contract.
Cost
One panel and its bounded widgets against the normal composition budgets.
Fields
This symbol has no fields.
Errors
- None
Examples
ui.begin_panel({id = "empire-map", title = "Regional map", mode = "canvas", margin = 0})API history
- 1.19.0: Full-viewport canvas layout added for Phase 19Q9F.