全部服务产品
开发者频道
定价
登录
排单排线结果页
下载开发文档

排单排线结果页是智能调度的前端SDK API @baidu-map/ros-sdk

npm version
产品简介

智能调度前端SDK是为了帮助客户能够在自己的系统中快速集成智能调度的能力,提供诸如路线结果展示、路线调整、路线计算、网点定位、车辆控制、配载3D展示、未分配订单查询等功能与UI界面。UI界面主题支持自定义能够适配客户系统。同时支持代理模式使SDK信息更加安全,多参数、多事件的配置也能更加灵活的适配客户系统。

功能展示

路线结果展示

adjustresult.png

路线调整

adjustroute.pngadjustroute2.png

配载展示

adjustarrange.png
快速上手

引入项目

<!-- npm CDN -->
<script src="https://unpkg.com/@baidu-map/ros-sdk@0.0.1/dist/index.umd.min.js"></script>
<!-- 百度 CDN -->
<script src="https://wuliu-web.cdn.bcebos.com/sdk/ros-sdk/0.0.1/index.umd.min.js"></script>

使用示例

const rosSdk = new window.BAIDU_ROS_SDK({
domId: 'domId', // ros展示的dom id(必填)
serveAk: 'ak', // 服务ak(当isProxy为false时 必填)
taskId: 'taskId', // 任务id(必填)
isProxy:false, // 是否开启代理(非必填,默认false)
webAk: 'mapak', // 地图jsapi ak(必填)
commitId: '', // commitId(非必填)
eventCallBack:()=>{}, // 内置的一些事件回调(非必填)
datafeed: { // 数字字典,会根据传入的key:value替换界面上的展示文本(非必填)
units: '条数',
unitsSuffix: '条',
orderNum: '客户数',
orderCode: '买卖许可证号',
serviceId: "买卖许可证号",
}
});
// rosSdk.destroy() 卸载

参数说明

参数名是否必填类型描述
domIdStringros展示的dom id(前端提供)
serveAk当 isProxy 为 false 时,为必填项,即为非代理模式String服务ak
isProxyBoolean是否开启代理(非必填,默认false)
taskIdString任务id
webAkString地图jsapi ak:申请地址
prefixPathString请求前缀
commitIdStringcommitId
eventCallBackFunction(EventCallBackOptions): void内置的一些事件回调
datafeedDataFeed数字字典配置,对sdk界面展示的文本进行自定义
functionFieldFunctionField控制一些字段和功能的显示隐藏
themeString(color)主题颜色
lineColorsArray[color]自定义路线颜色,优先使用自定义的颜色,路线大于颜色长度部分使用系统颜色
styleJsonstyleJson自定义地图主题样式
具体文档
readOnlyBoolean是否为只读模式,默认:false
defaultSelectIndexsArray[index]默认页面勾选的路线索引
EventCallBackOptions
参数描述
methodNameString事件名称:
onSaveStart: 保存开始;
onSaveEnd: 保存结束;
onCalculationStart: 计算开始;
onCalculationEnd: 计算结束;
onConfirmStart: 确认结果开始;
onConfirmEnd: 确认结果结束;
onReorderRoutesStart: 线路调整开始;
onReorderRoutesEnd: 线路调整结束;
successBoolean事件是否成功
dataObject事件附带的数据
DataFeed
参数名称默认值描述
routeTitle'路线'【路线结果查询】和多选后面标题里的【路线】
routeHeaderTitle'线路'单选后面标题的【线路】
routeFooterTitle'路线'各个线路下折叠面板标题里的【路线】
units'件数'件数
unitsSuffix'件'units的单位后缀
orderNum'订单数'订单数
orderCode'订单号'订单号
serviceId'ServiceId'ServiceId
serviceName'网点名称'
baseSheetName'基本信息'导出文件的基本信息的sheet名称
baseSheetTitle['线路编号', '车型', '装载率(重量)', '装载率(体积)', '装载率(件数)', '订单数量', '里程(公里)', '耗时(小时)']基本信息的表头名称
routeSheetName'路线'导出文件的路线信息的sheet名称
routeSheetTitle['顺序', '网点ID', '坐标', '地址', '货物重量(吨)', '货物体积(立方米)', '货物件数(件)', '时间窗口', '停留时间(分钟)', '预计到达时间', '预计离开时间']路线信息的表头名称
FunctionField
参数名称默认值(true:显示,false:隐藏)描述
showWarehousePointtrue默认是否显示仓库点
showRoadLinetrue默认是否显示路线
showRoadLinePointtrue默认是否显示路线点
showTransitPointtrue默认是否显示途经点
showSettingtrueheader右侧的路线设置按钮
routeCardWeighttrue线路卡片中详情重量
routeCardVolumetrue线路卡片中详情体积
routeCardCounttrue线路卡片中详情数量
toggleThemetrue顶部-黑白主题切换按钮
routeDetailWeighttrue路线中重量
routeDetailVolumetrue路线中体积
routeDetailCounttrue路线中数量
checkUndistributedHookfalse点击开始计算是否出现 “未分配点约束” 选择
lineSortBtnfalse顶部-线路调整按钮
serviceNamefalse控制网点名称字段的显示隐藏
estimatedCosttrue预估费用
stowagetrue配载功能
additionTrucktrue增加运输车按钮
savetrue保存按钮
startCalculatingtrue开始计算按钮
headerCommitIdtrue顶部-commitid
headerConfirmResulttrue顶部-确认结果
detailOrderTypetrue详情-订单类型
detailServiceIdtrue详情-serviceId
detailAddresstrue详情-地址
detailTimeWindowstrue详情-时间窗口
detailArriveTimeStrtrue详情-预计到达时间
detailEndTimeStrtrue详情-预计离开时间
detailLocationtrue详情-坐标
detailTotalWeighttrue详情-总重量
detailTotalVolumetrue详情-总体积
detailTotalUnitstrue详情-总件数
detailReasontrue详情-未分配原因
detailWeighttrue详情-装载重量
detailVolumetrue详情-装载体积
detailUnitstrue详情-件数

方法

方法名参数返回值描述
destroy卸载内部的注册方法事件等。
dispatch{ type:"refresh" }Promise向sdk派发任务,目前只支持:刷新页面
setOptions{ readOnly: Boolean }修改一些配置,目前只支持:切换只读
非代理模式

即通过SDK集成的智能调度页面在客户系统内展示,但是所有的请求都是直连百度地图,客户可以通过sdk的事件和一些参数配置做一些通知的接收和配置。非代理模式,需要在页面源码中暴露服务端AK,存在安全风险,建议仅在测试验证时,或者可限制访问IP范围的场景下使用,在生产环境下更建议使用代理模式。

proxy1.png
代理模式

即智能调度SDK所有的服务请求都通过客户的服务进行代理转发,客户可以在服务端精准把控服务执行时机和一些安全性的校验。

proxy2.png

nginx代理配置例子

# 如果配置的有请求前缀可以在这里加上
location /ros/ {
set $args "$args&ak=您的ak";
proxy_pass https://api.map.baidu.com/ros/;
proxy_set_header Host api.map.baidu.com;
}

上一篇

多点有序排单查询

下一篇

更新日志

本篇文章对您是否有帮助?