docs: update docs

zouyaoji · Oct 30, 2022 · 590b584 · 590b584
1 parent c46e9da
commit 590b584
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 4 deletions.
diff --git a/CHANGELOG.en-US.md b/CHANGELOG.en-US.md
@@ -1,5 +1,16 @@
 ## Changelog
 
+### 3.1.1
+
+_2022-10-31_
+
+#### Bug fixes
+
+- Misspelled word: retangle should be rectangle. [#291] (https://github.com/zouyaoji/vue-cesium/issues/291)
+- Modified styles to resolve conflicts with some UI components. [#292] (https://github.com/zouyaoji/vue-cesium/pull/292)
+- Fixed the crash issue when the `vc-status-bar` component got camera parameters abnormally when switching view modes.
+- Fixed the issue that the `vc-navigation` component does not work dynamically through the v-if directive.
+
 ### 3.1.0
 
 _2022-09-25_

diff --git a/CHANGELOG.zh-CN.md b/CHANGELOG.zh-CN.md
@@ -2,10 +2,14 @@
 
 ### 3.1.1
 
+_2022-10-31_
+
 #### Bug 修复
 
 - 单词拼写错误: retangle 应为 rectangle。[#291](https://github.com/zouyaoji/vue-cesium/issues/291)
 - 修改样式以解决与部分 UI 组件的冲突。[#292](https://github.com/zouyaoji/vue-cesium/pull/292)
+- 修复在切换视图模式时 `vc-status-bar` 组件获取相机参数异常导致崩溃的问题。
+- `vc-navigation` 组件通过 v-if 指令动态显隐不起作用的问题。
 
 ### 3.1.0
 

diff --git a/website/docs/en-US/analyses/vc-drawings.md b/website/docs/en-US/analyses/vc-drawings.md
@@ -228,7 +228,7 @@ Basic usage of drawing components.
 <!-- prettier-ignore -->
 | Name | Type | Default | Description | Accepted Values |
 | ---- | ---- | ------- | ----------- | --------------- |
-| position | string | `'top-right'` | `optional` Specify the location of the drawing component. |top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| position | string | `'bottom-left'` | `optional` Specify the location of the drawing component. |top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
 | offset | [number, number] | `[0, 0]` | `optional` Specify the offset based on the position. |
 | show | boolean | `true` | `optional` Specify whether the drawn result is visible. |
 | mode | number | `1` | `optional` Specify the interactive drawing mode, 0 means continuous drawing, and 1 means drawing ends once.|

diff --git a/website/docs/en-US/controls/vc-navigation.md b/website/docs/en-US/controls/vc-navigation.md
@@ -185,6 +185,8 @@ Customize navigation components as needed. The available components are: `vc-com
 | Name | Type | Default | Description | Accepted Values |
 | ---- | ---- | ------- | ----------- | --------------- |
 | position | string | `top-right` | `optional` Specify the position of the component. | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` Specify the customClass of the vc-navigation. | |
+| teleportToViewer | boolean | `true` | `optional` Specify whether to add to the cesium-viewer node. If false, it becomes `relative` positioning. | |
 | offset | [number, number] | `[0, 0]` | `optional` Specify the offset of the component. |
 | compassOpts | VcCompassProps\|false | Same as `VcCompass` | `optional` Specify the compass options of the component. false means no display. |
 | zoomOpts | VcZoomControlProps\|false | Same as `VcZoomControl` | `optional` Specify the zoom options of the component. false means no display. |
@@ -239,6 +241,8 @@ Compass component.
 | Name | Type | Default | Description | Accepted Values |
 | ---- | ---- | ------- | ----------- | --------------- |
 | position | string | `top-right` | `optional` Specify the position of the component. | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` Specify the customClass of the vc-compass. | |
+| teleportToViewer | boolean | `true` | `optional` Specify whether to add to the cesium-viewer node. If false, it becomes `relative` positioning. | |
 | offset | [number, number] | `[0, 0]` | `optional` Specifies the position-based offset of the compass. |
 | enableCompassOuterRing | boolean | `true` | `optional` Specify whether the outer ring of the compass can be operated. |
 | duration | number | `1.5` | `optional` Specify the flight time to restore the pitch angle, in seconds. |
@@ -317,6 +321,8 @@ Tips `outerOptions`, `innerOptions`, `markerOptions` default parameters:
 | Name | Type | Default | Description | Accepted Values |
 | ---- | ---- | ------- | ----------- | --------------- |
 | position | string | `top-right` | `optional` Specify the position of the component. | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` Specify the customClass of the vc-zoom-control. | |
+| teleportToViewer | boolean | `true` | `optional` Specify whether to add to the cesium-viewer node. If false, it becomes `relative` positioning. | |
 | offset | [number, number] | `[0, 0]` | `optional` Specifies the offset of the zoom control. |
 | enableResetButton | boolean | `true` | `optional` Specify whether to enable the reset button. |
 | zoomAmount | number | `2` | `optional` Specify the zoom amount of zoom in and zoom out. |
@@ -444,6 +450,8 @@ Tips: `durationReset`, `zoomInOptions`, `zoomOutOptions`, `zoomResetOptions` def
 | Name | Type | Default | Description | Accepted Values |
 | ---- | ---- | ------- | ----------- | --------------- |
 | position | string | `top-right` | `optional` Specify the position of the component. | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` Specify the customClass of the vc-print. | |
+| teleportToViewer | boolean | `true` | `optional` Specify whether to add to the cesium-viewer node. If false, it becomes `relative` positioning. | |
 | offset | [number, number] | `[0, 0]` | `optional` Specifies the offset of the print control. (Valid when used independently) |
 | showCredit | boolean | `true` | `optional` Specify whether to display the copyright information of the loaded data when printing pictures. |
 | showPrintView | boolean | `true` | `optional` Specify whether to display the print preview. |
@@ -485,6 +493,8 @@ Tips: `durationReset`, `zoomInOptions`, `zoomOutOptions`, `zoomResetOptions` def
 | Name | Type | Default | Description | Accepted Values |
 | ---- | ---- | ------- | ----------- | --------------- |
 | position | string | `top-right` | `optional` Specify the position of the component. | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` Specify the customClass of the vc-my-location. | |
+| teleportToViewer | boolean | `true` | `optional` Specify whether to add to the cesium-viewer node. If false, it becomes `relative` positioning. | |
 | offset | [number, number] | `[0, 0]` | `optional` Specifies the offset of the positioning button based on the position.|
 | geolocation | PositionOptions | | `optional` Specify the browser geolocation positioning parameters. |
 | id | string | | `optional` Specify the id of the loading point after the positioning is successful. |
@@ -532,6 +542,8 @@ Tips: `durationReset`, `zoomInOptions`, `zoomOutOptions`, `zoomResetOptions` def
 | Name | Type | Default | Description | Accepted Values |
 | ---- | ---- | ------- | ----------- | --------------- |
 | position | string | `top-right` | `optional` Specify the position of the component. | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` Specify the customClass of the vc-status-bar. | |
+| teleportToViewer | boolean | `true` | `optional` Specify whether to add to the cesium-viewer node. If false, it becomes `relative` positioning. | |
 | offset | [number, number] | `[0, 0]` | `optional` Specifies the position-based offset of the information bar control. |
 | gridFileUrl | string | `https://zouyaoji.top/vue-cesium/statics/SampleData/WW15MGH.DAC`| `optional` Specify the mouse to pick up the height model, use this to improve the accuracy of the height obtained. |
 | color | string | `'#fff'` | `optional` Specify the color of the information bar. |
@@ -571,6 +583,8 @@ Tips: `durationReset`, `zoomInOptions`, `zoomOutOptions`, `zoomResetOptions` def
 | Name | Type | Default | Description | Accepted Values |
 | ---- | ---- | ------- | ----------- | --------------- |
 | position | string | `top-right` | `optional` Specify the position of the component. | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` Specify the customClass of the vc-distance-legend. | |
+| teleportToViewer | boolean | `true` | `optional` Specify whether to add to the cesium-viewer node. If false, it becomes `relative` positioning. | |
 | offset | [number, number] | `[0, 0]` | `optional` Specifies the offset of the distance scale control based on the position.|
 | color | string | `'#fff'` | `optional` Specify the color of the distance scale control. |
 | background | string | `'#3f4854'` | `optional` Specify the distance scale background. |

diff --git a/website/docs/zh-CN/analyses/vc-drawings.md b/website/docs/zh-CN/analyses/vc-drawings.md
@@ -258,7 +258,7 @@ ctrl + 右键取消绘制。
 <!-- prettier-ignore -->
 | 属性名 | 类型 | 默认值 | 描述 | 可选值 |
 | ----- | --- | ------ | ---- | ----- |
-| position | string | `'top-right'` | `optional` 指定绘制组件的位置。 |top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| position | string | `'bottom-left'` | `optional` 指定绘制组件的位置。 |top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
 | offset | [number, number] | `[0, 0]` | `optional` 指定绘制组件基于位置的偏移量。 |
 | show | boolean | `true` | `optional` 指定绘制的结果是否可见。 |
 | mode | number | `1` | `optional` 指定绘制交互模式，0 代表连续绘制，1 代表绘制一次就结束。|

diff --git a/website/docs/zh-CN/controls/vc-navigation.md b/website/docs/zh-CN/controls/vc-navigation.md
@@ -53,6 +53,7 @@
   export default {
     data() {
       return {
+        flag: true,
         position: 'top-left',
         offset: [10, 80],
         compassOpts: {
@@ -184,7 +185,7 @@
       background="#F2C037"
     ></vc-my-location>
     <!-- 自定义 API 定位 -->
-    <vc-my-location position="top-left" :offset="[60, 0]" :custom-a-p-i="() => ({lng: 108, lat: 32})"></vc-my-location>
+    <vc-my-location position="top-left" :offset="[60, 0]" :custom-api="() => ({lng: 108, lat: 32})"></vc-my-location>
     <vc-status-bar position="bottom"></vc-status-bar>
     <vc-status-bar position="top-left" :offset="[120, 3]" :show-mouse-info="false" :show-performance-info="false"></vc-status-bar>
     <vc-distance-legend position="bottom-left" :offset="[5, 70]" background="#26A69A" bar-background="#F2C037" :width="80"></vc-distance-legend>
@@ -215,6 +216,8 @@
 | ----- | --- | ------ | ---- | ----- |
 | position | string | `'top-right'` | `optional` 指定导航组件位置。 | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
 | offset | [number, number] | `[0, 0]` | `optional` 指定导航组件基于位置的偏移量。 | |
+| customClass | string | `''` | `optional` 指定导航组件自定义 class。 | |
+| teleportToViewer | boolean | `true` | `optional` 指定导航组件是否挂载到 viewer 节点下。如果为 false，vc-navigation 为 `relative` 定位。 | |
 | compassOpts | VcCompassProps\|false | 与 `VcCompass` 保持一致 | `optional` 指定罗盘控件参数，false 即不显示。 | |
 | zoomOpts | VcZoomControlProps\|false | 与 `VcZoomControl` 保持一致 | `optional` 指定缩放控件参数，false 即不显示。 | |
 | printOpts | VcPrintProps\|false | 与 `VcPrint` 保持一致 | `optional` 指定打印控件参数，false 即不显示。 | |
@@ -268,6 +271,8 @@
 | 属性名 | 类型 | 默认值 | 描述 | 可选值 |
 | ----- | ---- | ------ | ---- | ----- |
 | position | string | `'top-right'` | `optional` 指定罗盘组件位置。 | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` 指定罗盘组件自定义 class。 | |
+| teleportToViewer | boolean | `true` | `optional` 指定罗盘组件是否挂载到 viewer 节点下。如果为 false，vc-compass 为 `relative` 定位。 | |
 | offset | [number, number] | `[0, 0]` | `optional` 指定罗盘基于位置的偏移量。 ||
 | enableCompassOuterRing | boolean | `true` | `optional` 指定罗盘外环是否可以操作。 ||
 | duration | number | `1.5` | `optional` 指定双击罗盘恢复俯仰角飞行时间，单位秒。 ||
@@ -350,6 +355,8 @@
 | 属性名 | 类型 | 默认值 | 描述 | 可选值 |
 | ----- | --- | ------ | ---- | ----- |
 | position | string | `'top-right'` | `optional` 指定缩放组件位置。 | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` 指定缩放组件自定义 class。 | |
+| teleportToViewer | boolean | `true` | `optional` 指定缩放组件是否挂载到 viewer 节点下。如果为 false，vc-zoom-control 为 `relative` 定位。 | |
 | offset | [number, number] | `[0, 0]` | `optional` 指定缩放控件基于位置的偏移量。 | |
 | enableResetButton | boolean | `true` | `optional` 指定是否启用重置按钮。 | |
 | zoomAmount | number | `2` | `optional` 指定放大缩小的数量级。 | |
@@ -481,6 +488,8 @@
 | 属性名 | 类型 | 默认值 | 描述 | 可选值 |
 | ----- | --- | ------ | ---- | ----- |
 | position | string | `'top-right'` | `optional` 指定打印组件位置。 | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` 指定打印组件自定义 class。 | |
+| teleportToViewer | boolean | `true` | `optional` 指定导打印是否挂载到 viewer 节点下。如果为 false，vc-print 为 `relative` 定位。 | |
 | offset | [number, number] | `[0, 0]` | `optional` 指定打印控件基于位置的偏移量。 ||
 | showCredit | boolean | `true` | `optional` 指定打印图片时是否显示加载数据版权信息。 ||
 | showPrintView | boolean | `true` | `optional` 指定是否显示打印预览。 ||
@@ -526,6 +535,8 @@
 | 属性名 | 类型 | 默认值 | 描述 | 可选值 |
 | ----- | --- | ------ | ---- | ----- |
 | position | string | `'top-right'` | `optional` 指定定位组件位置。 | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` 指定定位组件自定义 class。 | |
+| teleportToViewer | boolean | `true` | `optional` 指定定位组件是否挂载到 viewer 节点下。如果为 false，vc-my-location 为 `relative` 定位。 | |
 | offset | [number, number] | `[0, 0]` | `optional` 指定定位按钮基于位置的偏移量。 ||
 | geolocation | PositionOptions | | `optional` 指定浏览器定位参数。 ||
 | amap | Object | | `optional` 指定高德定位参数。如果设置则优先使用高德定位。 ||
@@ -578,6 +589,8 @@
 | 属性名 | 类型 | 默认值 | 描述 | 可选值 |
 | ----- | --- | ------ | ---- | ----- |
 | position | string | `'top-right'` | `optional` 指定状态组件位置。 | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` 指定状态组件自定义 class。 | |
+| teleportToViewer | boolean | `true` | `optional` 指定状态组件放是否挂载到 viewer 节点下。如果为 false，vc-status-bar 为 `relative` 定位。 | |
 | offset | [number, number] | `[0, 0]` | `optional` 指定信息栏控件基于位置的偏移量。 （单独使用时有效） |
 | gridFileUrl | string | `https://zouyaoji.top/vue-cesium/SampleData/WW15MGH.DAC`| `optional` 指定鼠标拾取高度模型，用这个能提高获取的高度精度。 |
 | color | string | `'#fff'` | `optional` 指定信息栏颜色。 |
@@ -620,6 +633,8 @@
 | 属性名 | 类型 | 默认值 | 描述 | 可选值 |
 | ----- | --- | ------ | ---- | ----- |
 | position | string | `'top-right'` | `optional` 指定距离比例尺组件位置。 | top-right/top-left/bottom-right/bottom-left/top/right/bottom/left |
+| customClass | string | `''` | `optional` 指定距离比例尺组件自定义 class。 | |
+| teleportToViewer | boolean | `true` | `optional` 指定距离比例尺组件放是否挂载到 viewer 节点下。如果为 false，vc-distance-legend 为 `relative` 定位。 | |
 | offset | [number, number] | `[0, 0]` | `optional` 指定距离比例尺控件基于位置的偏移量。 |
 | color | string | `'#fff'` | `optional` 指定距离比例尺控件颜色。 |
 | background | string | `'#3f4854'` | `optional` 指定距离比例尺背景。 |

diff --git a/website/docs/zh-CN/vc-viewer.md b/website/docs/zh-CN/vc-viewer.md
@@ -20,6 +20,7 @@
     :info-box="infoBox"
     :skyAtmosphere="false"
     :skyBox="false"
+    :scene-mode-picker="true"
     :show-credit="showCredit"
     @cesium-ready="onCesiumReady"
     @ready="onViewerReady"
@@ -76,7 +77,7 @@
           pixelOffset: [0, 150]
         },
         billboard: {},
-        offset: [10, 25],
+        offset: [50, 25],
         otherOpts: {
           offset: [0, 32],
           position: 'bottom-right'