Skip to content

Commit ef426d9

Browse files
cavencjcavencj
committed
update docs
1 parent 4cc8d7f commit ef426d9

File tree

1 file changed

+120
-59
lines changed

1 file changed

+120
-59
lines changed

‎docs/zh/api/base.md‎

Lines changed: 120 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
### example
88

99
```html
10+
1011
<div id="viewer-container"></div>
1112
```
1213

@@ -16,7 +17,8 @@ global.viewer = viewer // 添加到全局变量
1617
```
1718

1819
:::warning
19-
如果开发使用的是 Vue 这样的 MVVM 框架，不要将 viewer、layer、overlay 添加到数据模型中。由于 3D 场景中会不停的刷新每一帧，如果将数据添加到数据模型中，长时间的话会导致浏览器的压力增大而奔溃。
20+
如果开发使用的是 Vue 这样的 MVVM 框架，不要将 viewer、layer、overlay 添加到数据模型中。由于 3D
21+
场景中会不停的刷新每一帧，如果将数据添加到数据模型中，长时间的话会导致浏览器的压力增大而奔溃。
2022
:::
2123

2224
### creation
@@ -35,7 +37,8 @@ global.viewer = viewer // 添加到全局变量
3537
{
3638
"contextOptions": {
3739
"webgl": {
38-
"alpha": false, //背景
40+
"alpha": false,
41+
//背景
3942
"depth": true,
4043
"stencil": false,
4144
"antialias": true,
@@ -46,11 +49,14 @@ global.viewer = viewer // 添加到全局变量
4649
},
4750
"allowTextureFilterAnisotropic": true
4851
},
49-
"sceneMode": 3, //1: 2.5D，2: 2D，3: 3D
50-
"enableEventPropagation":false, //是否开启鼠标事件冒泡
51-
"enableMouseMovePick":false, // 是否开启鼠标移动拾取功能，开启后当覆盖物较多的情况下，帧率会下降
52-
"enableMouseOver":false, //是否开启鼠标移入事件，需要开启鼠标移动拾取功能
53-
52+
"sceneMode": 3,
53+
//1: 2.5D，2: 2D，3: 3D
54+
"enableEventPropagation": false,
55+
//是否开启鼠标事件冒泡
56+
"enableMouseMovePick": false,
57+
// 是否开启鼠标移动拾取功能，开启后当覆盖物较多的情况下，帧率会下降
58+
"enableMouseOver": false
59+
//是否开启鼠标移入事件，需要开启鼠标移动拾取功能
5460
}
5561
```
5662

