瀏覽代碼

update docs

tags/3.2.0
cavencj 2 年之前
父節點
當前提交
d1198cf04b

.markdownlintrc → .markdownlint.json 查看文件

"colors": true, "colors": true,
"header-increment": false, "header-increment": false,
"line-length": false, "line-length": false,
"no-trailing-punctuation": {"punctuation": ".,;:"},
"no-trailing-punctuation": {
"punctuation": ".,;:"
},
"no-duplicate-header": false, "no-duplicate-header": false,
"no-inline-html": false, "no-inline-html": false,
"no-hard-tabs": false, "no-hard-tabs": false,
"whitespace": false
}
"whitespace": false,
"link-fragments": false
}

+ 2
- 2
docs/zh/api/effect-animation.md 查看文件

"clampToTileset": false, // 是否贴物 "clampToTileset": false, // 是否贴物
"interpolationType": "Linear", // 插值类型:Linear、Hermite、Lagrange "interpolationType": "Linear", // 插值类型:Linear、Hermite、Lagrange
"interpolationDegree": 2, // 插值度数 "interpolationDegree": 2, // 插值度数
"endDelayTime": 0.5,// 结束时间延长时间,单位:秒,
"headingOffset":0,//旋转偏移
"endDelayTime": 0.5, // 结束时间延长时间,单位:秒,
"headingOffset": 0 //旋转偏移
} }
``` ```



+ 0
- 3
docs/zh/api/effect-scene.md 查看文件

- `{Number} length`:长度 - `{Number} length`:长度
- `{Array} selected`:设置后期作用的覆盖物 - `{Array} selected`:设置后期作用的覆盖物




## DC.CircleScan ## DC.CircleScan


> 扫描圈,继承于[Animation](#animation) > 扫描圈,继承于[Animation](#animation)
} }
``` ```



## DC.RadarScan ## DC.RadarScan


> 雷达扫描,继承于[Animation](#animation) > 雷达扫描,继承于[Animation](#animation)

+ 10
- 7
docs/zh/api/global.md 查看文件

> 框架主入口函数,使用框架时必须以其开始,否则使用框架 > 框架主入口函数,使用框架时必须以其开始,否则使用框架


```js ```js
DC.ready({}).then(()=>{})
DC.ready({}).then(() => {})
``` ```

- 参数 - 参数
- `{Object} config`:配置参数 - `{Object} config`:配置参数
- 返回值 `Promise` - 返回值 `Promise`
```json ```json
//属性参数(可选) //属性参数(可选)
{ {
"Cesium": '<自定义的Cesium库,如果未设置,将使用框架内部默认Cesium框架>',
"echarts": '<echarts库,设置后将加载echarts图层>',
"baseUrl": '<Cesium 静态资源路径,默认值为:“./libs/dc-sdk/resources/” >'
"Cesium": "<自定义的Cesium库,如果未设置,将使用框架内部默认Cesium框架>",
"echarts": "<echarts库,设置后将加载echarts图层>",
"baseUrl": "<Cesium 静态资源路径,默认值为:“./libs/dc-sdk/resources/” >"
} }
``` ```


> 框架中注册第三放框架包, > 框架中注册第三放框架包,


```js ```js
DC.registerLib("turf",turf)
console.log(DC.__namspace.turf)
DC.registerLib('turf', turf)
console.log(DC.__namespace.turf)
``` ```

- 参数 - 参数
- `{String} name`:名称 - `{String} name`:名称
- `{Object} lib`: 库模块 - `{Object} lib`: 库模块
> 获取框架中注册的第三方框架包, > 获取框架中注册的第三方框架包,


```js ```js
let turf = DC.getLib("turf")
let turf = DC.getLib('turf')
``` ```

- 参数 - 参数
- `{String} name`:名称 - `{String} name`:名称
- 返回值 `Object` - 返回值 `Object`

+ 1
- 1
docs/zh/api/layer.md 查看文件

### example ### example


```js ```js
let layer = new DC.ClusterLayer('id',{image:''})
let layer = new DC.ClusterLayer('id', { image: '' })
viewer.addLayer(layer) viewer.addLayer(layer)
``` ```



+ 6
- 10
docs/zh/api/overlay-vector.md 查看文件



- 参数 - 参数
- `{Object} entity`:Cesium 覆盖物 - `{Object} entity`:Cesium 覆盖物
- 返回值 `billbard`
- 返回值 `billboard`


## DC.Label ## DC.Label


### properties ### properties


- `{Position|String|Array} position`:坐标 - `{Position|String|Array} position`:坐标
- `{String|Element} content`:内容 **_`writeonly`_**
- `{String|Element} content`:内容 **_`writeOnly`_**


### methods ### methods


} }
``` ```






