在前端开发中,我们经常需要使用一些关于地图和路线规划的信息,例如在网页中展示如何到达某个地方或计算两个地点之间的距离。npm 包 osrm-text-instructions 提供了一种方便的方法,使我们能够轻松地将路线规划信息转换为自然语言描述。
什么是 osrm-text-instructions?
osrm-text-instructions 是一个 JavaScript 库,用于将从开源路线规划器 OSRM 返回的路线规划指令转换为自然语言。该库提供了一个简单的接口,使开发者可以使用 JavaScript 将路线规划指令转换为文本形式,方便在页面上显示。
安装和使用
安装 osrm-text-instructions 简单。在项目的根目录下执行以下命令即可:
--- ------- ----------------------
安装成功后,我们就可以在项目中使用该库了。下面是一个使用示例:
----- -------------------- - ---------------------------------- -- ------ ----- ---------- - - - --------- ---- --------- --- ----- ----------- --------- --- ----- --------- ---- ---- -------- -------------- -- -- - --------- ---- --------- --- ----- ------- --------- ------- ----- ----- ---- ---- ---- -------- -------------- -- - -- ----- -------- - ---------- ----- ------------ - ---------------------------------------- ---------- --------------------------
在上面的代码中,我们首先引用了 osrm-text-instructions 的库文件,接着创建了一个路线规划指令的数组,并将其传递给了 osrmTextInstructions 的 compile 方法,该方法返回的就是一个自然语言描述的字符串,它表示了输入的路线规划指令。
在控制台上运行代码,我们会得到如下输出:
--- -- ---- --- ---------- -- ----- --- --
参数说明
compile 方法的参数包含以下两个:
- directions:表示路线规划指令的数组,由 OSRM 返回;
- language:指示返回字符串的语言。
directions
directions 参数是一个包含路线规划指令的数组,每个元素包含以下几个属性:
- distance:表示路线规划指令的距离(单位为米);
- duration:表示路线规划指令的时长(单位为秒);
- type:表示路线规划指令的类型,包括:Continue、Turn、Roundabout、Notification、Depart、Arrive;
- modifier:表示路线规划指令的状态修饰符,例如 left、right、straight;
- text:表示路线规划指令的文本描述;
- pronunciation:表示路线规划指令的发音。
language
language 参数指定所需字符串的语言,可以是任何 ISO 639-1 语言代码,默认为英语(en)。
路线规划指令类型
osrm-text-instructions 支持多种路线规划指令类型,包括:
- Continue:继续前行,没有变道或转向;
- Turn:转弯,进入一个新的道路;
- Roundabout:在环形交叉口中,按照指示进入或离开环路;
- Notification:在交汇处,通知用户过马路或进入新的道路;
- Depart:从起点开始行驶;
- Arrive:到达终点。
总结
通过使用 osrm-text-instructions,我们可以轻松地将来自 OSRM 的路线规划指令转换为自然语言描述,方便我们在前端页面中展示给用户。希望这个简单的教程能够帮助你快速上手使用 osrm-text-instructions,为你的项目带来更好的用户体验。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eedcb5eb5cbfe1ea06125c8