@sipsgmedo/mapmost-onemap-x 3.5.0-beta1

package/README.md

@@ -0,0 +1,107 @@
+# @medo/mapmost-onemap-x
+
+<p >&emsp;&emsp;@medo/mapmost-onemap-x 是基于 Medo 平台与 Mapmost 技术封装的一张图地图开发 VUE 组件，包含底图加载、图层管理、快查搜索、工具条等一系列地图基础功能控件，通过 Medo 平台用户认证体系实现快速实现项目生产中的地图功能需求，具备主题定制、多种交互、高性能渲染等能力，推荐适用社会治理、自然资源场景应用。</p>
+
+### 快速开始
+
+#### 1、安装
+
+这是个私有包，记得在.npmrc 文件中设置源
+
+```javascript
+@dpark:registry = "https://nexus.dpark.com.cn/repository/npm-sipsg/"
+@mapmost:registry="https://nexus.dpark.com.cn/repository/npm-mapmost/"
+@medo:registry = "https://nexus.dpark.com.cn/repository/npm-group/"
+```
+
+```bash
+npm install @medo/mapmost-onemap-x -S -f
+```
+
+#### 2、引用
+
+#### 全局引入
+
+```javascript
+import MapmostOnemap from '@medo/mapmost-onemap-x';
+import '@medo/mapmost-onemap-x/dist/mapmost-onemap-x.css';
+Vue.use(MapmostOnemap);
+```
+
+#### 按需引入
+
+```javascript
+import { MapmostOnemapView } from '@medo/mapmost-onemap-x';
+import '@medo/mapmost-onemap-x/dist/mapmost-onemap-x.css';
+```
+
+Mapmost-onemap-x 组件依赖技术统一框架用户认证；依赖 mapmost 授权码（期限）；
+控制器标记 ⭐ 可传入对象参数：{position: [top, right, bottom, left]}
+
+#### 3、快速上手
+
+```markdown
+<mapmost-onemap-view-x style="position: relative;" :option='option'></mapmost-onemap-view-x>
+```
+
+##### 参数说明：
+
+```javascript
+  //初始化地图配置参数-组件内部发起服务请求-根据角色用户请求地图配置信息
+  option:{
+        container: "map001", //地图实例dom-id
+        appId: "", //一张图应用appId
+        mapCustomURL: "http://{ip}/medox-api",//地图通用服务地址
+        mapStyleConfig: { //可不填：图标字体库设置
+          sky: "light", //basic light dark 天空设置
+          theme: "blue-algae", //内置主题色设置 可选值blue-algae蓝藻主题 common常规主题
+          controls: { // 地图各模块显示控制
+            MapCoordinate: true, //鼠标移动经纬度及缩放显示控制 ⭐
+            MapTools: true, // 地图工具条 ⭐
+            MapScale: true, // 地图比例尺 ⭐ 位置控制同MapAttri
+            MapSearch: true,// 地图快查 ⭐
+            MapSwitch: true,// 地图与影像底图切换 ⭐
+            MapLayerManager: true //图层管理器 ⭐
+            MapCoordinate: true, //坐标显示 ⭐
+            MapNav: false, //zoom-控件 ⭐ 默认不显示
+            MapAttri: true, //sipsg by medo  ⭐ 位置控制同MapScale
+            MapLegend: true, // 开启图层图例
+          },
+          baseIp: "http://{ip}",
+          sprite: `http://{ip}/sprite/streets-v9/sprite`,
+          glyphs: `http://{ip}/glyphs/{fontstack}/{range}.pbf`,
+          images: `http://{ip}/images`, //系统默认图标库
+        }
+  }
+```
+
+#### 3、文档地址
+
+```markdown
+开发中心 wiki
+https://mwiki.dpark.com.cn/
+组件文档
+http://medo.dpark.com.cn/mapmost-onemap-x-doc/#快速开始
+纯 API 文档
+http://medo.dpark.com.cn/mapmost-onemap-x-api/index.html
+```
+
+## 支持坐标系
+
+#### EPSG4490、EPSG3857、EPSG4527、EPSG4528、LOCAL（地方平面坐标系/苏州 2000）
+
+## 资源地址
+
+https://git.dpark.com.cn/git/kaifazhongxin/kuangjiayanfabu/mapmost-onemap-sourcedata/-/tree/master
+
+## 组件内插槽
+
+```vue
+<mapmost-onemap-view-x :option="option" @success="mapSuccess">
+  <slot></slot>
+</mapmost-onemap-view-x>
+```
+
+::: warning 注意
+组件内部 UI，多数采用绝对定位方式，z-index 默认为 1；插槽位置处在组件内置 UI 层之前位置，推荐使用绝对定位控制层级；
+:::