qianming 3 anni fa
parent
commit
bb8b06f3c6

+ 1 - 1
README.md

@@ -26,7 +26,7 @@
 
 ![视频](https://report.anji-plus.com/report-doc/static/Rhea.mp4) <br>
 
-**[更多案例](https://report.anji-plus.com/report-doc/guide/bigScreenCase.html)** <br>
+**[更多社区大屏案例](https://report.anji-plus.com/report-doc/guide/bigScreenCase.html)** <br>
 
 ## 数据流程图
 

+ 1 - 1
doc/docs/.vuepress/config.js

@@ -72,7 +72,7 @@ module.exports = {
                         {title: '搭建AJ-Report开发环境', path: '/guide/community/AC1688/搭建aj-report开发环境'}
                     ]
                 }
-                ],
+            ],
         }
     },
     plugins: [

+ 10 - 8
doc/docs/guide/README.md

@@ -10,29 +10,31 @@
 
 ## 在线体验
 
-#### &emsp; 电脑在线体验: [https://report.anji-plus.com/index.html](https://report.anji-plus.com/index.html "链接")  &emsp;体验账号:guest 密码:guest
+#### &emsp; [在线体验](https://report.anji-plus.com/index.html "链接"): https://report.anji-plus.com/index.html  &emsp;体验账号:guest 密码:guest
 
-#### &emsp; 在线文档: [https://report.anji-plus.com/report-doc/](https://report.anji-plus.com/report-doc/ "doc")<br>
+#### &emsp; [在线文档](https://report.anji-plus.com/report-doc/ "doc"): https://report.anji-plus.com/report-doc/ <br>
 
-#### &emsp; 在线提问: [https://gitee.com/anji-plus/report/issues](https://gitee.com/anji-plus/report/issues "issue")<br>
+#### &emsp; [在线提问](https://gitee.com/anji-plus/report/issues "issue"): https://gitee.com/anji-plus/report/issues <br>
 
 ## 发行版本
 
-#### &emsp; 下载链接:[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases "下载链接")<br>
+#### &emsp; [下载链接](https://gitee.com/anji-plus/report/releases "下载链接"): https://gitee.com/anji-plus/report/releases <br>
 
 ## 功能概述
 
 #### &emsp; 组件介绍
 
 &emsp;&emsp; 大屏设计(AJ-Report)是一个可视化拖拽编辑的,直观,酷炫,具有科技感的图表工具全开源项目。 内置的基础功能包括数据源,数据集,报表管理,项目部分截图如下。<br>
-**在线案例还在努力创造中,敬请期待!!!**
-![操作](../picture/shipin.gif)
 
-![更多案例](https://report.anji-plus.com/report-doc/static/Rhea.mp4) <br>
+![操作](https://images.gitee.com/uploads/images/2021/0703/094742_c0243f70_1728982.gif "2021-07-03_09-43-50.gif")
+
+![视频](https://report.anji-plus.com/report-doc/static/Rhea.mp4) <br>
+
+**[更多社区大屏案例](https://report.anji-plus.com/report-doc/guide/bigScreenCase.html)** <br>
 
 ## 数据流程图
 
-![流程.png](../picture/liucheng.png)
+![An image](https://images.gitee.com/uploads/images/2021/0630/160451_31bb9052_1728982.png)
 
 ## 打包目录
 

+ 8 - 0
doc/docs/guide/authmanager.md

@@ -1,11 +1,15 @@
 ## 新增用户
+
 ![img](../picture/authmanager/img.png) <br>
 
 ![img](../picture/authmanager/img_1.png) <br>
+
 新增用户的默认密码是在bootstrap.yml文件中配置的 <br>
+
 ![img](../picture/authmanager/img_2.png) <br>
 
 ## 用户授权
+
 **注意**:新建用户完成后需要给用户授权,否则新用户登陆是啥也看不到。<br>
 ![img](../picture/authmanager/img_3.png) <br>
 
@@ -13,15 +17,19 @@
 **注**:这里没有给新用户赋予默认角色的原因是,在角色管理中角色是可以被删除和修改的,因此在新建用户时需要手动的去授权角色 <br>
 
 ## 角色管理
+
 ![img](../picture/authmanager/img_5.png) <br>
 
 ## 权限分配
+
 为角色分配权限,可看已有角色示例 <br>
 ![img](../picture/authmanager/img_6.png) <br>
 
 ## 导入导出权限
+
 **注**:现在guest用户的权限是底层写死只有访问权限,无实质操作权限。<br>
 导入导出的权限是在 角色 --> 分配权限中控制。 <br>
+
 ![img](../picture/authmanager/img_7.png) <br>
 用户绑定了角色,角色则绑定了权限,是这样一层关系。 <br>
 

+ 23 - 2
doc/docs/guide/dashboard.md

@@ -1,4 +1,5 @@
 ## 设计大屏
+
 进入大屏设计方法1: <br>
 从报表管理模块选择需要设计的大屏,按图示进入大屏设计界面 <br>
 ![img](../picture/dashboard/img22.png) <br>
@@ -8,35 +9,45 @@
 ![img](../picture/dashboard/img23.png) <br>
 
 ## 大屏简介
+
 ![img_2.png](../picture/dashboard/img_2.png) <br>
 
 ## 工具栏
+
 ### 文本框
+
 ![img_3.png](../picture/dashboard/img_3.png) <br>
 ![img_4.png](../picture/dashboard/img_4.png) <br>
 ![img_5.png](../picture/dashboard/img_5.png) <br>
 ![img_6.png](../picture/dashboard/img_6.png) <br>
 
 ### 滚动文本
+
 已支持动态数据,请参考文本框的操作 <br>
 
 ### 超链接
+
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 当前时间
+
 已支持多种时间格式,其他格式请提Issue <br>
 ![img_1.png](../picture/dashboard/img_1.png) <br>
 
 ### 图片
+
 ![img_7.png](../picture/dashboard/img_7.png) <br>
 
 ### 视屏
+
 **暂不支持循环播放**<br>
 
 ### 内联框架
+
 当超链接和视频链接无效的时候,请尝试使用内联框架<br>
 
 ### 表格
+
 ![img](../picture/dashboard/img_22.png) <br>
 表格字段对应的数据只选择“文本数字”。<br>
 ![img14](../picture/dashboard/img_23.png) <br>
@@ -44,31 +55,36 @@
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 柱状图
+
 柱状图数据集对应字典值需要选择一个“X轴”、“柱状”,只需要2个字段 <br>
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
-
 ### 柱状堆叠图
+
 动态的数据集对应字典值需要选择一个“X轴”、“Y轴”、“柱状”,也就是说需要3个字段,不明白可以看看静态数据 <br>
 ![img.17](../picture/dashboard/img_17.png) <br>
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
-### 折线堆叠图 
+### 折线堆叠图
+
 动态的数据集对应字典值需要选择一个“X轴”、“Y轴”、“折线”,也就是说需要3个字段,不明白可以看看静态数据 <br>
 ![img.17](../picture/dashboard/img_17.png) <br>
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 折线图
+
 折线图数据集对应字典值需要选择一个“X轴”、“折线”,只需要2个字段 <br>
 ![img_8.png](../picture/dashboard/img_8.png) <br>
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 柱线图
+
 柱线图数据集对应字典值需要选择一个“X轴”、“柱状”、“折线”,需要3个字段 <br>
 ![img9](../picture/dashboard/img_9.png) <br>
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 饼图
+
 饼图的数据集选择的时候,只能选择饼图对应的字典,即“Name”、“Value”,不明白可以参考静态数据 <br>
 ![img10](../picture/dashboard/img_10.png) <br>
 ![img11](../picture/dashboard/img_11.png) <br>
@@ -76,26 +92,31 @@
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 漏斗图
+
 和饼图一样 <br>
 ![img13](../picture/dashboard/img_13.png) <br>
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 仪表盘
+
 数据集只能有一个字段,且字典选择“文本数字” <br>
 ![img21](../picture/dashboard/img_21.png) <br>
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 中国地图
+
 **注**:气泡地图已支持动态数据,中国地图(迁徙图)暂不支持动态数据 <br>
 气泡地图动态数据集,和饼图一样,对应字典值需要选择一个“Name”、“Value”,且name的字段值要和echarts图表里面的值能对应上,可参考静态数据 <br>
 ![img15](../picture/dashboard/img_15.png) <br>
 
 ### 百分百图
+
 数据集只能有一个字段,且字典选择“文本数字” <br>
 ![img16](../picture/dashboard/img_16.png) <br>
 **如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
 
 ### 对比图
+
 柱状对比图: <br>
 数据集需要3个字段,其中一个作为对比的字段只能为2种值,只有2种值作为对比的字段要选择“y轴字段”字典。因为底层的解析用的是堆叠图的解析,这里的y轴字段并不是指的图表上面的y轴,还请注意,有强迫症可以自行修改源码的解析,剩下的2个字段对应字典看图<br>
 ![img18](../picture/dashboard/img_18.png) <br>

+ 7 - 5
doc/docs/guide/datasource.md

@@ -1,26 +1,28 @@
 ## 介绍
+
 - 支持多数据源,内置mysql、elasticsearch、kudu等多种驱动 <br>
 - 可动态扩展
-![source.png](../picture/datasource/img_1.png)
+  ![source.png](../picture/datasource/img_1.png)
 
 ## 数据源类型
+
 查看已有的数据源类型 <br>
 ![img2](../picture/datasource/img_2.png)  <br>
 ![img3](../picture/datasource/img_3.png)  <br>
+
 ```text
 可以在此页面进行新增数据源配置,也可以去数据库中增加你需要的数据源类型。
 表aj_report.gaea_dict_item,字段dict_code:SOURCE_TYPE
 表aj_report.gaea_dict_item, item_extend字段是下拉选择后动态表单渲染的json数据
 ```
 
-
 ## 操作
-- 只有测试通过的数据源才可以保存
-![An image](../picture/datasource/img.png)
-
 
+- 只有测试通过的数据源才可以保存
+  ![An image](../picture/datasource/img.png)
 
 ## 扩展
+
 - 以kudu impala 为例,在lib文件夹下加入kudu impala相关的JDBC连接相关的包,如图在数据库中新增数据源类型,参考数据源类型(上方)
 
 ![An image](../picture/datasource/kudu-impala-lib.png)

+ 7 - 0
doc/docs/guide/execl.md

@@ -1,7 +1,10 @@
 # 介绍
+
 execl报表基于Luckysheet开发,[Luckysheet](https://gitee.com/mengshukeji/Luckysheet) 一款纯前端类似excel的在线表格,功能强大、配置简单、完全开源。
 **注意:** execl报表目前只是简单集成,如果你遇到了一些问题请在此[Issue](https://gitee.com/anji-plus/report/issues/I4CEWV) 下面进行回复。<br>
+
 ## 表格报表设计
+
 进入表格设计方法1: <br>
 从报表管理模块选择需要设计的大屏,按图示进入大屏设计界面 <br>
 ![img](../picture/execl/img.png) <br>
@@ -11,17 +14,21 @@ execl报表基于Luckysheet开发,[Luckysheet](https://gitee.com/mengshukeji/L
 ![img2](../picture/execl/img_1.png) <br>
 
 ## 简介
+
 ![img3](../picture/execl/img_2.png) <br>
 
 ## 使用
+
 **注**:不建议一列中同时存在俩个字段数据,同时一列值也建议不要存到超大数据量,肯定无法显示的<br>
 ![img4](../picture/execl/img_3.png) <br>
 
 ## 预览/保存
+
 点击保存,则会将数据写入到库中。<br>
 点击预览,则进入预览界面。<br>
 ![img](../picture/execl/img_4.png) <br>
 
 ## 预览界面
+
 可以进行导出操作。<br>
 ![img](../picture/execl/img_5.png) <br>

+ 5 - 1
doc/docs/guide/importexport.md

@@ -2,20 +2,24 @@
 **注:“导入成功/失败”的提示不一定对应当前真实导入导出情况,请根据实际导入导出的结果进行判断**
 
 ## 导出
+
 ![img](../picture/imexport/img.png) <br>
 导出会生成zip文件,包含图表、样式、图片等,不会带有该大屏的名称和code。<br>
 
 ### 导出数据集
+
 适用于同一系统内部使用
 
 ### 导出不含有数据集
+
 导出的图表会使用默认的静态数据集,适用于跨系统,请注意,如果你的大屏图表有部分图表是在对方系统不存在的,那么目前整个大屏是不会显示出来的,后续会进行兼容,不存在的图表留空。<br>
 
 ## 导入
+
 ![img1](../picture/imexport/img_1.png) <br>
 选择一个导出的zip文件导入即可。注意,导入会覆盖当前大屏,请新建一张空白的大屏进行导入。<br>
 **注:如果你导入的大屏中含有你当前系统不存在的图表,整个大屏是不会显示的。** <br>
 
-
 ## 导入导出权限
+
 请查看权限控制模块中关于导入导出权限的说明。 <br>

+ 11 - 2
doc/docs/guide/quicklyDevelop.md

@@ -1,13 +1,19 @@
 ## 核心技术
+
 ### 底层依赖
+
 - [Mysql] 5.7
 - [Jdk] 1.8
 
 ### 后端
-- [Spring Boot](https://spring.io/projects/spring-boot/): Spring Boot是一款开箱即用框架,让我们的Spring应用变的更轻量化、更快的入门。 在主程序执行main函数就可以运行。你也可以打包你的应用为jar并通过使用java -jar来运行你的Web应用;
+
+- [Spring Boot](https://spring.io/projects/spring-boot/): Spring Boot是一款开箱即用框架,让我们的Spring应用变的更轻量化、更快的入门。
+  在主程序执行main函数就可以运行。你也可以打包你的应用为jar并通过使用java -jar来运行你的Web应用;
 - [Mybatis-plus](https://mp.baomidou.com/): MyBatis-plus(简称 MP)是一个 MyBatis (opens new window) 的增强工具。
 - [flyway](https://flywaydb.org/): 主要用于在你的应用版本不断升级的同时,升级你的数据库结构和里面的数据
+
 ### 前端
+
 - [npm](https://www.npmjs.com/):node.js的包管理工具,用于统一管理我们前端项目中需要用到的包、插件、工具、命令等,便于开发和维护。
 - [webpack](https://webpack.docschina.org/):用于现代 JavaScript 应用程序的_静态模块打包工具
 - [ES6](https://es6.ruanyifeng.com/):Javascript的新版本,ECMAScript6的简称。利用ES6我们可以简化我们的JS代码,同时利用其提供的强大功能来快速实现JS逻辑。
@@ -18,7 +24,9 @@
 - [avue](https://www.avuejs.com/): 用该组件包裹后可以变成拖拽组件,采用相对于父类绝对定位;用键盘的上下左右也可以控制移
 
 ## 开发环境
+
 这里提供我们的开发环境版本进行参考
+
 - [CentOs] 7.5
 - [Mysql] 5.7
 - [Jdk] 1.8
@@ -29,9 +37,10 @@
 - [Node.js] 14.16.0
 - [Windows 10]
 
-已知 **Mysql8.0** 和 **Jdk11** 会出现兼容性问题,后续有解决方法将会在下方 **其他** 大类进行补充  
+已知 **Mysql8.0** 和 **Jdk11** (部分小版本)会出现兼容性问题,后续有解决方法将会在下方 **其他** 大类进行补充
 
 ## SQL初始化
+
 sql文件的地址是:report-core --> src --> main --> resources -- > db.migration <br>
 ![sql](../picture/quickly/img_13.png)
 

+ 2 - 2
doc/docs/guide/quicklyDistribution.md

@@ -7,7 +7,7 @@
 
 ## 下载发行版
 
-下载地址:[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases) <br>
+[下载地址](https://gitee.com/anji-plus/report/releases) :https://gitee.com/anji-plus/report/releases <br>
 ![img.png](../picture/quickly/img.png) <br>
 
 ## 修改mysql连接
@@ -25,7 +25,7 @@ report-core-XXX --> conf --> bootstrap-dev.yml <br>
 ## 上传功能
 
 使用上传功能,必须修改此内容 <br>
-![file.png](../picture/quickly/img_5.png) <br>
+![file.png](../picture/quickly/img_15.png) <br>
 
 ## 启动
 

+ 3 - 3
doc/docs/guide/quicklySeparate.md

@@ -24,7 +24,7 @@ npm run build
 - [Node.js] v14.16.0 <br>
 - [Jdk] 1.8 <br>
   请在你的Windows上先准备好maven、node.js、jdk <br>
-  **注**:已知**Jdk11**存在兼容性问题,请不要使用openJdk,环境问题请看 **常见问题** 大类 <br>
+  **注**:已知 **Jdk11** (部分小版本)存在兼容性问题,请不要使用openJdk,环境问题请看 **常见问题** 大类 <br>
 
 ### 克隆源码
 
@@ -43,7 +43,7 @@ report-core --> src --> main --> resources --> bootstrap.yml <br>
 ### 上传功能
 
 使用上传功能,必须修改此内容 <br>
-![file.png](../picture/quickly/img_5.png) <br>
+![file.png](../picture/quickly/img_15.png) <br>
 
 ### maven打包
 
@@ -85,7 +85,7 @@ report-ui目录: <br>
 ### 修改config
 
 目录地址:report-ui --> config --> prod.env.js <br>
-修改你的BASE_API地址 <br>
+修改你的BASE_API地址,改成自己后端的api <br>
 
 ### build
 

+ 1 - 1
doc/docs/guide/quicklySource.md

@@ -48,7 +48,7 @@ git clone https://gitee.com/anji-plus/report.git <br>
 ## 上传功能
 
 使用上传功能,必须修改此内容 <br>
-![file.png](../picture/quickly/img_5.png)
+![file.png](../picture/quickly/img_15.png)
 
 ## 启动
 

+ 1 - 0
doc/docs/guide/reportmanager.md

@@ -1,3 +1,4 @@
 ## 新增报表
+
 ![img](../picture/reportmanager/img.png) <br>
 状态默认为已启用。

BIN
doc/docs/picture/quickly/img_15.png