Documentation / @expofp/schema / UrlConfig

Type Alias: UrlConfig

type UrlConfig = object;

The subset tunable from the page URL query.

Type Declaration

allowConsent?

optional allowConsent?: boolean;

camera?

optional camera?: object = CameraSchema;

The initial camera, applied once at boot (an empty object means "don't move"). The runtime counterpart is FloorPlan.setCamera / the setCamera intent; the legacy ?centerxy=/?center=/?z=/?bearing=/?zoomtime= URL params translate into this shape.

camera.bearing?

optional bearing?: number;

Map rotation in degrees (0–360).

camera.floor?

optional floor?: string;

Floor name to activate.

camera.lat?

optional lat?: number;

Center, GPS latitude (paired with lng).

camera.lng?

optional lng?: number;

Center, GPS longitude (paired with lat).

camera.x?

optional x?: number;

Center, floor-plan projected coordinates (paired with y).

camera.y?

optional y?: number;

Center, floor-plan projected coordinates (paired with x).

camera.zoomTime?

optional zoomTime?: number;

Camera movement animation duration in milliseconds.

consent?

optional consent?: "ask" | "granted" | "denied" = ConsentSchema;

disableBookmarked?

optional disableBookmarked?: boolean;

Disable adding entities to bookmarks.

disableFeatured?

optional disableFeatured?: boolean;

Drop the featured flag from every exhibitor (no featured view).

disableGps?

optional disableGps?: boolean;

Start with GPS tracking off.

enableExperimentalMaplibre?

optional enableExperimentalMaplibre?: boolean;

Enable experimental MapLibre GL JS support.

enableExperimentalOutdoorMarkers?

optional enableExperimentalOutdoorMarkers?: boolean;

Enable experimental outdoor PoI markers: booths on an Outdoor* layer leave the renderer scene and draw as fixed-size native MapLibre markers with clustering.

Unset or false disables the feature outright — Outdoor layers then render like any other layer, exactly as they did before it existed. Unlike enableExperimentalMaplibre this is NOT tri-state: no drawing field opts a plan in, so there is nothing for undefined to defer to.

filters?

optional filters?: object = FiltersSchema;

Search filters applied once at boot by the URL filter manager (an empty object applies nothing). Canonical URL form ?filters[categories][0]=food; the legacy ?categories=/?poiType=/?poiTypes=/?exhibitors=true keys keep working — and remain the form the floor plan writes back to the URL as the visitor changes filters.

filters.categories?

optional categories?: string[];

Category names to pre-select; opens the category filter panel.

filters.exhibitors?

optional exhibitors?: boolean;

true opens the exhibitors list at boot.

filters.poiType?

optional poiType?: string;

A single POI type to pre-select; also activates its search filter button.

filters.poiTypes?

optional poiTypes?: string[];

POI type names to pre-select (no filter-button activation).

heatmap?

optional heatmap?: object = HeatmapSchema;

Heatmap mode, engaged once at boot (an empty object — the default — means no heatmap). A non-empty node engages the mode unless enabled is explicitly false, so heatmap: { variant: 'yah' } implies enabled; variant picks the dataset (booths view stats by default, yah for "You are here" QR scans; kiosk: true narrows yah to kiosk positions). Heatmap mode freezes the page URL for the whole session (the legacy contract). The legacy ?heatmap=true&type=yah&subtype=kiosk links keep working as a translation; the access token ?t= stays a separate raw query param, not config.

heatmap.enabled?

optional enabled?: boolean;

Engage the heatmap explicitly; false vetoes an otherwise non-empty node.

heatmap.kiosk?

optional kiosk?: boolean;

Narrow the yah variant to kiosk positions (ignored for booths).

heatmap.variant?

optional variant?: "booths" | "yah";

The dataset shown: booths (the default) — booth/exhibitor view stats; yah — "You are here" QR-code scan counts, with a stripped-down monochrome presentation.

hideHeaderLogo?

optional hideHeaderLogo?: boolean;

Hide the header logo (and the ExpoFP logo).

hideLogoInBooth?

optional hideLogoInBooth?: boolean;

Hide exhibitor logos inside booths.

intents?

