Interface MapViewRef

Hierarchy

MapViewRef

Index

Properties

cancelNavigation followUser navigateToCar navigateToPoi navigateToPoint search selectCar selectFloor selectPoi selectPoiCategory setDirectionsOptions setFavoritePois setOnDirectionsRequestInterceptor unfollowUser

Properties

cancelNavigation

cancelNavigation: (() => void)

Type declaration

- (): void
- Cancels the current navigation, if any.
  
  Returns void

followUser

followUser: (() => void)

Type declaration

- (): void
- Focuses camera on user's current position locking it till user moves it
  
  Returns void

navigateToCar

navigateToCar: ((params?) => void)

Type declaration

- (params?): void
- Starts navigating to a point saved as find my car.
  Parameters
  - Optional params: NavigateToCarPayload
  Returns void

navigateToPoi

navigateToPoi: ((params) => void)

Type declaration

- (params): void
- Starts navigating to the given POI.
  Parameters
  - params: {
    accessibilityMode?: AccessibilityMode;
    identifier: number;
    }
    - Optional accessibilityMode?: AccessibilityMode
      
      You can optionally choose the desired AccessibilityMode used to calculate the route.
    - identifier: number
      
      You can obtain the identifiers of your POIs by retrieving them with SitumPlugin.fetchIndoorPOIsFromBuilding().
  Returns void

navigateToPoint

navigateToPoint: ((params) => void)

Type declaration

- (params): void
- Starts navigating to the given coordinates, at the given floor.
  Parameters
  - params: {
        accessibilityMode?: AccessibilityMode;
        floorIdentifier: string;
        lat: number;
        lng: number;
        navigationName?: string;
    }
    - Optional accessibilityMode?: AccessibilityMode
      
      You can optionally choose the desired AccessibilityMode used to calculate the route.
    - floorIdentifier: string
      
      The floorIndetifier of the destination point.
    - lat: number
      
      The latitude of the destination point.
    - lng: number
      
      The longitude of the destination point.
    - Optional navigationName?: string
      
      You can optionally set the name of the destination to be displayed on the MapView.
  Returns void

search

search: ((searchFilter) => void)

Type declaration

- (searchFilter): void
- Performs a search with the given SearchFilter.
  
  This action will have the same effect as the user searching in the searchbar.
  Parameters
  - searchFilter: SearchFilter
  Returns void

selectCar

selectCar: (() => void)

Type declaration

- (): void
- Selects a point saved as Find My Car on the map.
  
  To use it, the feature 'Find My Car' must be enabled.
  
  Returns void

selectFloor

selectFloor: ((floorIdentifier, options?) => void)

Type declaration

- (floorIdentifier, options?): void
- Selects the given floor by its ID and optionally fit the ViewPort to floor.
  Parameters
  - floorIdentifier: number
    
    Floor identifier [SitumPlugin.fetchFloorsFromBuilding()](https://developers.situm.com/sdk_documentation/react-native/typedoc/classes/fetchFloorsFromBuilding.html.
  - Optional options: CartographySelectionOptions
    
    Optional parameter that indicates the viewer to modify the selection behaviour like fitting the camera to the cartograpgic element selected.
  Returns void

selectPoi

selectPoi: ((poiId) => void)

Type declaration

- (poiId): void
- Selects the given POI in the map.
  Parameters
  - poiId: number
    
    You can obtain the identifiers of your POIs by retrieving them with SitumPlugin.fetchIndoorPOIsFromBuilding().
  Returns void

selectPoiCategory

selectPoiCategory: ((categoryId) => void)

Type declaration

- (categoryId): void
- Selects the given POI category and displays the list of POIs that belong to the given category. Also, the POIs that do not belong to this category will be hidden in the map.
  Parameters
  - categoryId: number
    
    You can obtain the identifiers of your POI categories by retrieving them with SitumPlugin.fetchPoiCategories().
  Returns void

setDirectionsOptions

setDirectionsOptions: ((directionsOptions) => void)

Type declaration

- (directionsOptions): void
- Define the MapViewDirectionsOptions that the routes calculated by the MapView will use.
  Parameters
  - directionsOptions: MapViewDirectionsOptions
    
    MapViewDirectionsOptions
  Returns void

setFavoritePois

setFavoritePois: ((poiIds) => void)

Type declaration

- (poiIds): void
- Sets the list of favoritePois that will appear in the mapView. This method removes any previous pois from the favorite list.
  Parameters
  - poiIds: number[]
    
    Ids of the pois you want to set as favorites. You can obtain the identifiers of your POIs by retrieving them with SitumPlugin.fetchIndoorPOIsFromBuilding().
  Returns void

setOnDirectionsRequestInterceptor

setOnDirectionsRequestInterceptor: ((params) => void)

Type declaration

- (params): void
- Parameters
  - params: {
    onDirectionsRequestInterceptor: OnDirectionsRequestInterceptor;
    }
    - onDirectionsRequestInterceptor: OnDirectionsRequestInterceptor
  Returns void

unfollowUser

unfollowUser: (() => void)

Type declaration

- (): void
- Stops focusing camera on user's current position
  
  Returns void

Interface MapViewRef

Hierarchy

Index

Properties

Properties

cancelNavigation

Type declaration

Returns void

followUser

Type declaration

Returns void

navigateToCar

Type declaration

Parameters

Optional params: NavigateToCarPayload

Returns void

navigateToPoi

Type declaration

Parameters

params: { accessibilityMode?: AccessibilityMode; identifier: number; }

Optional accessibilityMode?: AccessibilityMode

identifier: number

Returns void

navigateToPoint

Type declaration

Parameters

params: { accessibilityMode?: AccessibilityMode; floorIdentifier: string; lat: number; lng: number; navigationName?: string; }

Optional accessibilityMode?: AccessibilityMode

floorIdentifier: string

lat: number

lng: number

Optional navigationName?: string

Returns void

search

Type declaration

Parameters

searchFilter: SearchFilter

Returns void

selectCar

Type declaration

Returns void

selectFloor

Type declaration

Parameters

floorIdentifier: number

Optional options: CartographySelectionOptions

Returns void

selectPoi

Type declaration

Parameters

poiId: number

Returns void

selectPoiCategory

Type declaration

Parameters

categoryId: number

Returns void

setDirectionsOptions

Type declaration

Parameters

directionsOptions: MapViewDirectionsOptions

Returns void

setFavoritePois

Type declaration

Parameters

poiIds: number[]

Returns void

setOnDirectionsRequestInterceptor

Type declaration

Parameters

params: { onDirectionsRequestInterceptor: OnDirectionsRequestInterceptor; }

onDirectionsRequestInterceptor: OnDirectionsRequestInterceptor

Returns void

unfollowUser

Type declaration

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` params: NavigateToCarPayload

params: {
accessibilityMode?: AccessibilityMode;
identifier: number;
}

`Optional` accessibilityMode?: AccessibilityMode

params: {
accessibilityMode?: AccessibilityMode;
floorIdentifier: string;
lat: number;
lng: number;
navigationName?: string;
}

`Optional` accessibilityMode?: AccessibilityMode

`Optional` navigationName?: string

`Optional` options: CartographySelectionOptions

params: {
onDirectionsRequestInterceptor: OnDirectionsRequestInterceptor;
}