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

    Type Alias RouteConfiguration

    Options that control how routes are calculated through the path network

    type RouteConfiguration = {
        attachEndpointsToAllowedPathsOnly?: boolean;
        avoidFlags?: Set<string>;
        destinationSpurStrategy?: EndpointSpurStrategy;
        originSpurStrategy?: EndpointSpurStrategy;
    }
    Index

    Properties

    attachEndpointsToAllowedPathsOnly? avoidFlags? destinationSpurStrategy? originSpurStrategy?

    Properties

    attachEndpointsToAllowedPathsOnly?: boolean

    Avoids attaching the endpoints to invalid sections of path.

    The path-finding algorithm takes the input coordinates and finds the closest section of path to start the routing from. If this property is set to true, this process will ignore paths which are otherwise closer if they are unsuitable according to the route options. Setting this to true does not guarantee that a route can be found.

    false
    avoidFlags?: Set<string>

    The set of edge flags that the route calculation should avoid when finding paths

    destinationSpurStrategy?: EndpointSpurStrategy

    The mechanism to use to attach the route's destination to the path network

    "curved"
    originSpurStrategy?: EndpointSpurStrategy

    The mechanism to use to attach the route's origin to the path network

    "curved"

    Settings

    Member Visibility

    On This Page

    Properties