## DC.Corridor ## DC.Corridor


> 走廊要素,继承于[Overlay](#overlay) > 走廊要素,继承于[Overlay](#overlay)


### example ### example


```js
let position = new DC.Position(120, 20)
let ellipsoid = new DC.Ellipsoid(position, { x: 30, y: 30, z: 30 })
```
```js
let position = new DC.Position(120, 20)
let ellipsoid = new DC.Ellipsoid(position, { x: 30, y: 30, z: 30 })
```


### creation ### creation



+ 1
- 1
docs/zh/api/tile.md 查看文件

//属性参数(可选) //属性参数(可选)
{ {
"url": "", //地址:arcgis/wmts/xyx/single 有效 "url": "", //地址:arcgis/wmts/xyx/single 有效
"style": "img", //样式:img、elec、ter。百度:normal、middlenight、dark,腾讯:img,1、4
"style": "img", //样式:img、elec、ter。百度:normaldark,腾讯:img,1、4
"key": "", //认证,仅天地图有效 "key": "", //认证,仅天地图有效
"subdomains": [], "subdomains": [],
"crs":"WGS84",// 坐标系: WGS84 、BD09 、GCJ02,仅百度、高德有效 "crs":"WGS84",// 坐标系: WGS84 、BD09 、GCJ02,仅百度、高德有效

+ 1
- 1
docs/zh/guide/from-v2.md 查看文件

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

+ 11
- 11
docs/zh/guide/get-start.md 查看文件

``` ```


```js ```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` `CDN`


## 应用配置 ## 应用配置


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


> `npm / yarn / pnpm` > `npm / yarn / pnpm`


// webpack.config.js // webpack.config.js


const path = require('path') const path = require('path')
const CopywebpackPlugin = require('copy-webpack-plugin')
const CopyWebpackPlugin = require('copy-webpack-plugin')
const dvgisDist = './node_modules/@dvgis' const dvgisDist = './node_modules/@dvgis'


module.exports = { module.exports = {
// vue.config.js // vue.config.js


const path = require('path') const path = require('path')
const CopywebpackPlugin = require('copy-webpack-plugin')
const CopyWebpackPlugin = require('copy-webpack-plugin')
const dvgisDist = './node_modules/@dvgis' const dvgisDist = './node_modules/@dvgis'


module.exports = { module.exports = {
// 其他配置 // 其他配置
chainWebpack: (config) => { chainWebpack: (config) => {
config.plugin('copy').use(CopywebpackPlugin, [
config.plugin('copy').use(CopyWebpackPlugin, [
[ [
{ {
from: path.join(dvgisDist, 'dc-sdk/dist/resources'), from: path.join(dvgisDist, 'dc-sdk/dist/resources'),
// vue.config.js // vue.config.js


const path = require('path') const path = require('path')
const CopywebpackPlugin = require('copy-webpack-plugin')
const CopyWebpackPlugin = require('copy-webpack-plugin')
const dvgisDist = './node_modules/@dvgis' const dvgisDist = './node_modules/@dvgis'


module.exports = { module.exports = {
// 其他配置 // 其他配置
chainWebpack: (config) => { chainWebpack: (config) => {
config.plugin('copy').use(CopywebpackPlugin, [
config.plugin('copy').use(CopyWebpackPlugin, [
{ {
patterns: [ patterns: [
{ {


```js ```js
// vite.config.js // vite.config.js
import { defineConfig } from "vite";
import DC from "@dvgis/vite-plugin-dc";
import { defineConfig } from 'vite'
import DC from '@dvgis/vite-plugin-dc'
export default defineConfig({ export default defineConfig({
plugins: [DC()], plugins: [DC()],
});
})
``` ```


`CDN` `CDN`

+ 1
- 1
docs/zh/index.md 查看文件

- theme: brand - theme: brand
text: 快速开始 text: 快速开始
link: /zh/guide/introduction link: /zh/guide/introduction
features:
features:
- title: 简单 - title: 简单
details: 仅仅一个div和几行代码就能构建一个三维WebGis应用 details: 仅仅一个div和几行代码就能构建一个三维WebGis应用
- title: 易用 - title: 易用

Loading…
取消
儲存