optional intents?: (
  | {
  args: [string];
  name: "selectBooth";
}
  | {
  args: [string];
  name: "selectExhibitor";
}
  | {
  args: [string];
  name: "changeLanguage";
}
  | {
  args: [string];
  name: "selectCategory";
}
  | {
  args: [string];
  name: "select";
}
  | {
  args: [
     | "exhibitors"
     | "bookmarks"
     | "visited"
     | "sessions"
     | "speakers"
     | "tours"
    | "language"];
  name: "showList";
}
  | {
  args: [string];
  name: "selectTour";
}
  | {
  args: [{
     from?: string;
     fromBookmarks?: boolean;
     items?: string[];
  }];
  name: "openPlanner";
}
  | {
  args: [];
  name: "startBuildRoute";
}
  | {
  args: [{
     bearing?: number;
     floor?: string;
     lat?: number;
     lng?: number;
     x?: number;
     y?: number;
     zoomTime?: number;
  }];
  name: "setCamera";
}
  | {
  args: [{
     controls?: boolean;
     header?: boolean;
     levels?: boolean;
     overlay?: boolean;
     searchButtons?: boolean;
  }];
  name: "setVisibility";
}
  | {
  args: [string[]];
  name: "selectRoute";
}
  | {
  args: [string[]];
  name: "selectAccessibleRoute";
}
  | {
  args: [string, string[]];
  name: "showPathway";
}
  | {
  args: [{
     angle?: number;
     lat?: number;
     lng?: number;
     x: number;
     y: number;
     z?: string | number;
  }, boolean, number?];
  name: "selectCurrentPosition";
})[];

kiosk?

optional kiosk?: object = KioskSchema;

The kiosk anchor — where a kiosk device stands and how its camera is framed, applied at boot when the device has no locally-saved kiosk (the on-device SetKiosk flow wins; localStorage['kiosk']='0' disables both). Canonical URL form ?kiosk[x]=…; the legacy kiosk_* params stay the per-navigation translation and ?kiosk=1/0 keeps toggling kiosk mode.

kiosk.heading?

optional heading?: number;

Device heading in degrees — rotates the you-are-here marker.

kiosk.iconSizePercent?

optional iconSizePercent?: number;

You-are-here icon size, in percent.

kiosk.lat?

optional lat?: number;

GPS latitude (with lng, an alternative fix to x/y).

kiosk.lng?

optional lng?: number;

GPS longitude.

kiosk.mapBearingDegrees?

optional mapBearingDegrees?: number;

Map bearing at the home framing, degrees (map mode).

kiosk.mapCenterLat?

optional mapCenterLat?: number;

Home framing center latitude (map mode).

kiosk.mapCenterLng?

optional mapCenterLng?: number;

Home framing center longitude (map mode).

kiosk.mapCenterX?

optional mapCenterX?: number;

Home framing center x.

kiosk.mapCenterY?

optional mapCenterY?: number;

Home framing center y.

kiosk.mapInitialPtScale?

optional mapInitialPtScale?: number;

The pt-scale captured when the kiosk was set up (zoom reference).

kiosk.mapPitch?

optional mapPitch?: number;

Map pitch at the home framing, degrees.

kiosk.mapPitchDegrees?

optional mapPitchDegrees?: number;

Map pitch at the home framing, degrees (map mode).

kiosk.mapPtScale?

optional mapPtScale?: number;

The pt-scale of the saved framing.

kiosk.mapRollDegrees?

optional mapRollDegrees?: number;

Map roll at the kiosk's home framing, degrees.

kiosk.mapZoom?

optional mapZoom?: number;

Map zoom level at the home framing (map mode).

kiosk.uiScale?

optional uiScale?: number;

Per-device UI scale preference (the applied range is 0.8–1.4).

kiosk.x?

optional x?: number;

Anchor x in plan coordinates.

kiosk.y?

optional y?: number;

Anchor y in plan coordinates.

kiosk.z?

optional z?: string | number | null;

Floor: the level name (a numeric index is accepted and stringified). Nullable — the on-device SetKiosk flow writes null for a plan with no layers, and that record round-trips through localStorage.

monochrome?

optional monochrome?: boolean;

Render the plan in grayscale.

noOverlay?

optional noOverlay?: boolean;

validateSchema?

optional validateSchema?: boolean;

visibility?

optional visibility?: object = VisibilitySchema;

Visibility of the map chrome, applied once at boot (an empty object leaves the chrome untouched; a non-empty one resets every omitted element to visible — the legacy ?hide= list semantics). The runtime counterpart is FloorPlan.setVisibility / the setVisibility intent; the legacy ?hide=a,b deep link keeps its store-level translation.

visibility.controls?

optional controls?: boolean;

The map controls (zoom buttons, …).

visibility.header?

optional header?: boolean;

The header bar — logos and the free/demo badge.

visibility.levels?

optional levels?: boolean;

The floor selector.

visibility.overlay?

optional overlay?: boolean;

The overlay panel — search, lists, entity details.

visibility.searchButtons?

optional searchButtons?: boolean;

The search-filter buttons row. Omitted, it follows overlay; an explicit true keeps the buttons while the overlay is hidden — clicking one opens the overlay on demand (?visibility[overlay]=false&visibility[searchButtons]=true).