@@ -63,8 +69,10 @@ global.viewer = viewer // 添加到全局变量
6369
- `{Object} camera`：相机 **_`readonly`_**，详情参考：[Camera](http://resource.dvgis.cn/cesium-docs/Scene.html)
6470
- `{Element} canvas`：canvas 节点 **_`readonly`_**
6571
- `{Object} clock`：时钟，详情参考：[Clock](http://resource.dvgis.cn/cesium-docs/Clock.html)
66-
- `{Object} dataSources`：数据资源集合，详情参考：[DataSourceCollection](http://resource.dvgis.cn/cesium-docs/DataSourceCollection.html)
67-
- `{Object} imageryLayers`：瓦片集合，详情参考：[ImageryLayerCollection](http://resource.dvgis.cn/cesium-docs/ImageryLayerCollection.html)
72+
- `{Object} dataSources`
73+
：数据资源集合，详情参考：[DataSourceCollection](http://resource.dvgis.cn/cesium-docs/DataSourceCollection.html)
74+
- `{Object} imageryLayers`
75+
：瓦片集合，详情参考：[ImageryLayerCollection](http://resource.dvgis.cn/cesium-docs/ImageryLayerCollection.html)
6876
- `{Object} entities`：实体集合，详情参考：[EntityCollection](http://resource.dvgis.cn/cesium-docs/EntityCollection.html)
6977
- [`{Popup} popup`](#popup)：气泡窗口 **_`readonly`_**
7078
- [`{ContextMenu} contextMenu`](#contextmenu)：右击弹框 **_`readonly`_**
@@ -81,6 +89,9 @@ global.viewer = viewer // 添加到全局变量
8189
- `{Number} resolution`：分辨率 **_`readonly`_**
8290
- `{Number} zoom`: 当前层级 **_`readonly`_**
8391
- `{Rect} viewBounds`：视野范围 **_`readonly`_**
92+
- `{Boolean} enableEventPropagation`: 是否开启鼠标事件冒泡
93+
- `{Boolean} enableMouseMovePick`: 是否开启鼠标移动拾取功能，开启后当覆盖物较多的情况下，帧率会下降
94+
- `{Boolean} enableMouseOver`: 是否开启鼠标移入事件，需要开启鼠标移动拾取功能
8495

8596
### methods
8697

@@ -95,47 +106,87 @@ global.viewer = viewer // 添加到全局变量
95106
```json
96107
// 属性参数(可选)
97108
{
98-
"shadows": false, // 是否开启阴影
99-
"resolutionScale": 1, // 设置渲染分辨率的缩放比例
100-
"showAtmosphere": true, //是否显示大气层
101-
"showSun": true, //是否显示太阳
102-
"showMoon": true, //是否显示月亮
103-
"enableFxaa": true, //是否开启抗锯齿
104-
"msaaSamples": 1, //msaa抗拒出取样度
109+
"shadows": false,
110+
// 是否开启阴影
111+
"resolutionScale": 1,
112+
// 设置渲染分辨率的缩放比例
113+
"showAtmosphere": true,
114+
//是否显示大气层
115+
"showSun": true,
116+
//是否显示太阳
117+
"showMoon": true,
118+
//是否显示月亮
119+
"enableFxaa": true,
120+
//是否开启抗锯齿
121+
"msaaSamples": 1,
122+
//msaa抗拒出取样度
105123
"cameraController": {
106124
// 相机控制
107-
"enableRotate": true, // 是否可以旋转
108-
"enableTilt": true, // 是否可以翻转
109-
"enableTranslate": true, // 是否可以平移
110-
"enableZoom": true, // 是否可以缩放
111-
"enableCollisionDetection": true, // 是否支持碰撞检测
112-
"minimumZoomDistance": 1.0, // 最小缩放距离
113-
"maximumZoomDistance": 40489014.0 // 最大缩放距离
125+
"enableRotate": true,
126+
// 是否可以旋转
127+
"enableTilt": true,
128+
// 是否可以翻转
129+
"enableTranslate": true,
130+
// 是否可以平移
131+
"enableZoom": true,
132+
// 是否可以缩放
133+
"enableCollisionDetection": true,
134+
// 是否支持碰撞检测
135+
"minimumZoomDistance": 1.0,
136+
// 最小缩放距离
137+
"maximumZoomDistance": 40489014.0
138+
// 最大缩放距离
114139
},
115140
"globe": {
116-
"show": true, // 是否显示地球
117-
"showGroundAtmosphere": true, // 显示地面大气
118-
"enableLighting": false, //是否开启灯光，开启后地球会根据当前时间启用灯光
119-
"depthTestAgainstTerrain": false, //是否开启深度检测
120-
"tileCacheSize": 100, // 默认瓦片缓存大小
121-
"preloadSiblings": false, //是否应预加载渲染同级图块
122-
"terrainExaggeration": 1, //地形夸张系数
123-
"terrainExaggerationRelativeHeight": 1, //地形相对高度夸张系数
124-
"baseColor": new DC.Color(0, 0, 0.5, 1), //地球默认底色
125-
"filterColor": new DC.Color(0, 0, 0, 0), //瓦片过滤色,设置后不可逆
141+
"show": true,
142+
// 是否显示地球
143+
"showGroundAtmosphere": true,
144+
// 显示地面大气
145+
"enableLighting": false,
146+
//是否开启灯光，开启后地球会根据当前时间启用灯光
147+
"depthTestAgainstTerrain": false,
148+
//是否开启深度检测
149+
"tileCacheSize": 100,
150+
// 默认瓦片缓存大小
151+
"preloadSiblings": false,
152+
//是否应预加载渲染同级图块
153+
"terrainExaggeration": 1,
154+
//地形夸张系数
155+
"terrainExaggerationRelativeHeight": 1,
156+
//地形相对高度夸张系数
157+
"baseColor": new
158+
DC.Color(0,
159+
0,
160+
0.5,
161+
1),
162+
//地球默认底色
163+
"filterColor": new
164+
DC.Color(0,
165+
0,
166+
0,
167+
0),
168+
//瓦片过滤色,设置后不可逆
126169
"translucency": {
127170
//地表透明
128-
"enabled": false, // 是否开启地表透明
129-
"backFaceAlpha": 1, // 地球背面透明度
130-
"backFaceAlphaByDistance": null, //根据距离设置地球背面透明度: {near:400,nearValue:0.2,far:800,farValue:1}
131-
"frontFaceAlpha": 1, // 地球正面透明度
132-
"frontFaceAlphaByDistance": null //根据距离设置地球正面透明度: {near:400,nearValue:0.2,far:800,farValue:1}
171+
"enabled": false,
172+
// 是否开启地表透明
173+
"backFaceAlpha": 1,
174+
// 地球背面透明度
175+
"backFaceAlphaByDistance": null,
176+
//根据距离设置地球背面透明度: {near:400,nearValue:0.2,far:800,farValue:1}
177+
"frontFaceAlpha": 1,
178+
// 地球正面透明度
179+
"frontFaceAlphaByDistance": null
180+
//根据距离设置地球正面透明度: {near:400,nearValue:0.2,far:800,farValue:1}
133181
}
134182
},
135183
"skyBox": {
136-
"sources": {}, // 六个面的贴图
137-
"show": true, //是否显示
138-
"offsetAngle": 0 //旋转角度
184+
"sources": {},
185+
// 六个面的贴图
186+
"show": true,
187+
//是否显示
188+
"offsetAngle": 0
189+
//旋转角度
139190
}
140191
}
141192
```
@@ -178,16 +229,18 @@ global.viewer = viewer // 添加到全局变量
178229
```json
179230
//属性参数 (可选)
180231
{
181-
"name": "电子地图", //名称
182-
"iconUrl": "../preview.png" //缩略图
183-
"alpha" : 1.0,
184-
"nightAlpha" : 1.0,
185-
"dayAlpha" : 1.0,
186-
"brightness" : 1.0,
187-
"contrast" : 1.0,
188-
"hue" : 1.0,
189-
"saturation" : 1.0,
190-
"gamma" : 1.0,
232+
"name": "电子地图",
233+
//名称
234+
"iconUrl": "../preview.png"
235+
//缩略图
236+
"alpha": 1.0,
237+
"nightAlpha": 1.0,
238+
"dayAlpha": 1.0,
239+
"brightness": 1.0,
240+
"contrast": 1.0,
241+
"hue": 1.0,
242+
"saturation": 1.0,
243+
"gamma": 1.0
191244
}
192245
```
193246

@@ -403,8 +456,10 @@ popup.setContent('<div></div>')
403456
// 配置（可选）
404457
// 配置后会影响全局的popup的显示样式，请慎重。
405458
{
406-
"position": "center", // popup的位于鼠标的点击位置的方向,有：center，left ，right
407-
"customClass": "custom" // 添加自定义的Css 类名到popup中，多个用空格隔开
459+
"position": "center",
460+
// popup的位于鼠标的点击位置的方向,有：center，left ，right
461+
"customClass": "custom"
462+
// 添加自定义的Css 类名到popup中，多个用空格隔开
408463
}
409464
```
410465

@@ -461,7 +516,8 @@ contextMenu.enable = true
461516
contextMenu.DEFAULT_MENU = [
462517
{
463518
label: '测试',
464-
callback: (e) => {}, // e是一个对象主要包括 windowPosition,position,surfacePosition,overlay
519+
callback: (e) => {
520+
}, // e是一个对象主要包括 windowPosition,position,surfacePosition,overlay
465521
context: this,
466522
},
467523
] // 设置默认的右击菜单，会影响全局右击菜单(慎用)。
@@ -700,8 +756,10 @@ scene.skyBox = new DC.SkyBox({
700756
```json
701757
//options(可选)
702758
{
703-
"sources": {}, // 六个面的贴图
704-
"show": true //显示
759+
"sources": {},
760+
// 六个面的贴图
761+
"show": true
762+
//显示
705763
}
706764
```
707765

@@ -742,9 +800,12 @@ scene.skyBox = new DC.GroundSkyBox({
742800
```json
743801
//options(可选)
744802
{
745-
"sources": {}, // 六个面的贴图
746-
"show": true, //显示
747-
"offsetAngle": 0 //旋转角度
803+
"sources": {},
804+
// 六个面的贴图
805+
"show": true,
806+
//显示
807+
"offsetAngle": 0
808+
//旋转角度
748809
}
749810
```
750811

0 commit comments

Comments
 (0)