@mappedin/mappedin-js 5.33.0 → 5.34.0

package/lib/esm/get-venue/index.d.ts

@@ -955,8 +955,8 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinLocation' {
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinCoordinate' {
-    import { MappedinNode, Mappedin } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     import type { MappedinMap } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
+    import { Mappedin, MappedinNode } from '@mappedin/mappedin-js/lib/esm/get-venue/internal';
     export type TMappedinCoordinateOptions = {
             map: MappedinMap;
             mappedin: Mappedin;
@@ -1019,6 +1019,11 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinCoordinate' {
                 * Get Nearest Node to Coordinate, which can then be used for navigation
                 */
             get nearestNode(): MappedinNode;
+            /**
+                * Get the {@link MappedinNode}s within a radius of the {@link MappedinCoordinate}.
+                * @param radius - The radius in metres.
+                */
+            nodesInRadius(radius: number): MappedinNode[];
             toJSON(): {
                     x: number;
                     y: number;
@@ -1969,6 +1974,10 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/MappedinNavigatable' {
                 * Exclude all the vortexes matching the given IDs
                 */
             excludedVortexIds?: string[];
+            /**
+                * Exclude all the nodes matching the given IDs
+                */
+            excludedNodeIds?: string[];
             /**
                 * @experimental
                 * Apply line-of-sight simplifying to directions. This will attempt to remove unnecessary nodes between turns.
@@ -2783,6 +2792,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.cache' {
         get polygonsByMapId(): Map<string, MappedinPolygon[]>;
         get nodesByMapId(): Map<string, MappedinNode[]>;
         findNearestNodeOnMap(mapId: string, coordinate: MappedinCoordinate): MappedinNode;
+        findNodeWithinRadiusOnMap(mapId: string, coordinate: MappedinCoordinate, radius: number): MappedinNode[];
         get locationsByMapId(): Map<string, MappedinLocation[]>;
         static instances: Map<Mappedin, MappedinCache>;
         static create(mappedin: Mappedin): MappedinCache;
@@ -2886,13 +2896,15 @@ declare class NavigationGraph {
       * @param accessible boolean - optional, if true directions will only take accessible route, defaults to false
       * @param includedVortexIds set - optional, exclude all the vertexes matching the given IDs
       * @param excludedVortexIds set - optional, exclude all the vertexes matching the given IDs
+      * @param excludedNodeIds set - optional, exclude all the nodes matching the given IDs
       */
-    aStar({ originIds, destinationNodeIds, accessible, includedVortexIds, excludedVortexIds, }: {
+    aStar({ originIds, destinationNodeIds, accessible, includedVortexIds, excludedVortexIds, excludedNodeIds, }: {
         originIds: string[];
         destinationNodeIds: string[];
         accessible: boolean;
         includedVortexIds?: Set<string>;
         excludedVortexIds?: Set<string>;
+        excludedNodeIds?: Set<string>;
     }): Edge[];
     getDistance(origin: INode, destination: INode): number;
     getShortestEuclideanDistance(origin: INode, destinations: INode[]): number;
@@ -2957,10 +2969,11 @@ declare class Navigator {
             * @param includedVortexIds set - optional, exclude all the vertexes matching the given IDs
             * @param excludedVortexIds set - optional, exclude all the vertexes matching the given IDs
             */
-        getDirections({ originIds, destinationNodeIds, accessible, departFrom, arriveAt, includedVortexIds, excludedVortexIds, simplify, }: {
+        getDirections({ originIds, destinationNodeIds, accessible, departFrom, arriveAt, includedVortexIds, excludedVortexIds, excludedNodeIds, simplify, }: {
                 originIds: string[];
                 includedVortexIds?: Set<string>;
                 excludedVortexIds?: Set<string>;
+                excludedNodeIds?: Set<string>;
                 destinationNodeIds: string[];
                 accessible: boolean;
                 departFrom?: ILocation;