Type Alias TFindNearestOptions

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

Type declaration

  • Optionallimit?: "same-floor" | "same-elevation"

    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.

    Default

    'same-floor'
  • Optional ExperimentallineOfSight?: 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.

    Default

    'auto'
  • OptionalmaxDistance?: number

    The max distance to search for features within

  • OptionalmaxResults?: number

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

    Default

    1
  • Optionalmode?: "travel-distance" | "absolute-distance"

    The mode to use for the query

Settings

Member Visibility