diff --git a/README.md b/README.md index ca6c548f..06428459 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,6 @@ ![操作](https://images.gitee.com/uploads/images/2021/0703/094742_c0243f70_1728982.gif "2021-07-03_09-43-50.gif") -**[更多社区大屏](https://ajreport.beliefteam.cn/report-doc/guide/bigScreenCase.html)**
-**[社区大屏下载链接](https://ajreport.beliefteam.cn/download/)**
- ## 数据流程图 ![An image](https://images.gitee.com/uploads/images/2021/0630/160451_31bb9052_1728982.png) @@ -96,7 +93,13 @@ **[运行环境参考文档](https://ajreport.beliefteam.cn/report-doc/guide/quicklyDevelop.html)**
**注意版本兼容性**
-源码 doc -> docs -> guide 目录下即所有文档
+源码 doc -> docs -> guide 目录下即所有文档。
+启动文档(在线文档图片多,打开很慢可以本地启动文档,方便查看)
+ +``` +cd .\doc\ +npm run docs:dev +``` ### 发行版部署 @@ -147,12 +150,17 @@ http://serverip:9095 ``` +### 前后端分离部署 + **[前后端分离部署参考文档](https://ajreport.beliefteam.cn/report-doc/guide/quicklySeparate.html)**
-## 操作手册 +## 快速入门 + +**[快速入门](https://ajreport.beliefteam.cn/report-doc/guide/quicklyUse.html)**
-新建数据源(重置mysql数据源) --> 新建数据集(编写sql) --> 新建大屏(设计大屏)
-**[在线文档](https://ajreport.beliefteam.cn/report-doc/guide/datasource.html)** +**[更多社区大屏](https://ajreport.beliefteam.cn/report-doc/guide/bigScreenCase.html)**
+ +**[社区大屏下载链接](https://ajreport.beliefteam.cn/download/)**
## SQL初始化 @@ -197,14 +205,15 @@ aj_report(存放系统基础数据)数据库
## 商业授权 -AJ-Report使用[Apache2.0开源协议](http://www.apache.org/licenses/LICENSE-2.0.html),允许商业使用,但务必保留类作者、Copyright信息。
+AJ-Report使用[Apache2.0开源协议](http://www.apache.org/licenses/LICENSE-2.0.html) +,允许商业使用,但务必保留类作者、Copyright信息。
个人和企业,在直接使用、二次开发后商业使用,需要遵守: -- 包含AJ-Report LICENSE文件(授权使用者免费使用AJ-Report专利和知识产权) +- 包含Apache LICENSE文件(授权使用者免费使用AJ-Report专利和知识产权) - 如果修改了代码,需要在被修改的文件中说明 - 在修改和有源代码衍生的代码中,需要带有原来代码中的协议,商标 -- 在二次开发后商业发布的产品中,使用了多个开源软件,则必须包含一个Notice文件,在Notice文件中需要带有AJ-Report - LICENSE。你可以在Notice中增加自己的许可,但不可以表现为对AJ-Report +- 在二次开发后商业发布的产品中,使用了多个开源软件,则必须包含一个Notice文件,在Notice文件中需要带有Apache + LICENSE。你可以在Notice中增加自己的许可,但不可以表现为对Apache LICENSE构成更改。 ## 技术支持 diff --git a/doc/docs/.vuepress/config.js b/doc/docs/.vuepress/config.js index 97865c9d..a660304f 100644 --- a/doc/docs/.vuepress/config.js +++ b/doc/docs/.vuepress/config.js @@ -44,6 +44,7 @@ module.exports = { {title: '发行版部署', path: '/guide/quicklyDistribution'}, {title: '源码部署', path: '/guide/quicklySource'}, {title: '前后端分离', path: '/guide/quicklySeparate'}, + {title: '快速使用', path: '/guide/quicklyUse'}, ] }, { diff --git a/doc/docs/guide/dashboard.md b/doc/docs/guide/dashboard.md index 42e35761..fb6af523 100644 --- a/doc/docs/guide/dashboard.md +++ b/doc/docs/guide/dashboard.md @@ -13,10 +13,3 @@ 左侧为工具栏和图层,上方为功能栏,右侧为配置栏,中间为画布。
![img_2.png](../picture/dashboard/img_2.png)
-## 工具栏 - -![img24](../picture/dashboard/img_24.png)
- -## 图层 - -![img25](../picture/dashboard/img_25.png)
diff --git a/doc/docs/guide/dataset.md b/doc/docs/guide/dataset.md index f4e07d4d..6d966bfa 100644 --- a/doc/docs/guide/dataset.md +++ b/doc/docs/guide/dataset.md @@ -49,12 +49,9 @@ #### 高级规则 -是用是针对当前行的参数示例值做一个校验。
-返回 true/false,代表校验字段是否符合要求的成功与失败。
-返回 String,代表通过一段 js 脚本生成你所需要的参数。
-返回其他类型报错!!!
+自定义JS,这里的JS是java的scriptengine执行的,支持ES5的写法。 -``` +```js //返回yyyyy-MM-dd类型的当前时间 function verification(data){ //自定义脚本内容 @@ -80,11 +77,10 @@ function verification(data){ #### js脚本 -**注**:这里的JS是java的scriptengine执行的,很多ES6的语法不支持。
![img4](../picture/dateset/img_4.png)
入参是data,返回值也必须是data,中间是JS的处理过程,注意入参返回都是``List`` -``` +```js // 根据sql查询出的结果进行数据清洗 function dataTransform(data){ //自定义脚本内容 @@ -124,4 +120,4 @@ function dataTransform(data){ ### 数据预览 -针对此次数据集,进行数据预览,尽量不要使用 select * from table,可能数据量过大,超过数据库字段长度限制,保存不了。
+针对此次数据集,进行数据预览,尽量不要使用 select * from table
diff --git a/doc/docs/guide/question.md b/doc/docs/guide/question.md index 0c6e6c25..6a6a2ee6 100644 --- a/doc/docs/guide/question.md +++ b/doc/docs/guide/question.md @@ -116,19 +116,10 @@ ## 数据集相关 -- 系统异常,后台日志显示“** Data too long for colum ** ”
- 查询到的数据太多了,无法入库,这里查询入库的数据只作为在使用动态数据时做解析用
- 1、建议不要使用 "select *"
- 2、一张图表能承载的数据量是有限的,太多则图表展示不出来、页面卡死等
- 3、必须使用 "select *" ,或者展示很多数据。解决方法,将测试预览的值删掉只剩一条,注意数据的结构 [{}]
- ## 大屏图表组件相关 -- 访问大屏,浏览器白屏
- 设计完大屏,保存后进行预览,发现背景全白
- 1、回到编辑页面,查看大屏背景颜色是否设置
- 2、查看大屏的宽高,如果宽高都是0,大屏背景图片,颜色,皆无法显示
- 3、大屏宽高改成 1920 1080
+- 访问大屏,发现图表X轴、Y轴等显示不出来,但数值、柱子、折线又能显示
+ 问题原因:每个图表,比如X轴、Y轴颜色默认就是白色,当背景色也设置为白色时,就无法显示,其他同理。

diff --git a/doc/docs/guide/quicklyUse.md b/doc/docs/guide/quicklyUse.md new file mode 100644 index 00000000..bfe77bed --- /dev/null +++ b/doc/docs/guide/quicklyUse.md @@ -0,0 +1,32 @@ +以下示例数据存在于aj_report_init.sql文件中,该文件在源码doc/example目录下 + +## 新增数据源 + +![img](../picture/quickly/img_14.png)
+![img_6.png](../picture/quickly/img_6.png)
+ +## 新增数据集 + +![img_1.png](../picture/dateset/img_1.png)
+ +## 新增报表 + +根据报表类型区分大屏报表、Excel报表 +![img](../picture/reportmanager/img.png)
+ +### 大屏设计 + +![img_2.png](../picture/dashboard/img_2.png)
+![img1](../picture/quickly/img_1.png)
+ +### 大屏预览 + +![img15](../picture/quickly/img_15.png)
+ +### Excel设计 + +![img3](../picture/excel/img_2.png)
+ +### Excel预览 + +![img](../picture/excel/img_5.png)
diff --git a/doc/docs/picture/dashboard/img_2.png b/doc/docs/picture/dashboard/img_2.png index b88d1e22..d3e6c536 100644 Binary files a/doc/docs/picture/dashboard/img_2.png and b/doc/docs/picture/dashboard/img_2.png differ diff --git a/doc/docs/picture/quickly/img_1.png b/doc/docs/picture/quickly/img_1.png new file mode 100644 index 00000000..01e3ff1d Binary files /dev/null and b/doc/docs/picture/quickly/img_1.png differ diff --git a/doc/docs/picture/quickly/img_15.png b/doc/docs/picture/quickly/img_15.png new file mode 100644 index 00000000..402ea9aa Binary files /dev/null and b/doc/docs/picture/quickly/img_15.png differ