Documentation / @expofp/floorplan / FloorPlan

Interface: FloorPlan

Represents a floor plan.

Properties

allowConsent

readonly allowConsent: boolean | undefined;

Deprecated

The consent decision lives on the config — set the consent option instead. true ⇄ 'granted', false ⇄ 'denied', undefined ⇄ 'ask'.

---

element

readonly element: HTMLDivElement;

---

eventId

readonly eventId: string;

---

noOverlay

readonly noOverlay: boolean;

---

offHistory

readonly offHistory: boolean;

---

onInit

readonly onInit: (fp) => void;

Parameters

fp

FloorPlan

Returns

void

---

onLeaveEvent?

optional onLeaveEvent?: () => void;

Returns

void

---

ready

readonly ready: Promise<void>;

Resolves once the plan has mounted and its API is live.

Rejects if destroy is called first: the initialization it was waiting on has been cancelled, so awaiting it any longer would never return. Await it inside the same chain that owns the teardown, or attach a catch — an unhandled rejection here is a destroyed plan, not a failure to load.

Methods

activateFloor()

activateFloor(floorId): void;

Parameters

floorId

index?

number

name?

string

Returns

void

---

applyParameters()

applyParameters(queryRaw): void;

Parameters

queryRaw

string

Returns

void

---

boothsList()

boothsList(): FloorPlanBooth[];

Returns

FloorPlanBooth[]

---

categoriesList()

categoriesList(): FloorPlanCategory[];

Returns

FloorPlanCategory[]

---

changeLanguage()

changeLanguage(langId): void;

Parameters

langId

string

Returns

void

---

convertToGeo()

convertToGeo(x, y): [number, number];

Parameters

x

number

y

number

Returns

[number, number]

---

deselectCurrentPosition()

deselectCurrentPosition(): void;

Returns

void

---

deselectRoute()

deselectRoute(): void;

Returns

void

---

destroy()

destroy(): void;

Tears the floor plan down: unmounts the UI, drops the window listeners, analytics, URL sync and map resources it installed, and empties the container element — the element itself is left in the document, ready to be passed to a new load call.

Safe at any point in the lifecycle: calling it before ready resolves cancels the pending initialization instead of throwing, so a single-page app can unmount a route while the plan is still loading. That cancellation rejects ready rather than leaving it pending forever. Calling it more than once does nothing after the first.

The instance is spent once destroyed — call load again for a new plan rather than reusing it.

Returns

void

---

exhibitorsList()

exhibitorsList(): FloorPlanExhibitor[];

Returns

FloorPlanExhibitor[]

---

findLocation()

findLocation(): void;

Returns

void

---

fitBounds()

Call Signature

fitBounds(): void;

Returns

void

Call Signature

fitBounds(bounds, options?): void;

Parameters

bounds

Bounds

options?

padding?

number

Returns

void

---

getBoothRect()

getBoothRect(name): Rect;

Parameters

name

string

Returns

Rect

---

getBounds()

getBounds(selectors): Bounds | undefined;

Parameters

selectors

POISelectors

Returns

Bounds | undefined

---

getCamera()

getCamera(): Camera;

The camera state last requested via setCamera (or the equivalent URL parameters) — not a live gesture-tracking camera: panning or zooming by hand does not update it.

Returns

Camera

---

getCenterCoordinates()

getCenterCoordinates(): FloorPlanGetCoordsEvent;

Returns

FloorPlanGetCoordsEvent

---

getFloors()

getFloors(): Floor[];

Returns

Floor[]

---

getGeoConfig()

getGeoConfig(): GeoConfig | null;

Returns

GeoConfig | null

---

getOptimizedRoutes()

getOptimizedRoutes(waypoints): RouteInfo[];

Parameters

waypoints

RouteWaypoint[]

Returns

RouteInfo[]

---

getVisibility()

getVisibility(): Visibility;

Returns

Visibility

---

hidePathways()

hidePathways(): void;

Returns

void

---

highlightBooths()

highlightBooths(externalIds): void;

Parameters

externalIds

string[]

Returns

void

---

highlightExhibitors()

highlightExhibitors(externalIds): void;

Parameters

externalIds

string[]

Returns

void

---

isGpsTrackingEnabled()

isGpsTrackingEnabled(): boolean;

Returns

boolean

---

onBookmarkClick()

onBookmarkClick(e): void;

Parameters

e

FloorPlanBookmarkClickEvent

Returns

void

---

onBoothClick()

onBoothClick(e): void;

Parameters

e

FloorPlanBoothClickEvent

Returns

void

---

onCategoryClick()

onCategoryClick(e): void;

Parameters

e

FloorPlanCategory

Returns

void

---

onCurrentPositionChanged()

onCurrentPositionChanged(point): void;

Parameters

point

CurrentPosition

Returns

void

---

onDetails()

onDetails(e): void;

Parameters

e

FloorPlanDetailsEvent

Returns

void

---

onDirection()

onDirection(e): void;

Parameters

e

FloorPlanDirectionEvent | null

Returns

void

---

onExhibitorCustomButtonClick()

onExhibitorCustomButtonClick(e): void;

Parameters

e

FloorPlanCustomButtonEvent

Returns

void

---

onFloorActivated()

