Browse Source

完善文档

tags/1.13.2
Caven Chen 4 years ago
parent
commit
88a26d9a10
2 changed files with 72 additions and 14 deletions
  1. 34
    5
      README.md
  2. 38
    9
      README_zh.md

+ 34
- 5
README.md View File



## Installation ## Installation


> CDN
`CDN`


```html ```html
<!--Basic Package--> <!--Basic Package-->
<link href="libs/dc-sdk/dc.core.min.css" rel="stylesheet" type="text/css" /> <link href="libs/dc-sdk/dc.core.min.css" rel="stylesheet" type="text/css" />
``` ```


> NPM / YARN
`NPM / YARN`


```shell ```shell
yarn add @dvgis/dc-sdk yarn add @dvgis/dc-sdk


## Setting ## Setting


> Vue
`Vue2.x`


```js ```js
// vue.config.js // vue.config.js
} }
``` ```


`Vue3.x`

```js
// vue.config.js

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

module.exports = {
// other settings
chainWebpack: config => {
config.resolve.alias.set('dvgis', path.resolve(__dirname, dvgisDist))
config.plugin('copy').use(CopywebpackPlugin, [
{
patterns: [
{
from: path.join(dvgisDist, 'dc-sdk/dist/resources'),
to: path.join(__dirname, 'dist', 'libs/dc-sdk/resources'),
},
],
}
])
}
}
```

## Start ## Start


