Skip to content

Documentation / @expofp/schema / FpSvgLayerJs

Type Alias: FpSvgLayerJs ​

ts
type FpSvgLayerJs = object;

The evaluated fp.svg.<layerName>.js payload — one drawing layer, loaded on demand when a multi-floor plan shows a layer whose paths are not present yet (components/Map/drawing/config/config-load-layer.ts).

Type Declaration ​

Index Signature ​

ts
[key: string]: unknown

__fp? ​

ts
optional __fp?: string;

The layer's SVG document (newer layer files emit it only as the __fp<layerName> alias; the loader folds it back here — see the module doc). Tagged svgAsset: the URLs its <image>s carry — the svg-images/… hrefs, and the data-model-3d 3D models that stand in for them — are asset paths, made absolute when the payload resolves and localized when an offline copy is serialized.

__fpGeo? ​

ts
optional __fpGeo?: object;

Index Signature ​

ts
[key: string]: unknown

__fpGeo.images? ​

ts
optional images?: object[];
Index Signature ​
ts
[key: string]: unknown

__fpGeo.properties? ​

ts
optional properties?: object;
Index Signature ​
ts
[key: string]: unknown

__fpGeo.properties.config? ​

ts
optional config?: object;
Index Signature ​
ts
[key: string]: unknown

__fpGeo.properties.config.bearing? ​

ts
optional bearing?: number;

__fpGeo.properties.config.p0? ​

ts
optional p0?: object;

__fpGeo.properties.config.p0.lat ​

ts
lat: number;

__fpGeo.properties.config.p0.lng ​

ts
lng: number;

__fpGeo.properties.config.p0.x ​

ts
x: number;

__fpGeo.properties.config.p0.y ​

ts
y: number;

__fpGeo.properties.config.p1? ​

ts
optional p1?: object;

__fpGeo.properties.config.p1.lat ​

ts
lat: number;

__fpGeo.properties.config.p1.lng ​

ts
lng: number;

__fpGeo.properties.config.p1.x ​

ts
x: number;

__fpGeo.properties.config.p1.y ​

ts
y: number;

__fpGeo.properties.config.p2? ​

ts
optional p2?: object;

__fpGeo.properties.config.p2.lat ​

ts
lat: number;

__fpGeo.properties.config.p2.lng ​

ts
lng: number;

__fpGeo.properties.config.p2.x ​

ts
x: number;

__fpGeo.properties.config.p2.y ​

ts
y: number;

__fpGeo.properties.config.p3? ​

ts
optional p3?: object;

__fpGeo.properties.config.p3.lat ​

ts
lat: number;

__fpGeo.properties.config.p3.lng ​

ts
lng: number;

__fpGeo.properties.config.p3.x ​

ts
x: number;

__fpGeo.properties.config.p3.y ​

ts
y: number;

__fpGeo.properties.config.snapThreshold? ​

ts
optional snapThreshold?: number;

__fpGeo.properties.config.style? ​

ts
optional style?: "light" | "dark";

Basemap palette the drawing is authored for (MapThemeSchema) — what the Designer emits. Left unset by drawings that predate it, where the SDK falls back to __fpSettings.backgroundColor's lightness.

__fpGeo.properties.config.type? ​

ts
optional type?: "maplibre";

The map the drawing is authored for. 'maplibre' — the only value the Designer emits — asks the SDK to render the plan on the MapLibre basemap; unset leaves the plan on the plain floor plan. An explicit enableExperimentalMaplibre from any config layer still overrides it.

__fpGeo.properties.mpViewbox? ​

ts
optional mpViewbox?: number[];

__fpGeo.properties.useMaplibre? ​

ts
optional useMaplibre?: boolean;

__fpPaths? ​

ts
optional __fpPaths?: object[];

Triangulated meshes by data-index (newer files: folded from the alias).

__fpSettings? ​

ts
optional __fpSettings?: object;

Index Signature ​

ts
[key: string]: unknown

__fpSettings.backgroundColor? ​

ts
optional backgroundColor?: string;

__fpSettings.boothBorderColor? ​

ts
optional boothBorderColor?: string;

__fpSettings.boothBorderWidth? ​

ts
optional boothBorderWidth?: number;

__fpSettings.boothLabelColor? ​

ts
optional boothLabelColor?: string;

__fpSettings.fpVer? ​

ts
optional fpVer?: string;

Converter format version ("5.0"); gates v5+ runtime features. Distinct from the numeric __fpVersion.

__fpSettings.heatmapColors? ​

ts
optional heatmapColors?: string[];

__fpSettings.maxZoom? ​

ts
optional maxZoom?: number;

__fpStat? ​

ts
optional __fpStat?: object;

Index Signature ​

ts
[key: string]: unknown

__fpStat.dataSize? ​

ts
optional dataSize?: number;

__fpVersion? ​

ts
optional __fpVersion?: number;

Numeric data-format version (e.g. 6). Distinct from fpVer.