OpenSource
/
dc-sdk
mirror of https://github.com/dvt3d/dc-sdk
Watch 4
Star 0
Fork 0
Code Issues 0 Releases 92 Wiki Activity
Browse Source

update docs

tags/3.0.0
Caven Chen 2 years ago
parent
7a73d9703e
commit
f61c0965c2
7 changed files with 104 additions and 120 deletions
Split View Show Diff Stats
  1. 8
    1
      docs/.vuepress/config.yml
  2. 1
    2
      docs/effect/README.md
  3. 48
    91
      docs/zh/base/README.md
  4. 25
    4
      docs/zh/introduction/README.md
  5. 2
    2
      docs/zh/overlay/README.md
  6. 19
    19
      docs/zh/tile/README.md
  7. 1
    1
      docs/zh/tools/README.md

+ 8
- 1
docs/.vuepress/config.yml View File

@@ -86,12 +86,19 @@ themeConfig: {
{
text: '集成Vue',
items: [
{ text: 'dc-ui', link: 'http://ui.dvgis.cn/dc-ui' },
{ text: 'dc-vue', link: 'https://github.com/dvgis/dc-vue' },
{
text: 'dc-vue-next',
link: 'https://github.com/dvgis/dc-vue-next',
},
{
text: 'vite-plugin-dc',
link: 'https://github.com/dvgis/vite-plugin-dc',
},
{
text: 'dc-vite',
link: 'https://github.com/dvgis/dc-vite',
},
],
},
{

+ 1
- 2
docs/effect/README.md View File

@@ -11,8 +11,7 @@ Add dynamic elements to the 3D scene to allow the scene to move and run more clo
### example

```js
let weather = new DC.Weather()
viewer.use(weather)
let weather = new DC.Weather(viewer)
```

### creation

+ 48
- 91
docs/zh/base/README.md View File

@@ -8,54 +8,56 @@ sidebar: auto

**`DC`**

DC 为框架默认命名空间，使用该框架开发时都需要统以 `DC.` 开始
CDN 模式下使用 DC 为框架默认命名空间，使用该框架开发时都需要统以 `DC.` 开始

:::danger
开发时尽量不要使用 DC 为变量名或者命名空间，避免框架无法正常使用。
:::

## 全局配置
## 全局Api

### accessToken
### ready()

> 用于去除 logo 和控制端的输出信息。`不影响框架的使用`
> 框架主入口函数，使用框架时必须以其开始，否则使用框架

```js
DC.accessToken = '<your access token>'
DC.ready({}).then(()=>{})
```
- 参数
- `{Object} config`：配置参数
- 返回值 `Promise`

:::tip
Token 申请可通过 [http://dvgis.cn/#/price](http://dvgis.cn/#/price) 进行申请
:::
```json
//属性参数（可选）
{
"Cesium": '<自定义的Cesium库，如果未设置，将使用框架内部默认Cesium框架>',
"echarts": '<echarts库，设置后将加载echarts图层>',
"baseUrl": '<Cesium 静态资源路径，默认值为：“./libs/dc-sdk/resources/” >'
}
```

### baseUrl
### registerLib()

> 用于设置 `Cesium` 相关的静态资源文件: `Assets`、`Workers` 、`ThirdParty`、`Widgets` 的路径
> 框架中注册第三放框架包，

```js
DC.baseUrl = './libs/dc-sdk/resources/'
DC.ready(() => {})
DC.registerLib("turf",turf)
console.log(DC.__namspace.turf)
```
- 参数
- `{String} name`：名称
- `{Object} lib`: 库模块

:::warning
`baseUrl` 的设置需要在 `ready` 函数之前，否则将使用默认的设置 `./libs/dc-sdk/resources/`
:::

### __Namespace

> 第三方库的命名空间集合

## 全局函数
### getLib()

### ready

> 框架主入口，使用框架时必须以这个开始，否则无法构建 3D 场景
> 获取框架中注册的第三方框架包，

```js
DC.ready().then(()=>{
})
let turf = DC.getLib("turf")
```
- 参数
- `{String} name`：名称
- 返回值 `Object`

## 常量

@@ -139,6 +141,8 @@ DC.ready().then(()=>{

**_`DC.ImageryType.TENCENT`_**: 腾讯地图

**_`DC.ImageryType.GEO_VIS`_**: 星图地图

### TerrainType

**_`DC.TerrainType.NONE`_**: 无地形
@@ -165,18 +169,12 @@ DC.ready().then(()=>{

**_`DC.LayerType.CLUSTER`_**: 聚合图层

**_`DC.LayerType.CAMERA_VIDEO`_**: 相机视频图层

**_`DC.LayerType.PLANE_VIDEO`_**: 平面视频图层

**_`DC.LayerType.KML`_**: kml 图层

**_`DC.LayerType.CZML`_**: czml 图层

**_`DC.LayerType.HEAT`_**: 热区图层

**_`DC.LayerType.MAPV`_**: Mapv 图层

**_`DC.LayerType.CHART`_**: echarts 图层

### OverlayType
@@ -257,10 +255,6 @@ DC.ready().then(()=>{

**_`DC.OverlayType.VIDEO_PRIMITIVE`_**: 视频图元

**_`DC.OverlayType.CAMERA_VIDEO`_**: 视频融合

**_`DC.OverlayType.PLAN_VIDEO`_**: 平面视频

### TrackViewMode

**_`DC.TrackViewMode.FP`_**: 第一人称视角
@@ -271,41 +265,9 @@ DC.ready().then(()=>{

**_`DC.TrackViewMode.FREE`_**: 自由视角

### PositionEditorType

**_`DC.PositionEditorType.TRANSLATION`_**: 偏移

**_`DC.PositionEditorType.ROTATION`_**: 旋转

### ClippingDirection

**_`DC.ClippingDirection.UP`_**: 向上

**_`DC.ClippingDirection.DOWN`_**: 向下

**_`DC.ClippingDirection.LEFT`_**: 向左

**_`DC.ClippingDirection.RIGHT`_**: 向右

**_`DC.ClippingDirection.FRONT`_**: 向前

**_`DC.ClippingDirection.BACK`_**: 向后

### AnalysisType

**_`DC.AnalysisType.CONTOUR_LINE`_**：等高线

**_`DC.AnalysisType.SHADOWS`_**：阴影

**_`DC.AnalysisType.SIGHT_LINE`_**：通视分析（线）

**_`DC.AnalysisType.SIGHT_CIRCLE`_**：通视分析（圆）

**_`DC.AnalysisType.VIEWSHED`_**：可视域

## DC.Viewer

> 3D 场景主要接口，在给定的 DivId 中构建三维场景，也可用 DC.World.
> 3D 场景主要接口，在给定的 DivId 中构建三维场景

### example

@@ -329,7 +291,7 @@ global.viewer = viewer // 添加到全局变量
构造函数

- 参数
- `{String} id`：容器 ID
- `{String | Element } id`：容器 ID
- `{Object} options`：属性
- 返回值 `viewer`

@@ -355,7 +317,9 @@ global.viewer = viewer // 添加到全局变量

### properties

- `{Element} dcContainer`：框架自定义容器 **_`readonly`_**
- `{Element} container`：场景容器 **_`readonly`_**
- `{Element} widgetContainer`：场景组件容器 **_`readonly`_**
- `{Element} layerContainer`：场景图层容器 **_`readonly`_**
- `{Object} scene`：场景 **_`readonly`_**，详情参考：[Scene](http://resource.dvgis.cn/cesium-docs/Scene.html)
- `{Object} camera`：相机 **_`readonly`_**，详情参考：[Camera](http://resource.dvgis.cn/cesium-docs/Scene.html)
- `{Element} canvas`：canvas 节点 **_`readonly`_**
@@ -419,7 +383,7 @@ global.viewer = viewer // 添加到全局变量
"terrainExaggeration": 1, //地形夸张系数
"terrainExaggerationRelativeHeight": 1, //地形相对高度夸张系数
"baseColor": new DC.Color(0, 0, 0.5, 1), //地球默认底色
"filterColor": new DC.Color(0, 0, 0, 0), //瓦片过滤色
"filterColor": new DC.Color(0, 0, 0, 0), //瓦片过滤色,设置后不可逆
"translucency": {
//地表透明
"enabled": false, // 是否开启地表透明
@@ -473,10 +437,18 @@ global.viewer = viewer // 添加到全局变量
- 返回值 `this`

```json
//属性参数
//属性参数 (可选)
{
"name": "电子地图", //名称
"iconUrl": "../preview.png" //缩略图
"alpha" : 1.0,
"nightAlpha" : 1.0,
"dayAlpha" : 1.0,
"brightness" : 1.0,
"contrast" : 1.0,
"hue" : 1.0,
"saturation : 1.0,
"gamma : 1.0,
}
```

@@ -686,21 +658,6 @@ global.viewer = viewer // 添加到全局变量
- `{String} name` ：名称，默认为 scene
- 返回值 `this`

- **_use(plugin)_**

使用插件(`慎用`)，这个和全局的不同。该函数会将 3D 场景作为参数传入到插件中

- 参数
- `{Object} plugin` ：插件
- 返回值 `this`

```js
let plugin = {
install: (viewer) => {},
}
viewer.use(plugin)
```

## Popup

> 气泡窗口
@@ -1257,14 +1214,14 @@ let date = DC.JulianDate.now()

[JulianDate](http://resource.dvgis.cn/cesium-docs/JulianDate.html)

## DC.Rect
## DC.Rectangle

> 矩形相关函数

### example

```js
let r = DC.Rect.fromDegrees(10, 20, 12, 31)
let r = DC.Rectangle.fromDegrees(10, 20, 12, 31)
```

[详情参考](http://resource.dvgis.cn/cesium-docs/Rectangle.html)

+ 25
- 4
docs/zh/introduction/README.md View File

@@ -91,11 +91,10 @@ yarn add @dvgis/dc-sdk
```

```js
import * as DC from '@dvgis/dc-sdk' //基础包
import '@dvgis/dc-sdk/dist/dc.core.min.css' // 主要样式
import * as DC from '@dvgis/dc-sdk'
import '@dvgis/dc-sdk/dist/dc.core.min.css'
```


`CDN`

[下载链接](https://github.com/dvgis/dc-sdk/releases)
@@ -111,7 +110,7 @@ import '@dvgis/dc-sdk/dist/dc.core.min.css' // 主要样式

### 应用配置

由于 DC 框架中将 `CESIUM_BASE_URL` 设置为 `./libs/dc-sdk/resources/`，这样需将 `Cesium` 相关的静态资源文件: `Assets`、`Workers` 、`ThirdParty` 复制到工程的 `libs/dc-sdk/resources` 目录下以保证三维场景能够正常呈现,也可通过 `DC.baseUrl` 进行 `Cesium` 相关的静态资源路基设置
由于 DC 框架将Cesium静态资源默认路径设置为 `./libs/dc-sdk/resources/`，这样需将 `Cesium` 相关的静态资源文件: `Assets`、`Workers` 、`ThirdParty` 复制到工程的 `libs/dc-sdk/resources` 目录下以保证三维场景能够正常呈现,也可通过全局函数进行 `Cesium` 相关的静态资源路基设置

> `NPM / YARN`

@@ -224,6 +223,28 @@ DC.ready().then(() => {
<iframe src="https://dc.dvgis.cn/#/editor?type=info&example=start" frameborder="0" height="500px" width="100%" >
</iframe>

## 从 v2.0 迁移

- `修改框架引入方式修改`

```js
// import DC from '@dvgis/dc-sdk/dist/dc.base.min'
// import DcCore from '@dvgis/dc-sdk/dist/dc.core.min'
// import DcChart from '@dvgis/dc-sdk/dist/dc.chart.min'
// import DcMapv from '@dvgis/dc-sdk/dist/dc.mapv.min'
// import DcS3M from '@dvgis/dc-sdk/dist/dc.s3m.min'
// import '@dvgis/dc-sdk/dist/dc.core.min.css'
import * as DC from '@dvgis/dc-sdk'
import DC from '@dvgis/dc-sdk/dist/dc.min.css'
```

- `修改框架初始函数`

```js
// DC.ready(initViewer)
DC.ready().then(initViewer)
```

## 总架构图

> DC 架构图，建议使用前先熟悉整体架构图，以便能够快速使用。[查看大图](http://dc.dvgis.cn/examples/images/base/dc2.x.png)

+ 2
- 2
docs/zh/overlay/README.md View File

@@ -522,14 +522,14 @@ let circle = new DC.Circle(position, 200)
}
```

## DC.Rectangle
## DC.Rect

> 矩形要素，继承于[Overlay](#overlay)

### example

```js
let rectangle = new DC.Rectangle('-90.0,32.0;-94.0,36.0;')
let rectangle = new DC.Rect('-90.0,32.0;-94.0,36.0;')
```

### creation

+ 19
- 19
docs/zh/tile/README.md View File

@@ -30,7 +30,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createBaiduImageryLayer(options)_**

@@ -38,7 +38,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createGoogleImageryLayer(options)_**

@@ -46,7 +46,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createTdtImageryLayer(options)_**

@@ -54,7 +54,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createTencentImageryLayer(options)_**

@@ -62,7 +62,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createArcGisImageryLayer(options)_**

@@ -70,7 +70,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性，详情参考 [ArcGis](http://resource.dvgis.cn/cesium-docs/ArcGisMapServerImageryProvider.html#.ConstructorOptions)
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createSingleTileImageryLayer(options)_**

@@ -86,7 +86,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性，详情参考 [WMS](http://resource.dvgis.cn/cesium-docs/WebMapServiceImageryProvider.html#.ConstructorOptions)
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createWMTSImageryLayer(options)_**

@@ -94,7 +94,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性，详情参考 [WMTS](http://resource.dvgis.cn/cesium-docs/WebMapTileServiceImageryProvider.html#.ConstructorOptions)
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createXYZImageryLayer(options)_**

@@ -110,7 +110,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createGridImageryLayer(options)_**

@@ -118,7 +118,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性，详情参考 [Grid](http://resource.dvgis.cn/cesium-docs/GridImageryProvider.html#.ConstructorOptions)
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createMapboxImageryLayer(options)_**

@@ -126,7 +126,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性，详情参考 [Mapbox](http://resource.dvgis.cn/cesium-docs/MapboxImageryProvider.html#.ConstructorOptions)
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createMapboxStyleImageryLayer(options)_**

@@ -134,7 +134,7 @@ viewer.addBaseLayer(baseLayer, {

- 参数
- `{Object} options`：属性，详情参考 [Mapbox Style](http://resource.dvgis.cn/cesium-docs/MapboxStyleImageryProvider.html#.ConstructorOptions)
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

- **_createTMSImageryLayer(options)_**

@@ -151,7 +151,7 @@ viewer.addBaseLayer(baseLayer, {
- 参数
- `{String} type`：类型，参考：DC.ImageryType
- `{Object} options`：属性
- 返回值 `baseLayer`
- 返回值 `Promise<baseLayer>`

```json
//属性参数(可选)
@@ -191,7 +191,7 @@ viewer.addTerrain(terrain)

创建默认地形

returns `terrain`
returns `Promise<terrain>`

- **_createUrlTerrain(options)_**

@@ -199,7 +199,7 @@ viewer.addTerrain(terrain)

- 参数
- `{Object} options`：属性
- 返回值 `terrain`
- 返回值 `Promise<terrain>`

- **_createGoogleTerrain(options)_**

@@ -207,7 +207,7 @@ viewer.addTerrain(terrain)

- 参数
- `{Object} options`：属性
- 返回值 `terrain`
- 返回值 `Promise<terrain>`

- **_createArcgisTerrain(options)_**

@@ -215,7 +215,7 @@ viewer.addTerrain(terrain)

- 参数
- `{Object} options`：属性
- 返回值 `terrain`
- 返回值 `Promise<terrain>`

- **_createVRTerrain(options)_**

@@ -223,7 +223,7 @@ viewer.addTerrain(terrain)

- 参数
- `{Object} options`：属性
- 返回值 `terrain`
- 返回值 `Promise<terrain>`

- **_createTerrain(type，options)_**

@@ -232,7 +232,7 @@ viewer.addTerrain(terrain)
- 参数
- `{String} type`：类型，参考：DC.TerrainType
- `{Object} options`：属性
- 返回值 `terrain`
- 返回值 `Promise<terrain>`

```json
//属性参数（可选）

+ 1
- 1
docs/zh/tools/README.md View File

@@ -4,7 +4,7 @@ sidebar: auto

# 实用工具 🌎

三维场景中的辅助工具，方便在场景中进行各种测量、标绘、位置编辑
三维场景中的辅助工具，方便在场景中进行各种标绘、测量、位置编辑

## DC.Plot


Write Preview
Loading…
Cancel
Save