ExpoFP JavaScript SDK

Appearance

@expofp/floorplan / FloorPlan

Interface: FloorPlan ​

Represents a floor plan.

Properties ​

allowConsent ​

ts
readonly allowConsent: boolean;

dataUrl ​

ts
readonly dataUrl: string;

element ​

ts
readonly element: HTMLDivElement;

eventId ​

ts
readonly eventId: string;

noOverlay ​

ts
readonly noOverlay: boolean;

offHistory ​

ts
readonly offHistory: boolean;

onInit ​

ts
readonly onInit: (fp) => void;

Parameters ​

fp ​

FloorPlan

Returns ​

void

ready ​

ts
readonly ready: Promise<void>;

Methods ​

activateFloor() ​

ts
activateFloor(floorId): void;

Parameters ​

floorId ​
index? ​

number

name? ​

string

Returns ​

void

applyParameters() ​

ts
applyParameters(queryRaw): void;

Parameters ​

queryRaw ​

string

Returns ​

void

boothsList() ​

ts
boothsList(): FloorPlanBooth[];

Returns ​

FloorPlanBooth[]

categoriesList() ​

ts
categoriesList(): FloorPlanCategory[];

Returns ​

FloorPlanCategory[]

changeLanguage() ​

ts
changeLanguage(langId): void;

Parameters ​

langId ​

string

Returns ​

void

convertToGeo() ​

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

Parameters ​

x ​

number

y ​

number

Returns ​

[number, number]

deselectCurrentPosition() ​

ts
deselectCurrentPosition(): void;

Returns ​

void

deselectRoute() ​

ts
deselectRoute(): void;

Returns ​

void

exhibitorsList() ​

ts
exhibitorsList(): FloorPlanExhibitor[];

Returns ​

FloorPlanExhibitor[]

findLocation() ​

ts
findLocation(): void;

Returns ​

void

fitBounds() ​

Call Signature ​

ts
fitBounds(): void;
Returns ​

void

Call Signature ​

ts
fitBounds(bounds, options?): void;
Parameters ​
bounds ​

Bounds

options? ​
padding? ​

number

Returns ​

void

getBoothRect() ​

ts
getBoothRect(name): Rect;

Parameters ​

name ​

string

Returns ​

Rect

getBounds() ​

ts
getBounds(selectors): Bounds | undefined;

Parameters ​

selectors ​

POISelectors

Returns ​

Bounds | undefined

getCenterCoordinates() ​

ts
getCenterCoordinates(): FloorPlanGetCoordsEvent;

Returns ​

FloorPlanGetCoordsEvent

getFloors() ​

ts
getFloors(): Floor[];

Returns ​

Floor[]

getGeoConfig() ​

ts
getGeoConfig(): GeoConfig | null;

Returns ​

GeoConfig | null

getOptimizedRoutes() ​

ts
getOptimizedRoutes(waypoints): RouteInfo[];

Parameters ​

waypoints ​

RouteWaypoint[]

Returns ​

RouteInfo[]

getVisibility() ​

ts
getVisibility(): Visibility;

Returns ​

Visibility

hidePathways() ​

ts
hidePathways(): void;

Returns ​

void

highlightBooths() ​

ts
highlightBooths(externalIds): void;

Parameters ​

externalIds ​

string[]

Returns ​

void

highlightExhibitors() ​

ts
highlightExhibitors(externalIds): void;

Parameters ​

externalIds ​

string[]

Returns ​

void

isGpsTrackingEnabled() ​

ts
isGpsTrackingEnabled(): boolean;

Returns ​

boolean

onBookmarkClick() ​

ts
onBookmarkClick(e): void;

Parameters ​

e ​

FloorPlanBookmarkClickEvent

Returns ​

void

onBoothClick() ​

ts
onBoothClick(e): void;

Parameters ​

e ​

FloorPlanBoothClickEvent

Returns ​

void

onCategoryClick() ​

ts
onCategoryClick(e): void;

Parameters ​

e ​

FloorPlanCategory

Returns ​

void

onCurrentPositionChanged() ​

ts
onCurrentPositionChanged(point): void;

Parameters ​

point ​

CurrentPosition

Returns ​

void

onDetails() ​

ts
onDetails(e): void;

Parameters ​

e ​

