BackgroundValue ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Type · import type { BackgroundValue } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 21. Stored data (vendored; replaces @holo/interfaces)

A stored background: a 0xRRGGBB number, null (no stored background), or a gradient. Typed form: BackgroundSpec. A scene model's non-null backgroundColor is drawn as 1.x's scene write drew it: a background layer over the merged document's background, under every stage layer (Stage.set), following the committed model, so undo and capture follow it too. A number reads as '#rrggbb'; a gradient as { gradient, direction }, each stop { color: '#rrggbb', at: position }. null or absent sets none, and the layers below show.

Inherited from IGradientBackground: type, direction, stops.

Declaration ​

ts
export type BackgroundValue = number | null | IGradientBackground;

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: BackgroundValue names no product
2. A precedent not recorded: no ledger row (coverage.json) names this member or its owner
3. Two apps, or labs not recorded: no ledger row names this member or its owner
4. The cheaper fix first not recorded per member (Appendix B decides it per need)