Skip to content

@expofp/floorplan / FloorPlanOptions

Interface: FloorPlanOptions

Options for configuring the FloorPlan instance.

Properties

allowConsent?

ts
optional allowConsent?: boolean;

dataUrl?

ts
optional dataUrl?: string;

disableRuntimeAlerts?

ts
optional disableRuntimeAlerts?: boolean;

element?

ts
optional element?: HTMLDivElement;

event?

ts
optional event?: string;

Deprecated

Use 'expo' instead.


expo?

ts
optional expo?: string;

ignoreQuery?

ts
optional ignoreQuery?: boolean;

legacyDataUrlBase?

ts
optional legacyDataUrlBase?: string;

Deprecated


legacyDataVersion?

ts
optional legacyDataVersion?: object;

version

ts
version: string;

Deprecated


maplibre?

ts
optional maplibre?: MaplibreOptions;

noOverlay?

ts
optional noOverlay?: boolean;

offHistory?

ts
optional offHistory?: boolean;

onBookmarkClick?

ts
optional onBookmarkClick?: (e) => void;

Parameters

e

FloorPlanBookmarkClickEvent

Returns

void


onBoothClick?

ts
optional onBoothClick?: (e) => void;

Parameters

e

FloorPlanBoothClickEvent

Returns

void


onCategoryClick?

ts
optional onCategoryClick?: (e) => void;

Parameters

e

FloorPlanCategory

Returns

void


onCurrentPositionChanged?

ts
optional onCurrentPositionChanged?: (point) => void;

Parameters

point

CurrentPosition

Returns

void


onDetails?

ts
optional onDetails?: (e) => void;

Parameters

e

FloorPlanDetailsEvent

Returns

void


onDirection?

ts
optional onDirection?: (e) => void;

Parameters

e

FloorPlanDirectionEvent

Returns

void


onExhibitorCustomButtonClick?

ts
optional onExhibitorCustomButtonClick?: (e) => void;

Parameters

e

FloorPlanCustomButtonEvent

Returns

void


onFloorActivated?

ts
optional onFloorActivated?: (floor) => void;

Parameters

floor

Floor

Returns

void


onFpConfigured?

ts
optional onFpConfigured?: () => void;

Returns

void

Deprecated

The onFpConfigured method is deprecated. Use onInit instead.


onGetCoordsClick?

ts
optional onGetCoordsClick?: (e) => void;

Parameters

e

FloorPlanGetCoordsEvent

Returns

void


onInit?

ts
optional onInit?: (fp) => void;

Parameters

fp

FloorPlan

Returns

void


onLeaveEvent?

ts
optional onLeaveEvent?: () => void;

Returns

void


onMarkerClick?

ts
optional onMarkerClick?: (e) => void;

Parameters

e

FloorPlanMarkerEvent | undefined

Returns

void


onVisitedClick?

ts
optional onVisitedClick?: (e) => void;

Parameters

e

FloorPlanVisitedClickEvent

Returns

void


previewMode?

ts
optional previewMode?: boolean;

viewerMode?

ts
optional viewerMode?: boolean;