FloorPlanDetailsEvent

Returns ​

void

onDirection() ​

ts
onDirection(e): void;

Parameters ​

e ​

FloorPlanDirectionEvent

Returns ​

void

onExhibitorCustomButtonClick() ​

ts
onExhibitorCustomButtonClick(e): void;

Parameters ​

e ​

FloorPlanCustomButtonEvent

Returns ​

void

onFloorActivated() ​

ts
onFloorActivated(floor): void;

Parameters ​

floor ​

Floor

Returns ​

void

onFpConfigured() ​

ts
onFpConfigured(): void;

Returns ​

void

Deprecated ​

The onFpConfigured method is deprecated. Use onInit instead.

onGetCoordsClick() ​

ts
onGetCoordsClick(e): void;

Parameters ​

e ​

FloorPlanGetCoordsEvent

Returns ​

void

onLeaveEvent() ​

ts
onLeaveEvent(): void;

Returns ​

void

onMarkerClick() ​

ts
onMarkerClick(e): void;

Parameters ​

e ​

FloorPlanMarkerEvent

Returns ​

void

onVisitedClick() ​

ts
onVisitedClick(e): void;

Parameters ​

e ​

FloorPlanVisitedClickEvent

Returns ​

void

reset() ​

ts
reset(): void;

Returns ​

void

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

Parameters ​

term ​

string

Returns ​

Promise<object[]>

selectAccessibleRoute() ​

ts
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() ​

ts
selectBooth(nameOrExternalId): void;

Parameters ​

nameOrExternalId ​

string

Returns ​

void

selectCategory() ​

ts
selectCategory(nameOrSlug?): void;

Parameters ​

nameOrSlug? ​

string

Returns ​

void

selectCurrentPosition() ​

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

Parameters ​

point ​

CurrentPosition

focus ​

boolean

icon? ​

number

Returns ​

void

selectExhibitor() ​

ts
selectExhibitor(nameOrExternalId): void;

Parameters ​

nameOrExternalId ​

string

Returns ​

void

selectRoute() ​

Call Signature ​

ts
selectRoute(from, to): void;
Parameters ​
from ​

RouteWaypoint

to ​

RouteWaypoint

Returns ​

void

Call Signature ​

ts
selectRoute(waypoints): void;
Parameters ​
waypoints ​

RouteWaypoint[]

Returns ​

void

setBookmarks() ​

ts
setBookmarks(bookmarks): void;

Parameters ​

bookmarks ​

object[]

Returns ​

void

setEntitiesBookmarks() ​

ts
setEntitiesBookmarks(bookmarks): void;

Parameters ​

bookmarks ​

object[]

Returns ​

void

setEntitiesVisited() ​

ts
setEntitiesVisited(entities): void;

Parameters ​

entities ​

object[]

Returns ​

void

setGpsTrackingEnabled() ​

ts
setGpsTrackingEnabled(value): void;

Parameters ​

value ​

boolean

Returns ​

void

setMarkers() ​

ts
setMarkers(markersData): void;

Parameters ​

markersData ​

MarkersData

Returns ​

void

setVisibility() ​

ts
setVisibility(visibility): void;

Parameters ​

visibility ​

Visibility

Returns ​

void

showPathway() ​

ts
showPathway(pathwayId, externalIds): void;

Parameters ​

pathwayId ​

string

externalIds ​

string[]

Returns ​

void

showPathwayOnly() ​

ts
showPathwayOnly(pathwayId, floorId): void;

Parameters ​

pathwayId ​

string

floorId ​

string

Returns ​

void

showSearch() ​

ts
showSearch(): void;

Returns ​

void

switchView() ​

ts
switchView(): void;

Returns ​

void

unstable_destroy() ​

ts
unstable_destroy(): void;

Returns ​

void

updateLayerVisibility() ​

ts
updateLayerVisibility(layer, visible): void;

Parameters ​

layer ​

string

visible ​

boolean

Returns ​

void

zoomIn() ​

ts
zoomIn(): void;

Returns ​

void

zoomOut() ​

ts
zoomOut(): void;

Returns ​

void

zoomTo() ​

ts
zoomTo(selectors, options?): void;

Parameters ​

selectors ​

POISelectors

options? ​
padding? ​

number

Returns ​

void