Skip to content

spatial-monorepo


spatial-monorepo / ui/src / UseWayfindingResult

Interface: UseWayfindingResult

Defined in: packages/ui/src/useWayfinding.ts:124

Properties

path

path: GeoJSONLineString | null

Defined in: packages/ui/src/useWayfinding.ts:130

GeoJSON LineString of the computed route, or null


reset

reset: () => void

Defined in: packages/ui/src/useWayfinding.ts:136

Clear both waypoints and the path

Returns

void


setStart

setStart: (coord) => void

Defined in: packages/ui/src/useWayfinding.ts:126

Snap start to nearest graph node and store it

Parameters

coord

Position2D

Returns

void


setStop

setStop: (coord) => void

Defined in: packages/ui/src/useWayfinding.ts:128

Snap stop to nearest graph node and store it

Parameters

coord

Position2D

Returns

void


startCoord

startCoord: Position2D | null

Defined in: packages/ui/src/useWayfinding.ts:132

Snapped start coordinate (for marker placement)


stopCoord

stopCoord: Position2D | null

Defined in: packages/ui/src/useWayfinding.ts:134

Snapped stop coordinate (for marker placement)

Released under commercial licensing.