Mappedin JS - v6.14.0
    Preparing search index...

    Type Alias TFindNearestOptions

    Options for the nearest query

    type TFindNearestOptions = {
        limit?: "same-floor" | "same-elevation" | "all-floors";
        lineOfSight?: boolean | "auto";
        maxDistance?: number;
        maxResults?: number;
        mode?: "travel-distance" | "absolute-distance";
    }
    Index

    Properties

    limit? lineOfSight? maxDistance? maxResults? mode?

    Properties

    limit?: "same-floor" | "same-elevation" | "all-floors"

    Limit query to a set of floors. Only applies if the origin has floor information. If it doesn't, it limits the query to all floor-stacks' default floors.

    'same-floor'
    lineOfSight?: boolean | "auto"

    Whether to use line of sight checks to filter results. This ensures that results aren't obstructed by walls, etc. When 'auto', heuristics are used to determine whether to use line of sight checks. These are currently experimental, and are subject to change.

    'auto'
    maxDistance?: number

    The max distance to search for features within

    maxResults?: number

    The maximum number of results to return, the lower the number, the faster the query will be

    1
    mode?: "travel-distance" | "absolute-distance"

    The mode to use for the query

    Settings

    Member Visibility

    On This Page

    Properties