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

    Type Alias NavigationProgress

    Provides information of the progress of a user while following a route.

    type NavigationProgress = {
        closestLocationInRoute: Location;
        currentIndication: number;
        currentStepIndex: number;
        distanceToClosestPointInRoute: number;
        distanceToEndStep: number;
        distanceToGoal: number;
        nextIndication: Indication;
        points: Point[];
        routeStep: RouteStep;
        segments: RouteSegment[];
        timeToEndStep: number;
        timeToGoal: number;
        type: SdkNavigationUpdateType;
    }
    Index

    Properties

    closestLocationInRoute currentIndication currentStepIndex distanceToClosestPointInRoute distanceToEndStep distanceToGoal nextIndication points routeStep segments timeToEndStep timeToGoal type

    Properties

    closestLocationInRoute: Location

    Closest location in the route from the user location provided

    currentIndication: number

    The current indication

    currentStepIndex: number

    The index of the closest route step to the user, where closestLocationInRoute is

    distanceToClosestPointInRoute: number

    Distance between the real user location (provided to updateWithLocation(Location)) and the closest route location

    distanceToEndStep: number

    The distance in meters to go from closestLocationInRoute to the end of the current step

    distanceToGoal: number

    The distance in meters from closestLocationInRoute to route's goal point

    nextIndication: Indication

    The next indication

    points: Point[]

    List of ordered points of the remaining route

    routeStep: RouteStep

    The closest route step to the user, where closestLocationInRoute is

    segments: RouteSegment[]

    List of segments formed by consecutive points and a floor identifier

    timeToEndStep: number

    The estimated time to go from closestLocationInRoute to the end of the current route step, considering a speed of 1 meter/second

    timeToGoal: number

    The estimated time to go from closestLocationInRoute to the goal/end of route, considering a speed of 1 meter/second

    type: SdkNavigationUpdateType

    Settings

    Member Visibility

    On This Page

    Properties