cesium_dev_kit 1.0.53 → 1.0.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +21 -82
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -12,57 +12,7 @@
12
12
 
13
13
  旨在封装一个 Cesium 基本操作的工具包,提供简单的方法调用来实现复杂的 API 操作;达到节省阅读 Cesium 原文档时间,从而降低入门难度提升学习信心,同时也希望能提高工作效率减少重复劳动;案例中封装了常用功能配备使用案例,npm 安装后可以直接在项目中使用。
14
14
 
15
- ## 目录结构
16
-
17
- ```md
18
- ├── public # 静态资源
19
- │ ├── static # 模型文件
20
- │ │ ├── data # 3dtiles 及 model
21
- | └── favicon.ico # favicon 图标
22
- ├── src # 源代码
23
- | ├── api # api 请求
24
- | ├── assets # 主题 变量等资源
25
- | | ├── scss # scss 变量
26
- | | └──theme # elemet 主题
27
- | ├── libs
28
- | | ├── directive # 全局指令
29
- | | └──element.ts # elemet 全局样式重写
30
- | ├──components # 全局公共组件
31
- | ├──hooks # 全局 hooks
32
- | ├── config # 全局公共配置
33
- | ├── layout # 全局 layout
34
- | ├── locale # 国际化
35
- | ├── plugin # 三方插件
36
- | ├── router # 全局路由
37
- | ├── store # 全局 vuex
38
- | ├── utils # 全局公用方法
39
- | | └──cesiumPluginsExtends # cesium 扩展工具包
40
- | ├── views # 所有页面
41
- | | └──example # cesium 扩展工具包案例
42
- | ├── App.tsx # 入口页面
43
- | ├── main.ts # 入口文件
44
- | ├── permission.ts #权限认证
45
- | └── shims-vue.d.ts # ts 声明文件
46
- ├── static # 静态资源
47
- | ├── img # img
48
- | └── svg # svg
49
- ├── .editorconfig # editorconfig
50
- ├── .env.development # 环境变量 开发
51
- ├── .env.production # 环境变量 生产
52
- ├── .eslintignore # eslintignore
53
- ├── .eslintrc.js # eslint 配置项
54
- ├── .gitignore # gitignore
55
- ├── .babelrc # babel 配置项
56
- ├── index.html # html 模板
57
- ├── package.json # package.json
58
- ├── README.md # README
59
- ├── tsconfig.json # tsconfig
60
- └── vite.config.ts # vite 配置文件
61
- ```
62
-
63
- ##
64
-
65
- ## 项目演示
15
+ ## 功能展示
66
16
 
67
17
  - 材质
68
18
  ![material](https://github.com/dengxiaoning/cesium_dev_kit/blob/master/src/assets/image/preview/material.gif)
@@ -79,27 +29,23 @@
79
29
 
80
30
  [https://www.benpaodehenji.com/cesiumDevKit](https://www.benpaodehenji.com/cesiumDevKit)
81
31
 
82
- ## 项目安装与使用
32
+ ## 安装
83
33
 
84
- - 1、直接运行本案例项目
34
+ ```shell
85
35
 
86
- ```
87
- c:\> git clone https://github.com/dengxiaoning/cesium_dev_kit.git
88
- c:\> cd cesium_dev_kit
89
- c:\> npm install
90
- c:\> npm run dev
36
+ npm install cesium_dev_kit
91
37
 
92
38
  ```
93
39
 
94
- - 2、作为 libs 安装到已有项目中
40
+ ## 引入
95
41
 
96
- ```shell
42
+ ```
97
43
 
98
- c:\> npm install cesium_dev_kit
44
+ import { initCesium } from 'cesium_dev_kit'
99
45
 
100
46
  ```
101
47
 
102
- - 2.1、项目中使用案例
48
+ ## 使用
103
49
 
104
50
  ```javaScript
105
51
  // test.vue
@@ -148,7 +94,17 @@ export default {
148
94
  </script>
149
95
  ```
150
96
 
151
- - 2.2、initCesium({}) 参数说明
97
+ ## API
98
+
99
+ ### initCesium
100
+
101
+ **参数**
102
+
103
+ - `cesiumGlobal` **Object** Ceiusm 对象
104
+ - `containerId` **String** 容器 id
105
+ - `viewerConfig` **Object** viewer 基础配置(与官网一致)
106
+ - `extreaConfig` **Object** 额外参数配置,如 {logo:true// 是否显示 logo, depthTest:true //开启深度检测}
107
+ - `MapImageryList` **Object** 配置底图,参考 ImageryProvider
152
108
 
153
109
  ```javaScript
154
110
  /**
@@ -189,7 +145,7 @@ export default {
189
145
  */
190
146
  ```
191
147
 
192
- - 2.3、NPM 安装引入案例
148
+ ## 参考案例
193
149
 
194
150
  [https://github.com/dengxiaoning/cesium_kit_test](https://github.com/dengxiaoning/cesium_kit_test)这是一个 vue 项目已安装 cesium_dev_kit,其中有使用 demo,可直接下载到本地运行查看参照
195
151
 
@@ -201,23 +157,6 @@ export default {
201
157
 
202
158
  支持现代(chrome,Firefox,Microsoft edge,etc.)浏览器, 不支持 IE
203
159
 
204
- ## CesiumGlsl 文档
205
-
206
- ```
207
- https://cesium.com/downloads/cesiumjs/releases/b23/Documentation/index.html
208
-
209
- ```
210
-
211
- ## iconify 使用方法
212
-
213
- [官网 https://icon-sets.iconify.design](https://icon-sets.iconify.design)
214
-
215
- ```
216
-
217
- <CIcon icon-class="bx:time-five" icon-color="#333" />
218
-
219
- ```
220
-
221
160
  ## 鸣谢
222
161
 
223
162
  [cesium-d3kit](https://github.com/zhangti0708/cesium-d3kit)<br/>
@@ -231,4 +170,4 @@ https://cesium.com/downloads/cesiumjs/releases/b23/Documentation/index.html
231
170
  - 2、未配备使用文档(请参考案例)
232
171
  - 3、未作异常捕捉和处理
233
172
 
234
- <small>感兴趣朋友可以一起讨论交流继续完善功能,提升自己帮助他人。欢迎进行 fork,同时也请给个 star 以示鼓励谢谢。</small>
173
+ <small>感兴趣朋友可以一起讨论交流继续完善功能,提升自己帮助他人。</small>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "cesium_dev_kit",
3
- "version": "1.0.53",
4
- "description": "本项目是一个封装 Cesium 基本操作的工具包,提供简单的方法调用来实现复杂的 API 操作;节省阅读 Cesium 原文档时间,从而降低入门难度增加学习信心,同时也希望能提高工作效率",
3
+ "version": "1.0.54",
4
+ "description": "这是一个封装 Cesium 基本操作的工具包,提供简单的方法调用来实现复杂的 API 操作。",
5
5
  "main": "index.js",
6
6
  "scripts": {
7
7
  "test": "echo \"Error: no test specified\" && exit 1",