# 百度-商业绘图管理平台SDK文档
# 引入到项目
版本信息:
# CDN
<script src="https://wuliu-web.cdn.bcebos.com/sdk/quhua/2.2.4/index.umd.min.js"></script>
1
# npm
# npm
npm install @baidu-map/logistics-quhua-sdk --save
# yarn
yarn add @baidu-map/logistics-quhua-sdk
1
2
3
4
2
3
4
# 快速开始
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<style>
html,
body,
#box {
margin: 0;
padding: 0;
width: 100%;
height: 100%;
overflow: hidden;
}
</style>
</head>
<body>
<div id="box"></div>
<script src="https://wuliu-web.cdn.bcebos.com/sdk/quhua/2.2.4/index.umd.min.js"></script>
<script>
const sdk = new QuHuaSdk({
ak: 'ak',
domId: 'box',
defaultCenterCity: "上海市", // 非必填
// baseMapId: 'baseMapId',
// defaultLayerId: 'defaultLayerId',
// readOnly:true,
functionField: {
},
eventCallBack: (...arg) => {
console.log("===", arg)
}
});
// 一定要卸载
// sdk.destroy();
</script>
</body>
</html>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# API
# QuHuaSdk
构造函数接收配置对象 Option (opens new window)。
QuHuaSdk( Option (opens new window) )
# Option
| 名称 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| domId | string | 是 | - | 前端dom的id |
| ak | string | 是 | 无,必须传入 | 百度地图服务 AK |
| route | 'editlayers' | 'hotlayers' | 'allocationlayers'| 'passports'| 'privaterule'| 'plan'| 'storeroad' | 否 | 'editlayers' | 首屏页面路由 editlayers:基础数据页面 hotlayers:热力图页面 allocationlayers:运单分配页面 passports:通行规则 privaterule:私有通行规则 plan:路径规划 storeroad:路线库 |
| defaultCenterCity | string | 否 | - | 城市名称,如:上海市。将会根据城市名称初始化居中地图 |
| prefixPath | string | 否 | - | 代理模式时添加的请求前缀 |
| isProxy | Boolean | 否 | false | 是否开启代理模式 |
| readOnly | Boolean | 否 | false | 是否为只读模式,仅editlayers页面生效 |
| functionField | FunctionField | 否 | - | 控制一些字段和功能的显示隐藏 FunctionField 类型数据 |
| whiteList | Array<WhiteItem> | 否 | - | 区划请求自定义处理白名单 |
| whiteListProxy | async ([WhiteListProxyData](#znro8)) => response | 否 | - | 自定义请求回调函数 |
| baseMapId | string | 否 | - | 自定义编辑地图id,(传入之后将使用此地图id) |
| defaultLayerId | string | 否 | - | 默认展示图层id(传入之后则展示为该图层的图形列表页面) |
| eventCallBack | function ( [EventCallBackOptions](#ueTj1) ) | 否 | - | 慧图触发的一些事件 |
# 实例方法
| 方法名 | 参数 | 返回值 | 描述 |
|---|---|---|---|
| destroy | - | - | 卸载sdk |
| dispatch | ([DispatchType](#y7Yk5),data)=>Promise | promise | 向sdk派发行为事件 |
# 数据类型
# FunctionField
| 参数名称 | 默认值(true:显示,false:隐藏) | 描述 |
|---|---|---|
| peripheral_search | true | 详情-周边检索 |
| draw_line | true | 绘制线 |
| draw_point | true | 绘制点 |
| editlayers_add_aoi | true | 添加aoi |
| editlayers_add_attribute | true | 编辑图层添加属性 |
| editlayers_mass_upload | true | 批量上传 |
| editlayers_back_home | true | 编辑图层返回首页 |
| baseLog | true | 基础日志 |
| administrative | true | 行政区域 |
| textToLine | true | 文字转路线 |
| roadPlanSave | true | 路线规划保存 |
| textToLineLog | true | 文字转路线日志 |
| storeroadLog | true | 路线规划日志 |
# WhiteItem
| 参数名 | 类型 | 描述 |
|---|---|---|
| url | string | 白名单url |
| method | GET|POST|PUT|DELETE | 白名单请求方式 |
| ... | any | 方便转发时携带 |
# WhiteListProxyData
| 参数名 | 类型 | 描述 |
|---|---|---|
| url | string | 请求地址 |
| newOptions | object | 请求配置 |
| whiteItem | WhiteItem | - |
# EventCallBackOptions
| 参数 | 值 | 描述 |
|---|---|---|
| methodName | string | 事件名称 |
| success | Boolean | 事件是否成功 |
| data | object | 事件附带的数据 |
# DispatchType
| DispatchType | data对应的值 | 描述 |
|---|---|---|
"addRegoins" | { regionIds:Array } | 向sdk派发添加图形行为,sdk将根据regionIds添加图形 |