Interface: ExpofpViewMethods
Defined in: types.ts:175
Main ExpoFP ReactNative SDK interface. Provides methods to interact with the ExpoFP view.
Properties
activateFloor()
activateFloor: (
floor) =>void
Defined in: types.ts:201
Activates a specific floor.
Parameters
floor
The floor to activate.
Returns
void
boothsList()
boothsList: () =>
Promise<ExpoFpBooth[]>
Defined in: types.ts:329
Gets the list of booths.
Returns
Promise<ExpoFpBooth[]>
A promise that resolves with an array of booths.
categoriesList()
categoriesList: () =>
Promise<ExpoFpCategory[]>
Defined in: types.ts:334
Gets the list of categories.
Returns
Promise<ExpoFpCategory[]>
A promise that resolves with an array of categories.
changeLanguage()
changeLanguage: (
language) =>void
Defined in: types.ts:206
Changes the plan language.
Parameters
language
The language code to set (e.g., 'en', 'de', 'fr', 'es', 'zh').
Returns
void
deselectCurrentPosition()
deselectCurrentPosition: () =>
void
Defined in: types.ts:258
Deselects the current position.
Returns
void
deselectRoute()
deselectRoute: () =>
void
Defined in: types.ts:286
Deselects the current route.
Returns
void
evaluateCustomScript()
evaluateCustomScript: (
script) =>Promise<unknown>
Defined in: types.ts:385
Executes a custom JavaScript script on the plan for debugging purposes.
Parameters
script
string
The JavaScript code to evaluate.
Returns
Promise<unknown>
A promise that resolves with the script result.
exhibitorsList()
exhibitorsList: () =>
Promise<ExpoFpExhibitor[]>
Defined in: types.ts:339
Gets the list of exhibitors.
Returns
Promise<ExpoFpExhibitor[]>
A promise that resolves with an array of exhibitors.
findLocation()
findLocation: () =>
void
Defined in: types.ts:210
Finds the current location on the map.
Returns
void
fitBounds()
fitBounds: (
bounds?,options?) =>void
Defined in: types.ts:216
Fits the map bounds to show the entire plan.
Parameters
bounds?
Optional bounds to fit to. If not provided, fits to the entire plan.
ExpoFpBounds | null
options?
Optional zoom options (e.g., padding).
ExpoFpZoomToOptions | null
Returns
void
getBounds()
getBounds: (
selectors) =>Promise<ExpoFpBounds>
Defined in: types.ts:360
Gets the bounding box for specific booths and/or exhibitors.
Parameters
selectors
The POI selectors to get bounds for.
Returns
Promise<ExpoFpBounds>
A promise that resolves with the bounding box.
getElementsVisibility()
getElementsVisibility: () =>
Promise<ExpoFpElementsVisibility>
Defined in: types.ts:344
Gets the current visibility of map elements.
Returns
Promise<ExpoFpElementsVisibility>
A promise that resolves with the current visibility settings.
getFloors()
getFloors: () =>
Promise<ExpoFpFloor[]>
Defined in: types.ts:349
Gets the list of floors.
Returns
Promise<ExpoFpFloor[]>
A promise that resolves with an array of floors.
getGeoConfig()
getGeoConfig: () =>
Promise<ExpoFpGeoConfig|null>
Defined in: types.ts:354
Gets the geographic configuration of the loaded plan.
Returns
Promise<ExpoFpGeoConfig | null>
A promise that resolves with the geo config, or null if the plan has no GPS configuration.
getOptimizedRoutes()
getOptimizedRoutes: (
waypoints) =>Promise<ExpoFpRouteInfo[]>
Defined in: types.ts:366
Gets optimized routes through the given waypoints.
Parameters
waypoints
(string | ExpoFpPosition)[]
The waypoints for the route.
Returns
Promise<ExpoFpRouteInfo[]>
A promise that resolves with an array of route info.
getSettings()
getSettings: () =>
Promise<Partial<ExpofpViewSettings>>
Defined in: types.ts:180
Gets the current settings of the view.
Returns
Promise<Partial<ExpofpViewSettings>>
A promise that resolves with the current settings.
highlightBooths()
highlightBooths: (
externalIds?) =>void
Defined in: types.ts:224
Highlights specific booths.
Parameters
externalIds?
string[]
The external IDs of the booths to highlight.
Returns
void
highlightEntities()
highlightEntities: (
externalIds?) =>void
Defined in: types.ts:229
Highlights specific booths and exhibitors together.
Parameters
externalIds?
string[]
The external IDs of the entities to highlight.
Returns
void
highlightExhibitors()
highlightExhibitors: (
externalIds?) =>void
Defined in: types.ts:234
Highlights specific exhibitors.
Parameters
externalIds?
string[]
The external IDs of the exhibitors to highlight.
Returns
void
isBuiltInGpsTrackingEnabled()
isBuiltInGpsTrackingEnabled: () =>
Promise<boolean>
Defined in: types.ts:373
Checks if built-in GPS tracking is enabled.
Returns
Promise<boolean>
A promise that resolves with the GPS tracking state.
reloadPlan()
reloadPlan: (
settings?) =>void
Defined in: types.ts:196
Reloads the plan with optional new settings.
Parameters
settings?
Optional new settings to apply.
Partial<ExpofpViewSettings> | null
Returns
void
removeSavedParams()
removeSavedParams: (
keys) =>void
Defined in: types.ts:191
Removes saved parameters.
Parameters
keys
string[]
The keys of the parameters to remove.
Returns
void
reset()
reset: () =>
void
Defined in: types.ts:238
Resets the plan to its original state.
Returns
void
searchText()
searchText: (
text) =>Promise<ExpoFpSearch[]>
Defined in: types.ts:379
Searches for text within the map data.
Parameters
text
string
The text to search for.
Returns
Promise<ExpoFpSearch[]>
A promise that resolves with an array of search results.
selectAccessibleRoute()
selectAccessibleRoute: (
waypoints) =>void
Defined in: types.ts:268
Selects a route through the given waypoints, restricted to accessible segments only.
Parameters
waypoints
(string | ExpoFpPosition)[]
The waypoints for the route.
Returns
void
selectBooth()
selectBooth: (
nameOrExternalId?) =>void
Defined in: types.ts:243
Selects a booth by name or external ID.
Parameters
nameOrExternalId?
string
The name or external ID of the booth to select.
Returns
void
selectCategory()
selectCategory: (
name?) =>void
Defined in: types.ts:248
Selects a category by name.
Parameters
name?
The name of the category to select.
string | null
Returns
void
selectCurrentPosition()
selectCurrentPosition: (
position,focus?) =>void
Defined in: types.ts:254
Selects the current position.
Parameters
position
The position to select.
focus?
boolean
Whether to focus on the position.
Returns
void
selectExhibitor()
selectExhibitor: (
nameOrExternalId?) =>void
Defined in: types.ts:263
Selects an exhibitor by name or external ID.
Parameters
nameOrExternalId?
string
The name or external ID of the exhibitor to select.
Returns
void
selectRoute()
selectRoute: (
waypoints) =>void
Defined in: types.ts:273
Selects a route through the given waypoints.
Parameters
waypoints
(string | ExpoFpPosition)[]
The waypoints for the route.
Returns
void
selectRouteFromTo()
selectRouteFromTo: (
from?,to?) =>void
Defined in: types.ts:279
Selects a route from a start point to a destination.
Parameters
from?
The starting waypoint (position or booth name). Pass null to omit.
string | ExpoFpPosition | null
to?
The destination waypoint (position or booth name). Pass null to omit.
string | ExpoFpPosition | null
Returns
void
setBookmarks()
setBookmarks: (
bookmarks) =>void
Defined in: types.ts:291
Sets the bookmarks on the map.
Parameters
bookmarks
The bookmarks to set.
Returns
void
setBuiltInGpsTrackingEnabled()
setBuiltInGpsTrackingEnabled: (
isEnabled) =>void
Defined in: types.ts:303
Enables or disables built-in GPS tracking.
Parameters
isEnabled
boolean
Whether to enable GPS tracking.
Returns
void
setElementsVisibility()
setElementsVisibility: (
elementsVisibility) =>void
Defined in: types.ts:296
Sets the visibility of map elements.
Parameters
elementsVisibility
Partial<ExpoFpElementsVisibility>
The visibility settings to apply.
Returns
void
setParams()
setParams: (
params,isSaved?) =>void
Defined in: types.ts:186
Sets parameters for the view.
Parameters
params
Record<string, string | null>
The parameters to set.
isSaved?
boolean
Whether the parameters should be saved.
Returns
void
switchView()
switchView: () =>
void
Defined in: types.ts:307
Switches the view mode (e.g., 2D/3D).
Returns
void
zoomIn()
zoomIn: () =>
void
Defined in: types.ts:311
Zooms in on the map.
Returns
void
zoomOut()
zoomOut: () =>
void
Defined in: types.ts:315
Zooms out on the map.
Returns
void
zoomTo()
zoomTo: (
selectors,options?) =>void
Defined in: types.ts:321
Zooms to specific booths and/or exhibitors.
Parameters
selectors
The POI selectors to zoom to.
options?
Optional zoom options (e.g., padding).
ExpoFpZoomToOptions | null
Returns
void