From e567a28d95638e12212ab42fb7a3574bfebe9385 Mon Sep 17 00:00:00 2001
From: sbjw <sbjw.happy@163.com>
Date: Tue, 02 Dec 2025 01:00:03 +0000
Subject: [PATCH] 增加文档
---
public/军事标绘文档.md | 141 ++++++++++---------
public/GIS_API.md | 235 +++++++++++++++++++-------------
2 files changed, 213 insertions(+), 163 deletions(-)
diff --git a/public/GIS_API.md b/public/GIS_API.md
index c69fe91..411ea03 100644
--- a/public/GIS_API.md
+++ b/public/GIS_API.md
@@ -15,81 +15,89 @@
### 构建参数
-| 参数 | 说明 | 类型 | 默认值 |
-|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------|
-| mapRef | 父组件引用 | React.Component | - |
-| showDefaultLayer | 显示默认图层（国内天地图） | boolean | true |
-| addressSearchUrl | 地址查询基础服务 | string | - |
-| terrainUrl | 地形服务地址 | string | - |
-| terrainUrlIsSct | 是否是超图地形 | boolean | true |
-| baseImageUrl | 默认影像图层（iserver对应的地址） <br/> | string | - |
-| plotUrl | 标绘服务地址 | |
-| global | 最小矩形框范围。( minx ,miny, maxx, maxy) | number[] | - |
-| toolbars | 自定义工具栏,例子：['global', 'fullscreen', {key: 'seethrough2',icon: 'seethrough',titleI18n: 'seethrough2',handleClick: () => {alert('通视分析2') }}] | string | object[] | - |
-| language | 语言 | string | - |
-| i18nObj | obj对象，参考多语言例子 | object | - |
-| defaultSelectedEdit | 是否启用点击就进入编辑 | object | - |
-| defaultShowPropertyPanel | 进入编辑是否显示属性编辑面板 | object | - |
-| useSvgIcon | 是否使用svg图标，启用svg图标后，允许动态使用图标边框和颜色 | boolean | - | | object | - |
+| 参数 | 说明 | 类型 | 默认值 |
+| ------------------------ |------------------------------------------------------------------------------------------------------------------------------------------| --------------- | -------- |
+| mapRef | 父组件引用 | React.Component | - |
+| map2D | 初始化时显示2维地图 | boolean | false |
+| showDefaultLayer | 显示默认图层（国内天地图） | boolean | true |
+| addressSearchUrl | 地址查询基础服务 | string | - |
+| terrainUrl | 地形服务地址 | string | - |
+| terrainUrlIsSct | 是否是超图地形 | boolean | true |
+| baseImageUrl | 默认影像图层（iserver对应的地址）<br/> | string | - |
+| plotUrl | 标绘服务地址 | | |
+| global | 最小矩形框范围。( minx ,miny, maxx, maxy) | number[] | - |
+| toolbars | 自定义工具栏,例子：['global', 'fullscreen', {key: 'seethrough2',icon: 'seethrough',titleI18n: 'seethrough2',handleClick: () => {alert('通视分析2') }}] | string | object[] |
+| language | 语言 | string | - |
+| i18nObj | obj对象，参考多语言例子 | object | - |
+| defaultSelectedEdit | 是否启用点击就进入编辑 | object | - |
+| defaultShowPropertyPanel | 进入编辑是否显示属性编辑面板 | object | - |
+| useSvgIcon | 是否使用svg图标，启用svg图标后，允许动态使用图标边框和颜色 | boolean | - |
+| htmlBoardElementCallback | html标牌中的，dom对象的回调参数，格式 (code: string) => HTMLDivElement | boolean | - |
### 工具栏功能介绍
-| 工具编码 | 工具名称 |
-|--------------------|--------------|
-| global | 全图 |
-| fullscreen | 全屏 |
-| measureDistance | 测距 |
-| measureArea | 测面 |
+
+| 工具编码 | 工具名称 |
+| --------------- | ------------------------ |
+| global | 全图 |
+| fullscreen | 全屏 |
+| measureDistance | 测距 |
+| measureArea | 测面 |
| seethrough | 默认通视分析，面板有点丑 |
-| profile | 剖面分析，面板有点丑 |
-| angleSlope | 坡度分析 ，面板有点丑 |
-| switchMap | 二三维切换 |
-| location | 定位 |
-| print | 打印 |
-| addressSearch | 地名查询 |
-| dynamicPlot | 军式标绘 |
-| highLight | 高亮 |
-| clear | 清除 |
+| profile | 剖面分析，面板有点丑 |
+| angleSlope | 坡度分析 ，面板有点丑 |
+| switchMap | 二三维切换 |
+| location | 定位 |
+| print | 打印 |
+| addressSearch | 地名查询 |
+| dynamicPlot | 军式标绘 |
+| highLight | 高亮 |
+| clear | 清除 |
+
### 属性
-| 属性名称 | 说明 | 类型 |
-| ------------- | ------------ | --------------------------------- |
-| viewer | 3D地图对象 | Cesium.Viewer |
+
+| 属性名称 | 说明 | 类型 |
+| ------------- | ------------ | ------------------------------------ |
+| viewer | 3D地图对象 | Cesium.Viewer |
| mapApiService | 地图服务对象 | [MapApiService](#/doc/MapApiService) |
### 方法
-| 方法 | 说明 |
-|-----------------------------|-------------|
-| showDefaultLayer | 显示默认图层 |
-| doSightLine | 调用点对点通视面板 |
-| doLocation | 显示定位面板 |
-| doPrint | 显示打印面板 |
-| doAddressSearch | 显示地址查询面板 |
-| doDynamicPlot | 显示军标面板 |
-| doHighLight | 显示高亮测试面板 |
-| doProfile | 打开剖面分析面板 |
-| doAngleSlope | 打开坡度分析面板 |
-| doSightLine | 打开通视分析面板 |
-| cleanScreen | 清屏 |
-| fullScreen | 全屏 |
-| exitFullScreen | 退出全屏 |
-| showToolBar | 显示默认工具栏 |
-| hideToolBar | 隐藏默认工具栏 |
-| showStateBar | 显示状态工具栏 |
-| hideStateBar | 隐藏状态工具栏 |
-| measureDistance | 开启测量距离 |
-| measureArea | 开启测量面积 |
-| updateDemLayer | 更新地形服务 |
-| showGeoJsonDataSource | 增加geojson服务 |
-| showSuperMapImageryProvider | 显示超图影像图层 |
-| addBpListener | 拨盘监听事件 |
-| closeBp | 关闭拨盘 |
-| updateLanguage | 更新语言 |
+| 方法 | 说明 |
+| --------------------------- | ---------------------- |
+| showDefaultLayer | 显示默认图层 |
+| doSightLine | 调用点对点通视面板 |
+| doLocation | 显示定位面板 |
+| doPrint | 显示打印面板 |
+| doAddressSearch | 显示地址查询面板 |
+| doDynamicPlot | 显示军标面板 |
+| doHighLight | 显示高亮测试面板 |
+| doProfile | 打开剖面分析面板 |
+| doAngleSlope | 打开坡度分析面板 |
+| doSightLine | 打开通视分析面板 |
+| cleanScreen | 清屏 |
+| fullScreen | 全屏 |
+| exitFullScreen | 退出全屏 |
+| showToolBar | 显示默认工具栏 |
+| hideToolBar | 隐藏默认工具栏 |
+| showStateBar | 显示状态工具栏 |
+| hideStateBar | 隐藏状态工具栏 |
+| measureDistance | 开启测量距离 |
+| measureArea | 开启测量面积 |
+| updateDemLayer | 更新地形服务 |
+| showGeoJsonDataSource | 增加geojson服务 |
+| showSuperMapImageryProvider | 显示超图影像图层 |
+| addBpListener | 拨盘监听事件 |
+| closeBp | 关闭拨盘 |
+| updateLanguage | 更新语言 |
+| getScale | 获取比例尺 |
+| addScaleListener | 增加比例尺动态切换监听 |
### 具体方法
+
##### showDefaultLayer()
显示默认图层，参数无需填写
@@ -101,65 +109,72 @@
调用点对点通视面板，第二次调用表示关闭面板
---
+
#### doLocation()
显示定位面板，第二次调用表示关闭面板
- ---
+---
#### doPrint()
显示打印面板，第二次调用表示关闭面板
- ---
+---
#### doAddressSearch()
显示地址查询面板，第二次调用表示关闭面板
- ---
+---
#### doDynamicPlot()
显示军标面板，第二次调用表示关闭面板
- ---
+---
+
#### doHighLight()
显示高亮闪烁面板，第二次调用表示关闭面板
- ---
+---
#### doProfile()
调用剖面分析面板，第二次调用表示关闭面板
- ---
+---
+
#### doAngleSlope()
调用坡度分析面板，第二次调用表示关闭面板
- ---
+---
#### doSightLine()
调用通视分析面板，第二次调用表示关闭面板
- ---
+---
#### cleanScreen()
+
清屏，参数无需填写
- ---
+---
+
#### fullScreen()
+
全屏，参数无需填写
- ---
+---
+
#### exitFullScreen()
退出全屏，参数无需填写
- ---
+---
##### hideToolBar()
@@ -172,60 +187,69 @@
显示默认工具栏，参数无需填写
---
+
#### hideStateBar()
隐藏默认状态栏，参数无需填写
---
+
#### showStateBar()
显示默认状态栏，参数无需填写
---
+
#### updateDemLayer(demLayerUrl, sct)
更新地形服务
-| 参数 | 必须 | 类型 | 说明 |
-|-------------|-------------|---------|-------------------------------|
-| demLayerUrl | true | string | 地形地址 |
-| sct | false | boolean | 是过滤器是iserver独立发布的地形图层，默认为true |
+| 参数 | 必须 | 类型 | 说明 |
+| ----------- | ----- | ------- | ----------------------------------------------- |
+| demLayerUrl | true | string | 地形地址 |
+| sct | false | boolean | 是过滤器是iserver独立发布的地形图层，默认为true |
---
+
#### showGeoJsonDataSource(layerConfig, zoomTo)
显示矢量数据
-| 参数 | 必须 | 类型 | 说明 |
-|-----------------------------|-------------|---------|-----------------|
-| layerconfig | true | object | 图层配置 |
-| layerconfig.code | true | string | 图层编码 |
-| layerconfig.url | true | string | 隐藏状态工具栏 |
-| layerconfig.fill | false | string | 填充颜色，格式：#FF0000 |
-| layerconfig.stroke | false | string | 边框颜色，格式：#FF0000 |
-| layerconfig.strokeWidth | false | number | 默认为1，只有是线或者面时有效 |
-| layerconfig.markerSymbol | false | string | 只有是点数据时有效 |
-| zoomTo | false | boolean | 显示完成后，是否定位到数据范围 |
+
+| 参数 | 必须 | 类型 | 说明 |
+| ------------------------ | ----- | ------- | ------------------------------ |
+| layerconfig | true | object | 图层配置 |
+| layerconfig.code | true | string | 图层编码 |
+| layerconfig.url | true | string | 隐藏状态工具栏 |
+| layerconfig.fill | false | string | 填充颜色，格式：#FF0000 |
+| layerconfig.stroke | false | string | 边框颜色，格式：#FF0000 |
+| layerconfig.strokeWidth | false | number | 默认为1，只有是线或者面时有效 |
+| layerconfig.markerSymbol | false | string | 只有是点数据时有效 |
+| zoomTo | false | boolean | 显示完成后，是否定位到数据范围 |
---
+
#### showSuperMapImageryProvider(layerConfig, zoomTo)
显示瓦片数据
-| 参数 | 必须 | 类型 | 说明 |
-|-----------------------------|-------------|---------|-----------------|
-| layerconfig | true | object | 图层配置 |
-| layerconfig.code | true | string | 图层编码 |
-| layerconfig.url | true | string | 隐藏状态工具栏 |
-| zoomTo | false | boolean | 显示完成后，是否定位到数据范围 |
+
+| 参数 | 必须 | 类型 | 说明 |
+| ---------------- | ----- | ------- | ------------------------------ |
+| layerconfig | true | object | 图层配置 |
+| layerconfig.code | true | string | 图层编码 |
+| layerconfig.url | true | string | 隐藏状态工具栏 |
+| zoomTo | false | boolean | 显示完成后，是否定位到数据范围 |
---
+
#### measureDistance()
在地图上开始测距
---
+
#### measureArea()
在地图上开始测面
@@ -236,10 +260,11 @@
拨盘监听事件
-| 参数 | 必须 | 类型 | 说明 |
-|-------------------------|-------------|---------|-----------------|
-| function | true | 方法体 | 回调函数 |
-| this | true | 当前类 | 图层编码 |
+
+| 参数 | 必须 | 类型 | 说明 |
+| -------- | ---- | ------ | -------- |
+| function | true | 方法体 | 回调函数 |
+| this | true | 当前类 | 图层编码 |
回调函数function(id, dom){}说明:
id:选择军标的id值
@@ -253,9 +278,25 @@
---
-
#### updateLanguage(language)
更新语言，只支持'en-US'、'zh-CN'、’fr-FR‘三种语言
---
+
+#### getScale()
+
+获取当前地图的比例尺
+
+---
+
+#### addScaleListener(scaleCallback)
+
+增加比例尺动态切换监听
+
+
+| 参数 | 必须 | 类型 | 说明 |
+| ------------- | ---- | ------ | -------- |
+| scaleCallback | true | 方法体 | 回调函数 |
+
+---
diff --git "a/public/\345\206\233\344\272\213\346\240\207\347\273\230\346\226\207\346\241\243.md" "b/public/\345\206\233\344\272\213\346\240\207\347\273\230\346\226\207\346\241\243.md"
index 3828b1b..574af8f 100644
--- "a/public/\345\206\233\344\272\213\346\240\207\347\273\230\346\226\207\346\241\243.md"
+++ "b/public/\345\206\233\344\272\213\346\240\207\347\273\230\346\226\207\346\241\243.md"
@@ -5,34 +5,39 @@
> 通用属性
-| 属性 | 英文 | 备注 |
-|------------------|-----------------|-----------------------------------------|
-| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
-| 军标代码类型 | type | 1001,1002... |
-| 显示图标文本 | showText | false |
-| 图标文本 | text | 空 |
-| 图标文本颜色 | textColor | #000000 |
-| 标注 | bz | 是否有标注 |
-| 标注文本颜色 | bzColor | 标注颜色 |
-| 标注 | bzLineColor | 标注线颜色 |
-| 图标大小 | tbdx | 数字数组，例如[64,64]表示宽64px，高64px |
-| 标注类型 | bzlx | 详标（detail）、简标(simple)、正常(normal), |
-| 详标文本 | xbwb | 多行文本用\n进行分隔 |
-| 简标文本 | jbwb | 简标文本 |
-| 选中框 | xz | true(选中), false(不选中，默认) |
-| 选中框颜色 | xzColor | 选中框颜色 默认#00FF00 |
-| X图标 | xx | true(X图标), false(不选中，默认) |
-| X图标颜色 | xxColor | X图标颜色 默认#FF0000 |
-| 经度 | lat | 经度 |
-| 纬度 | lon | 纬度 |
-| 高度 | height | 高度 |
-| 航迹点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
-| 显示航迹 | showHj | boolean |
-| 航迹颜色 | hjColor | 航迹颜色 默认#0000ff |
-| 航迹大小 | hjSize | 航迹大小 默认 2 |
-| 图标增加的大小 | iconOutlineSize | 地图参数要设置useSvgIcon才有效。默认 0 |
-| 图标颜色 | iconColor | 地图参数要设置useSvgIcon才有效。默认 #000000 |
-| 图标旋转 | rotate | 地图旋转。默认为0，航迹算的角度优先 |
+| 属性 | 英文 | 备注 |
+| --------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------- |
+| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
+| 军标代码类型 | type | 1001,1002... |
+| 显示图标文本 | showText | false |
+| 图标文本 | text | 空 |
+| 图标文本颜色 | textColor | #000000 |
+| 标注 | bz | 是否有标注 |
+| 标注文本颜色 | bzColor | 标注颜色 |
+| 标注 | bzLineColor | 标注线颜色 |
+| 图标大小 | tbdx | 数字数组，例如[64,64]表示宽64px，高64px |
+| 标注类型 | bzlx | 详标（detail）、简标(simple)、正常(normal), |
+| 详标文本 | xbwb | 多行文本用\n进行分隔 |
+| 简标文本 | jbwb | 简标文本 |
+| 选中框 | xz | true(选中), false(不选中，默认) |
+| 选中框颜色 | xzColor | 选中框颜色 默认#00FF00 |
+| X图标 | xx | true(X图标), false(不选中，默认) |
+| X图标颜色 | xxColor | X图标颜色 默认#FF0000 |
+| 经度 | lat | 经度 |
+| 纬度 | lon | 纬度 |
+| 高度 | height | 高度 |
+| 航迹点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
+| 显示航迹 | showHj | boolean |
+| 航迹颜色 | hjColor | 航迹颜色 默认#0000ff |
+| 航迹大小 | hjSize | 航迹大小 默认 2 |
+| 图标增加的大小 | iconOutlineSize | 地图参数要设置useSvgIcon才有效。默认 0 |
+| 图标颜色 | iconColor | 地图参数要设置useSvgIcon才有效。默认 #000000 |
+| 启用HTML标牌面板 | showHtmlBoard | true 和 false |
+| HTML模板 | templateHtml | string类型，如果在初始化地图的时候有传递htmlBoardElementCallback参数时，可以不传 |
+| HTML模板值 | templateValue | 对象类型，格式：{key: value}，如果在初始化地图的时候有传递htmlBoardElementCallback参数时，可以不传 |
+| 拖动框要素css选择器 | infoWindowSelector | 通过样式选择，不要使用id，默认为 .info-window |
+| 拖动框拖动部分要素css选择器 | infoWindowTitleSelector | 通过样式选择，不要使用id，默认为 .info-window-heading |
+| 拖动框按钮要素css选择器 | infoWindowBtnPinSelector | 通过样式选择，不要使用id，默认为 .btn-pin |
<br />
@@ -380,58 +385,62 @@
### 25. 干扰关系线
-| 属性 | 英文 | 备注 |
-|--------|--------|-----------------------------------------|
-| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
-| 军标代码类型 | type | 固定 grgxx |
-| 颜色 | color | #000000格式 |
-| 坐标点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
-<br />
+
+| 属性 | 英文 | 备注 |
+| ------------ | ------ | ------------------------------------------ |
+| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
+| 军标代码类型 | type | 固定 grgxx |
+| 颜色 | color | #000000格式 |
+| 坐标点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
+| <br /> | | |
### 25. 双色线
-| 属性 | 英文 | 备注 |
-|--------|--------|-----------------------------------------|
-| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
-| 军标代码类型 | type | 双色线固定 double |
-| 颜色 | color | #000000格式 |
-| 颜色2 | color2 | #FFFFFF格式 |
-| 坐标点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
-<br />
+
+| 属性 | 英文 | 备注 |
+| ------------ | ------ | ------------------------------------------ |
+| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
+| 军标代码类型 | type | 双色线固定 double |
+| 颜色 | color | #000000格式 |
+| 颜色2 | color2 | #FFFFFF格式 |
+| 坐标点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
+| <br /> | | |
### 26. 通信抗测向线2
-| 属性 | 英文 | 备注 |
-|--------|--------|-----------------------------------------|
-| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
+
+| 属性 | 英文 | 备注 |
+| ------------ | ------ | ---------------------------------------- |
+| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
| 军标代码类型 | type | 固定 txdkcxx2 |
-| 颜色 | color | #000000格式 |
-| 抗测方向角度 | kcjd | 角度（0~360）方向是时钟0点方向开始算起 |
-| 抗测公里数 | kcgls | 单位：km |
-| 抗测文本 | kcwb | 右上角线的文本 |
-| 经度 | lat | 经度 |
-| 纬度 | lon | 纬度 |
-| 高度 | height | 高度 |
+| 颜色 | color | #000000格式 |
+| 抗测方向角度 | kcjd | 角度（0~360）方向是时钟0点方向开始算起 |
+| 抗测公里数 | kcgls | 单位：km |
+| 抗测文本 | kcwb | 右上角线的文本 |
+| 经度 | lat | 经度 |
+| 纬度 | lon | 纬度 |
+| 高度 | height | 高度 |
<br />
-
### 26. 团指任务分界线
-| 属性 | 英文 | 备注 |
-|--------|--------|-----------------------------------------|
-| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
-| 军标代码类型 | type | 固定 tzrwfjx |
-| 颜色 | color | #000000格式 |
-| 坐标点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
+
+| 属性 | 英文 | 备注 |
+| ------------ | ------ | ------------------------------------------ |
+| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
+| 军标代码类型 | type | 固定 tzrwfjx |
+| 颜色 | color | #000000格式 |
+| 坐标点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
### 26. 连指任务分界线
-| 属性 | 英文 | 备注 |
-|--------|--------|-----------------------------------------|
-| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
-| 军标代码类型 | type | 固定 lzrwfjx |
-| 颜色 | color | #000000格式 |
-| 坐标点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
+
+| 属性 | 英文 | 备注 |
+| ------------ | ------ | ------------------------------------------ |
+| 唯一标识 | code | 唯一标识，如果不传会动态生成一个唯一标识 |
+| 军标代码类型 | type | 固定 lzrwfjx |
+| 颜色 | color | #000000格式 |
+| 坐标点 | points | 格式：{lon: 111, lat:22, height: 10000}[] |
<br />
--
Gitblit v1.9.3