@situm/react-native
    Preparing search index...

    Interface InternalMapViewRefInternal

    For internal use only.

    interface InternalMapViewRef {
        cancelNavigation: () => void;
        deselectPoi: () => void;
        followUser: () => void;
        navigateToCar: (params?: NavigateToCarPayload) => void;
        navigateToPoi: (
            params: { accessibilityMode?: AccessibilityMode; identifier: number },
        ) => void;
        navigateToPoint: (
            params: {
                accessibilityMode?: AccessibilityMode;
                floorIdentifier: string;
                lat: number;
                lng: number;
                navigationName?: string;
            },
        ) => void;
        onInternalMapViewMessageCallback: (
            delegate: OnInternalMapViewMessageCallback,
        ) => void;
        search: (searchFilter: SearchFilter) => void;
        selectCar: () => void;
        selectFloor: (
            floorIdentifier: number,
            options?: CartographySelectionOptions,
        ) => void;
        selectPoi: (poiId: number) => void;
        selectPoiCategory: (categoryId: number) => void;
        setDirectionsOptions: (directionsOptions: MapViewDirectionsOptions) => void;
        setFavoritePois: (poiIds: number[]) => void;
        setOnDirectionsRequestInterceptor: (
            params: {
                onDirectionsRequestInterceptor: OnDirectionsRequestInterceptor;
            },
        ) => void;
        setShareLiveLocationSession: (
            params: ShareLiveLocationSessionPayload,
        ) => void;
        unfollowUser: () => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    cancelNavigation: () => void

    Cancels the current navigation, if any.

    deselectPoi: () => void

    Deselects any selected POI in the MapView's UI.

    followUser: () => void

    Focuses camera on user's current position locking it till user moves it

    navigateToCar: (params?: NavigateToCarPayload) => void

    Starts navigating to a point saved as find my car.

    navigateToPoi: (
        params: { accessibilityMode?: AccessibilityMode; identifier: number },
    ) => void

    Starts navigating to the given POI.

    navigateToPoint: (
        params: {
            accessibilityMode?: AccessibilityMode;
            floorIdentifier: string;
            lat: number;
            lng: number;
            navigationName?: string;
        },
    ) => void

    Starts navigating to the given coordinates, at the given floor.

    onInternalMapViewMessageCallback: (
        delegate: OnInternalMapViewMessageCallback,
    ) => void

    Internal callback invoked with every MapView message.

    search: (searchFilter: SearchFilter) => void

    Performs a search with the given SearchFilter.

    This action will have the same effect as the user searching in the searchbar.

    selectCar: () => void

    Selects a point saved as Find My Car on the map.

    To use it, the feature 'Find My Car' must be enabled.

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

    Selects the given floor by its ID and optionally fit the ViewPort to floor.

    Type declaration

    selectPoi: (poiId: number) => void

    Selects the given POI in the map.

    Type declaration

    selectPoiCategory: (categoryId: number) => 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.

    Type declaration

      • (categoryId: number): void

      • Parameters

        Returns void

    setDirectionsOptions: (directionsOptions: MapViewDirectionsOptions) => void

    Define the MapViewDirectionsOptions that the routes calculated by the MapView will use.

    Type declaration

    setFavoritePois: (poiIds: number[]) => void

    Sets the list of favoritePois that will appear in the mapView. This method removes any previous pois from the favorite list.

    Type declaration

      • (poiIds: number[]): void

      • Parameters

        Returns void

    setOnDirectionsRequestInterceptor: (
        params: {
            onDirectionsRequestInterceptor: OnDirectionsRequestInterceptor;
        },
    ) => void
    setShareLiveLocationSession: (params: ShareLiveLocationSessionPayload) => void

    Sets the live location sharing session to be displayed on the mapView.

    When enabled in the Map Viewer Configuration Settings, Share Live Location allows a user to share their real-time location with another user.

    The sharing user receives a link that can be sent to their friends. If deep linking is correctly configured, the receiving user can open the link and see the shared location in their own app.

    The deep link includes a parameter called shared_session_id, which must be passed to this method so the mapView can display the sender’s location.

    For more information check Situm Documentation

    unfollowUser: () => void

    Stops focusing camera on user's current position

    Settings

    Member Visibility

    On This Page

    Properties