onFloorActivated(floor): void;

Parameters

floor

Floor

Returns

void

---

onFpConfigured()

onFpConfigured(): void;

Returns

void

Deprecated

The onFpConfigured method is deprecated. Use onInit instead.

---

onGetCoordsClick()

onGetCoordsClick(e): void;

Parameters

e

FloorPlanGetCoordsEvent

Returns

void

---

onMarkerClick()

onMarkerClick(e): void;

Parameters

e

FloorPlanMarkerEvent

Returns

void

---

onVisitedClick()

onVisitedClick(e): void;

Parameters

e

FloorPlanVisitedClickEvent

Returns

void

---

openPlanner()

openPlanner(options?): void;

Opens the route planner, optionally pre-filled with slugs or the visitor's bookmarks.

Parameters

options?

from?

string

fromBookmarks?

boolean

items?

string[]

Returns

void

---

reset()

reset(): void;

Returns

void

---

search()

search(term): Promise<object[]>;

Parameters

term

string

Returns

Promise<object[]>

---

select()

select(slugOrExternalId): void;

Opens whatever the slug or external id names — a booth, a schedule session, an exhibitor, a category or a speaker (checked in that order); anything else opens the search list with the value as the search text. The programmatic twin of the ?<slug> deep link.

Parameters

slugOrExternalId

string

Returns

void

---

selectAccessibleRoute()

selectAccessibleRoute(waypoints): void;

Same as selectRoute, but restricts the path to accessible segments only.

Parameters

waypoints

RouteWaypoint[]

Ordered route stops (booth name/ID or CurrentPosition).

Returns

void

---

selectBooth()

selectBooth(nameOrExternalId): void;

Parameters

nameOrExternalId

string

Returns

void

---

selectCategory()

selectCategory(nameOrSlug?): void;

Parameters

nameOrSlug?

string

Returns

void

---

selectCurrentPosition()

selectCurrentPosition(
   point, 
   focus, 
   icon?): void;

Parameters

point

CurrentPosition

focus

boolean

icon?

number

Returns

void

---

selectExhibitor()

selectExhibitor(nameOrExternalId): void;

Parameters

nameOrExternalId

string

Returns

void

---

selectRoute()

Call Signature

selectRoute(from, to): void;

Parameters

from

RouteWaypoint

to

RouteWaypoint

Returns

void

Call Signature

selectRoute(waypoints): void;

Parameters

waypoints

RouteWaypoint[]

Returns

void

---

selectTour()

selectTour(tourId): void;

Launches the tour with the given id; unknown ids fall back to the tours list.

Parameters

tourId

string

Returns

void

---

setBookmarks()

setBookmarks(bookmarks): void;

Parameters

bookmarks

object[]

Returns

void

---

setCamera()

setCamera(camera): void;

Moves the camera. Partial-merge semantics: only the fields present in camera change, omitted ones keep their current values — e.g. setCamera({ bearing: 90 }) rotates the map without moving its center. The center is set either as floor-plan projected coordinates (x/y) or as GPS (lat/lng) — each is a pair, so both halves must be given. floor activates the named floor, bearing rotates the map (0–360°) and zoomTime sets the camera animation duration in milliseconds. Applied as soon as the renderer is ready. Also available as the setCamera intent (URL deep link).

Parameters

camera

Camera

Returns

void

---

setEntitiesBookmarks()

setEntitiesBookmarks(bookmarks): void;

Parameters

bookmarks

object[]

Returns

void

---

setEntitiesVisited()

setEntitiesVisited(entities): void;

Parameters

entities

object[]

Returns

void

---

setGpsTrackingEnabled()

setGpsTrackingEnabled(value): void;

Parameters

value

boolean

Returns

void

---

setMarkers()

setMarkers(markersData): void;

Parameters

markersData

MarkersData

Returns

void

---

setVisibility()

setVisibility(visibility): void;

Parameters

visibility

Visibility

Returns

void

---

showList()

showList(list): void;

Opens one of the named list panels (the ?bookmarks, ?sessions, … deep links).

Parameters

list

| "language" | "exhibitors" | "bookmarks" | "sessions" | "speakers" | "tours" | "visited"

Returns

void

---

showPathway()

showPathway(pathwayId, externalIds): void;

Parameters

pathwayId

string

externalIds

string[]

Returns

void

---

showPathwayOnly()

showPathwayOnly(pathwayId, floorId): void;

Parameters

pathwayId

string

floorId

string

Returns

void

---

showSearch()

showSearch(): void;

Returns

void

---

startBuildRoute()

startBuildRoute(): void;

Enters the interactive route-building mode.

Returns

void

---

switchView()

switchView(): void;

Returns

void

---

unstable_destroy()

unstable_destroy(): void;

Returns

void

Deprecated

Renamed to destroy, which carries the same behaviour plus a stable contract. This alias will be removed in a future major.

---

updateLayerVisibility()

updateLayerVisibility(layer, visible): void;

Parameters

layer

string

visible

boolean

Returns

void

---

zoomIn()

zoomIn(): void;

Returns

void

---

zoomOut()

zoomOut(): void;

Returns

void

---

zoomTo()

zoomTo(selectors, options?): void;

Parameters

selectors

POISelectors

options?

padding?

number

Returns

void