```js ```js
| [dc-overlay](https://github.com/dvgis/dc-overlay) | <img src="https://img.shields.io/npm/v/@dvgis/dc-overlay?logo=npm" /> | dc overlay module, including ellipsoid, cylinder, corridor, water surface, etc | | [dc-overlay](https://github.com/dvgis/dc-overlay) | <img src="https://img.shields.io/npm/v/@dvgis/dc-overlay?logo=npm" /> | dc overlay module, including ellipsoid, cylinder, corridor, water surface, etc |
| [dc-plot](https://github.com/dvgis/dc-plot) | <img src="https://img.shields.io/npm/v/@dvgis/dc-plot?logo=npm" /> | dc plotting module for plotting and editing overlay | | [dc-plot](https://github.com/dvgis/dc-plot) | <img src="https://img.shields.io/npm/v/@dvgis/dc-plot?logo=npm" /> | dc plotting module for plotting and editing overlay |
| [dc-chart](https://github.com/dvgis/dc-chart) | <img src="https://img.shields.io/npm/v/@dvgis/dc-chart?logo=npm" /> | dc chart module for adding ECharts functionality in 3d scenes | | [dc-chart](https://github.com/dvgis/dc-chart) | <img src="https://img.shields.io/npm/v/@dvgis/dc-chart?logo=npm" /> | dc chart module for adding ECharts functionality in 3d scenes |
| [dc-mapv](https://github.com/dvgis/dc-mapv) | <img src="https://img.shields.io/npm/v/@dvgis/dc-mapv?logo=npm" /> | dc big-data module for adding MAPV functions in 3d scenes |
| [dc-ui](https://github.com/dvgis/dc-ui) | <img src="https://img.shields.io/npm/v/@dvgis/dc-ui?logo=npm" /> | dc components for Vue |
| [dc-mapv](https://github.com/dvgis/dc-mapv) | <img src="https://img.shields.io/npm/v/@dvgis/dc-mapv?logo=npm" /> | dc big-data module for adding MAPV functions in 3d scenes |
| [dc-ui](https://github.com/dvgis/dc-ui) | <img src="https://img.shields.io/npm/v/@dvgis/dc-ui?logo=npm" /> | dc components for Vue2.x |
| dc-analysis | <img src="https://img.shields.io/npm/v/@dvgis/dc-analysis?logo=npm" /> | dc analysis module, including camera-video, position-editor, measure, etc |
| dc-ui-next | <img src="https://img.shields.io/npm/v/@dvgis/dc-ui-next?logo=npm" /> | dc components for Vue3.x |


## QQ Group ## QQ Group



+ 38
- 9
README_zh.md View File



## 安装 ## 安装


> CDN
`CDN`


```html ```html
<!--基础包--> <!--基础包-->
<!--主要样式--> <!--主要样式-->
<link href="libs/dc-sdk/dc.core.min.css" rel="stylesheet" type="text/css" /> <link href="libs/dc-sdk/dc.core.min.css" rel="stylesheet" type="text/css" />
``` ```
> NPM / YARN
`NPM / YARN`


```shell ```shell
yarn add @dvgis/dc-sdk yarn add @dvgis/dc-sdk


## 配置 ## 配置


> Vue
`Vue2.x`


```js ```js
// vue.config.js vue 文件
// vue.config.js


const path = require('path') const path = require('path')
const CopywebpackPlugin = require('copy-webpack-plugin') const CopywebpackPlugin = require('copy-webpack-plugin')
} }
``` ```


`Vue3.x`

```js
// vue.config.js

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

module.exports = {
// 其他配置
chainWebpack: config => {
config.resolve.alias.set('dvgis', path.resolve(__dirname, dvgisDist))
config.plugin('copy').use(CopywebpackPlugin, [
{
patterns: [
{
from: path.join(dvgisDist, 'dc-sdk/dist/resources'),
to: path.join(__dirname, 'dist', 'libs/dc-sdk/resources'),
},
],
}
])
}
}
```

## 开始 ## 开始


```js ```js
## 生态 ## 生态


| 模块名称 | 状态 | 描述 | | 模块名称 | 状态 | 描述 |
| :---- | :------: | :------ |
| :------ | :------: | :------ |
| [dc-plugins](https://github.com/dvgis/dc-plugins) | <img src="https://img.shields.io/npm/v/@dvgis/dc-plugins?logo=npm" /> | DC插件模块,包括场景动画、漫游以及一些额外的材质 | | [dc-plugins](https://github.com/dvgis/dc-plugins) | <img src="https://img.shields.io/npm/v/@dvgis/dc-plugins?logo=npm" /> | DC插件模块,包括场景动画、漫游以及一些额外的材质 |
| [dc-overlay](https://github.com/dvgis/dc-overlay) | <img src="https://img.shields.io/npm/v/@dvgis/dc-overlay?logo=npm" /> | DC要素模块,包括球体、柱体、军标、水面等 | | [dc-overlay](https://github.com/dvgis/dc-overlay) | <img src="https://img.shields.io/npm/v/@dvgis/dc-overlay?logo=npm" /> | DC要素模块,包括球体、柱体、军标、水面等 |
| [dc-plot](https://github.com/dvgis/dc-plot) | <img src="https://img.shields.io/npm/v/@dvgis/dc-plot?logo=npm" /> | DC标绘模块,用于要素的标绘和编辑 | | [dc-plot](https://github.com/dvgis/dc-plot) | <img src="https://img.shields.io/npm/v/@dvgis/dc-plot?logo=npm" /> | DC标绘模块,用于要素的标绘和编辑 |
| [dc-chart](https://github.com/dvgis/dc-chart) | <img src="https://img.shields.io/npm/v/@dvgis/dc-chart?logo=npm" /> | DC图表模块,用于在三维场景中添加echarts功能 |
| [dc-mapv](https://github.com/dvgis/dc-mapv) | <img src="https://img.shields.io/npm/v/@dvgis/dc-mapv?logo=npm" /> | DC大数据模块,用于在三维场景中添加mapv功能 |
| [dc-ui](https://github.com/dvgis/dc-ui) | <img src="https://img.shields.io/npm/v/@dvgis/dc-ui?logo=npm" /> | DC组件开发框架,将DC功能Vue模块化|
| [dc-chart](https://github.com/dvgis/dc-chart) | <img src="https://img.shields.io/npm/v/@dvgis/dc-chart?logo=npm" /> | DC图表模块,用于在三维场景中添加Echarts功能 |
| [dc-mapv](https://github.com/dvgis/dc-mapv) | <img src="https://img.shields.io/npm/v/@dvgis/dc-mapv?logo=npm" /> | DC大数据模块,用于在三维场景中添加Mapv功能 |
| [dc-ui](https://github.com/dvgis/dc-ui) | <img src="https://img.shields.io/npm/v/@dvgis/dc-ui?logo=npm" /> | DC基于Vue2.x组件开发框架,将DC功能Vue模块化 |
| dc-analysis | <img src="https://img.shields.io/npm/v/@dvgis/dc-analysis?logo=npm" /> | DC分析模块,包括视频融合,位置编辑、测量等 |
| dc-ui-next | <img src="https://img.shields.io/npm/v/@dvgis/dc-ui-next?logo=npm" /> | DC基于Vue3.x组件开发框架,将DC功能Vue模块化 |


## QQ 群 ## QQ 群



Loading…
Cancel
Save