浏览代码

doc 文档更新V1.2

qianming 1 年之前
父节点
当前提交
47fe284384

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

@@ -35,6 +35,7 @@ module.exports = {
                     children: [
                         {title: 'V1.0.0', path: '/guide/releases/1.0.0'},
                         {title: 'V1.1.0', path: '/guide/releases/1.1.0'},
+                        {title: 'V1.2.0', path: '/guide/releases/1.2.0'},
                     ]
                 },
                 {

+ 82 - 50
doc/docs/guide/chartsConfig.md

@@ -3,84 +3,116 @@
 图表配置项的中文名称基本都是直接使用Echarts图表组件对应定义的名称,非Echarts图表组件则根据功能进行命名。<br>
 每个图表组件的配置项都不尽相同,配置项的作用在于调整图表、数据的展示样式,这里着重说明一些共有的配置项和特殊的配置项,因为并不是按照一个图表一个配置项介绍的,没有介绍的部分请自行尝试了。
 
-## 图层名称
+## 通用配置项
 
-**定义:** 顾名思义,定义该组件在图层中显示的名称。<br>
-**使用建议:** 因为图层名称是可以重复的,所以在图层中无法准确判断该图层具体对应哪个组件,且在大屏画布中有的图表组件因为置底或者上层覆盖了别的组件,导致很难选到这个图表,如果修改了图层名称,则可以通过图层快速定位并选中该组件。
+### 图层名称
 
-## 文本框--文本内容
+定义:定义该组件在图层中显示的名称。<br>
+使用建议:
+- 因为图层名称是可以重复的,所以在图层中无法准确判断该图层具体对应哪个组件,且在大屏画布中有的图表组件因为置底或者上层覆盖了别的组件,导致很难选到这个图表,如果修改了图层名称,则可以通过图层快速定位并选中该组件。<br>
 
-文本框和滚动文本这两个组件,修改数据--静态数据,是不会生效的,文本内容配置项中写的内容才是真正的静态数据。<br>
+![img](../picture/chartsConfig/img.png)
 
-## 超链接--跳转方式
+### 标题设置
 
-**使用建议:** 默认的跳转方式是本窗口,实际使用还是请选择新窗口。<br>
+定义:给图表组件添加标题/表头/title。 <br>
+使用建议:
+- 一般没有图例功能的图表组件可以直接使用这个功能,因为可能会和图例重叠。有图例的图表组件要定义图表的话,可用文本框拖动到图表上方,作为标题。<br>
 
-## 图片地址
+![img1](../picture/chartsConfig/img_1.png)
 
-**定义:** 图片对应的url链接 <br>
-**使用建议:**
-这里图片的url因为只要是链接能打开就行了,所以适用性范围很广,但一般考虑到网络传输、安全性等问题,建议自行上传图片,然后用系统生成的链接地址;注意目前系统赞不支持svg图片,因此图片可能存在畸变,要注意缩放比例。
+### 柱体设置
 
-## 表格--滚动间隔
+定义:修改柱体的形状等,涉及柱状图、柱线图 <br>
+使用建议:
+
+- 当数据条目数很少时,比如默认的静态数据是5条,放大宽度,柱体变得更粗,搭配"竖展示"配置项,可以得到更好的展示效果;当只有一个值的时候,通过XY不展示,可以得到单独的一根柱子。
+- V1.2版本增加配置项“背景显示”,可达到类似进度条的效果。<br>
+
+![img2](../picture/chartsConfig/img_2.png)
+
+### 折线设置
+
+定义:修改点/折线的展示效果,涉及折线图、柱线图 <br>
+使用建议:
+- 当折线的量少的时候,可以选择拉大"面积厚度",折线多了,就会相关覆盖,效果反而不好。<br>
+
+![img3](../picture/chartsConfig/img_3.png)
+
+### X轴设置
+
+定义:定义坐标轴中的X轴的相关设置项。<br>
+使用建议:
+- 可以修改坐标轴的颜色,因为默认是纯白色,所以部分浏览器可能显示不出来;可以设置坐标名(柱状对比图不存在此配置项);如果数值相对密集的话,可以调整"数值间隔"。
+- V1.2版本默认X轴数值自动换行,X轴的label能显示的值的量是估算的,因此给了“数值行数”配置项方便进行调整。当“数值行数”有值时,默认的自动换行规则不会生效。<br>
 
-**定义:** 表格数据滚动的间隔,受到"开启滚动"、"动效时间"、"滚动个数"、"数据--动态数据--刷新时间"影响 <br>
-**使用建议:**
-表格动态数据默认是5s请求一次数据,因此每隔5s图表就会刷新一次,这时就会重置滚动时间,会出现滚动到某个值时回到开头重新滚动。想让表格把每个值都滚动显示到的话,可以减少滚动间隔时间,去掉动效时间,增大滚动个数,提高动态数据刷新时间。<br>
+![img4](../picture/chartsConfig/img_4.png)
 
-## 柱体设置
+### Y轴设置
 
-**定义:** 修改柱体的形状等,涉及柱状图、柱线图 <br>
-**使用建议:** 当数据条目数很少时,比如默认的静态数据是5条,放大宽度,柱体变得更粗,搭配"竖展示"
-配置项,可以得到更好的展示效果;当只有一个值的时候,通过XY不展示,可以得到单独的一根柱子。<br>
+定义:定义坐标轴中的Y轴的相关设置项。 <br>
+使用建议:
+- 可以修改坐标轴的颜色,因为默认是纯白色,所以部分浏览器可能显示不出来;如果数值相对密集的话,可以调整"均分"。注意"缩放"配置项只会对那些数据差距较大时才会生效。
+- V1.2版本新增“最大值”配置项,注意“最大值”配置项,目前只有柱状图相关的图表中有这个配置项。<br>
 
-## 折线设置
+![img5](../picture/chartsConfig/img_5.png)
 
-**定义:** 修改点/折线的展示效果,涉及折线图、柱线图 <br>
-**使用建议:** 当折线的量少的时候,可以选择拉大"面积厚度",折线多了,就会相关覆盖,效果反而不好。<br>
+### 图例操作
 
-## 标题设置
+定义:图例的直接来源是数据中的数值,比如在堆叠图中,图例的值就是"动态数据-Y轴字段"字典选择的字段数值,可以简单的认为是“数据分类”。<br>
+使用建议:
+- 填写图例名称,修改图例的值,使用"|"进行分隔,相当于别名。<br>
 
-**定义:** 给图表组件添加标题/表头/title。 <br>
-**使用建议:**
-一般没有图例功能的图表组件可以直接使用这个功能,因为可能会和图例重叠。有图例的图表组件要定义图表的话,可用文本框拖动到图表上方,作为标题。<br>
+![img6](../picture/chartsConfig/img_6.png)
 
-## X轴设置
+### 数值设定
 
-**定义:** 定义坐标轴中的X轴的相关设置项。 <br>
-**使用建议:**
-可以修改坐标轴的颜色,因为默认是纯白色,所以部分浏览器可能显示不出来;可以设置坐标名(柱状对比图不存在此配置项);如果数值相对密集的话,可以调整"
-数值间隔"。
+定义:设定数据在图表中的显示配置。<br>
+使用建议:
+- 对于堆叠图、柱线图等等柱体、折线数据多的,不建议显示。<br>
 
-## Y轴设置
+![img7](../picture/chartsConfig/img_7.png)
 
-**定义:** 定义坐标轴中的Y轴的相关设置项。 <br>
-**使用建议:** 可以修改坐标轴的颜色,因为默认是纯白色,所以部分浏览器可能显示不出来;如果数值相对密集的话,可以调整"均分"
-;注意"缩放"配置项只会对那些数据差距较大时才会生效。
+### 提示语设置
 
-## 图例操作
+定义:设定提示,主要用于当鼠标选中/滑动时,显示数据对应的值。<br>
+使用建议:
+- 设定和对应图表相反的颜色,鼠标滑动时则会醒目;注意此配置项必须保存预览鼠标选中后才能看到效果,在画布设计是看不到效果的。<br>
 
-**定义:** 图例的直接来源是数据中的数值,比如在堆叠图中,图例的值就是"动态数据-Y轴字段"
-字典选择的字段数值,可以简单的认为是“数据分类”。<br>
-**使用建议:** 填写图例名称,修改图例的值,使用"|"进行分隔,相当于别名。<br>
+![img8](../picture/chartsConfig/img_8.png)
 
-## 数值设定
+### 自定义配色
 
-**定义:** 设定数据在图表中的显示配置。<br>
-**使用建议:** 对于堆叠图、柱线图等等柱体、折线多的,不建议显示。<br>
+使用建议:如果不设置的话,默认就是大红色;默认按顺序给数值赋予颜色。<br>
 
-## 提示语设置
 
-**定义:** 设定提示,主要用于当鼠标选中/滑动时,显示数据对应的值。<br>
-**使用建议:**
-设定和对应图表相反的颜色,鼠标滑动时则会醒目;注意此配置项必须保存预览鼠标选中后才能看到效果,在画布设计是看不到效果的。<br>
+## 专用配置项
 
-## 自定义配色
+### 文本框--文本内容
+
+文本框和滚动文本这两个组件,修改数据--静态数据,是不会生效的,文本内容配置项中写的内容才是真正的静态数据。<br>
+
+## 超链接--跳转方式
+
+使用建议:
+- 默认的跳转方式是本窗口,实际使用还是请选择新窗口。<br>
+
+## 图片/图片地址
+
+定义:图片对应的url链接 <br>
+使用建议:
+- 这里图片的url因为只要是链接能打开就行了,所以适用性范围很广,但一般考虑到网络传输、安全性等问题,建议自行上传图片,然后用系统生成的链接地址;注意目前系统赞不支持svg图片,因此图片可能存在畸变,要注意缩放比例。
+- V1.2版本支持.svg格式图片上传。 <br>
+
+## 表格--滚动间隔
 
-**使用建议:** 如果不设置的话,默认就是大红色;默认按顺序给数值赋予颜色。<br>
+定义:表格数据滚动的间隔,受到"开启滚动"、"动效时间"、"滚动个数"、"数据--动态数据--刷新时间"影响 <br>
+使用建议:
+- 表格动态数据默认是5s请求一次数据,因此每隔5s图表就会刷新一次,这时就会重置滚动时间,会出现滚动到某个值时回到开头重新滚动。想让表格把每个值都滚动显示到的话,可以减少滚动间隔时间,去掉动效时间,增大滚动个数,提高动态数据刷新时间。<br>
 
 ## 饼图样式/模式
 
-**定义:** 定义饼图显示的样式、模式,涉及饼图、南丁格尔玫瑰图。<br>
-**使用建议:** 按数据量多少进行选择样式。<br>
+定义:定义饼图显示的样式、模式,涉及饼图、南丁格尔玫瑰图。<br>
+使用建议:
+- 按数据量多少进行选择样式。<br>
 

+ 41 - 0
doc/docs/guide/releases/1.2.0.md

@@ -0,0 +1,41 @@
+## 注意事项
+
+- 本次更新bootstrap.yml相关配置文件有更新,根据部署方式的不同,注意不要遗漏此文件的更新
+- 本次更新有新增SQL(V1.2.0__update.sql),没有启用flyway的情况下别忘记手动执行更新sql
+- 之前版本更新至本版本时,可能会遇到图表不显示静态、动态数据,需删除该图表重新配置;如果已对旧版本进行二次开发,请谨慎更新。<br>
+  跨版本更新可查对应版本的[releases](https://gitee.com/anji-plus/report/releases)。<br>
+
+## 新增
+
+- 1、新增中国地图-柱形地图
+- 2、新增样式组件-流光直线 --贡献人:陈旭光@chen-xuguang
+- 3、支持URL传参(具体解释与使用请查看数据集)
+- 4、支持上传SVG格式图片 --贡献人:陈旭光@chen-xuguang
+
+## 优化
+
+- 1、大屏-柱状图支持多柱,折线图支持多折线(柱状图-渐变色不支持多柱)
+- 2、大屏-柱线堆叠图、多柱线图柱体增加堆叠样式
+- 3、大屏图表配置项-数值设定,增加是否显示百分号 --贡献人:Mr.Z@sillycoder
+- 4、大屏-柱状图增加柱体背景等配置项(具体解释与使用请查看图表配置项)
+- 5、大屏-X轴数值长度超长自动换行(具体解释与使用请查看图表配置项)
+
+## 修复
+
+- 1、样式组件保存后预览不生效问题 --贡献人:luoxuancong@luoxuancong
+- 2、Excel数据渲染重复查询问题
+- 3、雷达图动态数据刷新后预览不自动刷新图表问题
+
+## 其他
+
+- 1、文档更新
+- 2、增加了新中国地图解析方法V2--可显示非省市区以外的经纬度地址,需配合柱形地图使用,其他地图暂时不使用,可参考柱形地图来修改其他代码
+- 3、bootstrap.yml配置文件更新
+
+## 示例数据
+
+- 从1.0版本调整了底层sql,具体位置是:report-core/src/main/resource/db.migration,
+  删除了过往所有的sql,现在此目录下sql仅包含aj_report基础信息库的相关sql,sql文件的命名也会和版本号保持一致,
+  提供的示例数据(aj_report_init数据库的sql),aj_report_init_example.sql 文件放置在 doc/example目录下。
+
+- 如果需要将之前版本的示例数据删除,delete_aj_report_init_example.sql 文件放置在 doc/example目录下。

二进制
doc/docs/picture/chartsConfig/img.png


二进制
doc/docs/picture/chartsConfig/img_1.png


二进制
doc/docs/picture/chartsConfig/img_2.png


二进制
doc/docs/picture/chartsConfig/img_3.png


二进制
doc/docs/picture/chartsConfig/img_4.png


二进制
doc/docs/picture/chartsConfig/img_5.png


二进制
doc/docs/picture/chartsConfig/img_6.png


二进制
doc/docs/picture/chartsConfig/img_7.png


二进制
doc/docs/picture/chartsConfig/img_8.png