@indoor-map/fmap-js • Docs

---

导航管理类 提供路径规划、模拟导航、真实定位导航等功能

Constructors

new FMapNavigation()

new FMapNavigation(fmap, type): FMapNavigation

Parameters

• fmap: FMap

• type: NavigationType = 'walk'

Returns

FMapNavigation

Accessors

isNavigating

Get Signature

get isNavigating(): boolean

是否正在导航

Returns

boolean

---

type

Get Signature

get type(): NavigationType

获取导航类型

Returns

NavigationType

---

viapointCount

Get Signature

get viapointCount(): number

获取途经点数量

Returns

number

Methods

addViapoint()

addViapoint(point): number

添加途经点

Parameters

• point: NavigationPoint

途经点配置

Returns

number

添加后的途经点索引

---

clear()

clear(): void

清理导航资源 停止导航并清除 SDK 内部标注（locationMarker/起终点/导航线）

Returns

void

---

clearViapoints()

clearViapoints(): void

清空所有途经点

Returns

void

---

getNaviResult()

getNaviResult(): null | NaviResult

获取导航结果

Returns

null | NaviResult

导航结果

---

getViapoints()

getViapoints(): NavigationPoint[]

获取当前途经点列表

Returns

NavigationPoint[]

途经点数组（浅拷贝）

---

onComplete()

onComplete(callback): void

设置导航完成（到达终点）事件回调 回调由 route() 时注册的转发器统一分发，这里只保存引用

Parameters

• callback

完成回调

Returns

void

---

onViapointsChange()

onViapointsChange(callback): void

设置途经点变更回调

Parameters

• callback

途经点列表变更时的回调

Returns

void

---

onWalking()

onWalking(callback): void

设置行走事件回调 回调由 route() 时注册的转发器统一分发，这里只保存引用； 在 route() 之前或之后调用均可生效

Parameters

• callback

行走信息回调

Returns

void

---

overview()

overview(ratio): Promise<void>

全览路线

Parameters

• ratio: number = 1.3

缩放比例，默认 1.3

Returns

Promise<void>

Promise

---

planRoute()

planRoute(options): Promise<NaviResult>

规划路线（route 的别名，方便组件调用）

Parameters

• options: NavigationOptions

导航配置

Returns

Promise<NaviResult>

Promise，返回导航结果

---

real()

real(options?): void

开始真实导航

Parameters

• options?: Record<string, unknown>

真实导航选项

Returns

void

---

removeViapoint()

removeViapoint(index): boolean

移除途经点

Parameters

• index: number

途经点索引

Returns

boolean

是否移除成功

---

reorderViapoints()

reorderViapoints(newOrder): void

重排序途经点

Parameters

• newOrder: number[]

新的索引顺序数组

Returns

void

---

route()

route(options): Promise<NaviResult>

规划路径

Parameters

• options: NavigationOptions

导航配置

Returns

Promise<NaviResult>

Promise，返回导航结果

---

setLocationMarker()

setLocationMarker(url, size): void

设置定位图标

Parameters

• url: string

图标URL

• size: number = 32

图标大小

Returns

void

---

setObstructions()

setObstructions(obstructions): void

设置障碍区域

Parameters

• obstructions: unknown[]

障碍区域数据

Returns

void

---

setPassedLineDistance()

setPassedLineDistance(distance): void

设置导航经过线置灰距离

Parameters

• distance: number

已走过的距离(米)

Returns

void

---

simulate()

simulate(options?): void

开始模拟导航

Parameters

• options?: Record<string, unknown>

模拟导航选项（速度/跟随/缩放等）

Returns

void

---

startSimulation()

startSimulation(options?): void

开始模拟导航（simulate 的别名）

Parameters

• options?

可选配置，包含 onWalking/onFinish 回调与 simulateOptions

• options.onFinish?

• options.onWalking?

• options.simulateOptions?: Record<string, unknown>

Returns

void

---

stop()

stop(): void

停止导航 停止后同步清除定位标注，避免再次开始导航时残留旧图标

Returns

void

---

stopNavigation()

stopNavigation(): void

停止导航（stop 的别名）

Returns

void