chore: 更新 datachart 文档基础功能部分

Author: scottsut

source/docs/datachart.md

@@ -20,7 +20,8 @@ title: 数据图表
 
 ## 1. 编辑图表
 
-编辑器从布局上分为3部分：
+编辑器从布局上分为 3 部分：
+
 - 左侧：关联数据视图的字段列表，用于拖拽到配置区`数据`栏中进行可视化属性配置
 - 中部：配置区
 - 右侧：预览区，用于选择图表类型和预览图表
@@ -38,10 +39,11 @@ title: 数据图表
 ![计算字段-1](/datart-docs/images/datachart/1-1-1-1.png)
 
 创建一个计算字段需要填写名称、类型和表达式；在中部的编辑器内编写表达式，计算字段的表达式仅允许包含以下内容：
+
 - 字段名称：表达式中所使用的字段名称格式为 `[字段名称]`，点击左侧字段列表中的字段，会自动添加字段名称到编辑器光标所在处
-- 函数：datart 内置了55个通用函数，已分好类、在右侧以列表展示，点击函数名称会自动添加到编辑器光标所在处。在编辑器中光标移动到函数名称上时，下方会提示函数简介和语法。另外，datart 未支持的通用函数、但数据源的 SQL 语法可以支持的，开发者也可以写到表达式中
+- 函数：datart 内置了 55 个通用函数，已分好类、在右侧以列表展示，点击函数名称会自动添加到编辑器光标所在处。在编辑器中光标移动到函数名称上时，下方会提示函数简介和语法。另外，datart 未支持的通用函数、但数据源的 SQL 语法可以支持的，开发者也可以写到表达式中
 - 运算符：支持 `+` `-` `*` `/` 等常规 SQL 运算符
-- 变量：*（开发中）*
+- 变量：_（开发中）_
 
 未按标准书写的表达式在保存时会提示错误。保存成功后，计算字段显示为橙色，可以像使用常规字段一样拖拽计算字段到`数据`配置栏中
 
@@ -58,9 +60,10 @@ datart 没有预定义维度和指标，而是通过图表提供的数据配置
 ![维度和指标](/datart-docs/images/datachart/1-2-1-1.png)
 
 指标配置项支持在下拉菜单中对拖入的字段设置：
+
 - 聚合方式：
-  - 数值型字段支持 `总计`、`平均值`、`计数`、`去重计数`、`最大值`、`最小值` 6种聚合方式
-  - 字符和日期型字段支持 `计数`、`去重计数` 2种聚合方式
+  - 数值型字段支持 `总计`、`平均值`、`计数`、`去重计数`、`最大值`、`最小值` 6 种聚合方式
+  - 字符和日期型字段支持 `计数`、`去重计数` 2 种聚合方式
   - 如果拖入的计算字段为数值型、并且表达式里已经包含聚合函数的情况下，是无法在下拉菜单中选择聚合方式的
 - 数值格式：
   - 默认格式
@@ -79,12 +82,14 @@ datart 没有预定义维度和指标，而是通过图表提供的数据配置
 字符型字段默认情况下支持以下方式配置筛选：
 
 - 常规：即时查询字段去重值作为筛选项
+
   - 支持在筛选项里选择一到多项作为默认值
   - 支持单选按钮、单/多选下拉菜单作为控制器，取决于默认值数量
 
   ![字符型字段筛选-1](/datart-docs/images/datachart/1-2-2-1-1.png)
 
 - 自定义：手动添加筛选项
+
   - 支持快捷选择字段去重值添加到筛选项
   - 支持拖拽改变筛选项顺序
   - 支持在筛选项里选择一到多项作为默认值
@@ -93,24 +98,27 @@ datart 没有预定义维度和指标，而是通过图表提供的数据配置
   ![字符型字段筛选-2](/datart-docs/images/datachart/1-2-2-1-2.png)
 
 - 条件：配置一个条件表达式作为筛选默认值
+
   - 仅支持文本输入框作为控制器
 
   ![字符型字段筛选-3](/datart-docs/images/datachart/1-2-2-1-3.png)
 
 在选择了`聚合方式`的情况下，字符型字段将转换为数值型字段参与筛选
 
-  ![字符型字段筛选-4](/datart-docs/images/datachart/1-2-2-1-4.png)
+![字符型字段筛选-4](/datart-docs/images/datachart/1-2-2-1-4.png)
 
 ##### 1.2.2.2 数值型字段筛选
 
 数值型字段支持以下方式配置筛选：
 
 - 区间：填写一个范围作为筛选默认值
+
   - 支持数值范围和滑块作为控制器
 
   ![数值型字段筛选-1](/datart-docs/images/datachart/1-2-2-2-1.png)
 
 - 条件：配置一个条件表达式作为筛选默认值
+
   - 仅支持数值输入框作为控制器
 
   ![数值型字段筛选-2](/datart-docs/images/datachart/1-2-2-2-2.png)
@@ -137,7 +145,7 @@ datart 没有预定义维度和指标，而是通过图表提供的数据配置
 
 显示：需要选择展示用的控制器，在图表预浏览面，查看用户可以通过操作控制器来改变筛选条件
 
-条件：在图表里有1个及以上字符型字段参与筛选时，新建筛选时可以选择1个字符型筛选作为自身可见与否的依赖条件，当依赖的筛选值满足表达式时才会显示控制器
+条件：在图表里有 1 个及以上字符型字段参与筛选时，新建筛选时可以选择 1 个字符型筛选作为自身可见与否的依赖条件，当依赖的筛选值满足表达式时才会显示控制器
 
 ![是否可见](/datart-docs/images/datachart/1-2-2-4-1.png)
 
@@ -177,6 +185,7 @@ datart 数据图表支持以下类型控制器：
 #### 1.2.5 字段设置
 
 可以点击拖入数据配置项的字段，在下拉菜单中对字段进行设置，目前支持以下通用设置：
+
 - 别名：改变字段在图表上的显示名称
 - 排序：对字段值进行排序，选项为：
   - 默认：即不排序
@@ -193,11 +202,11 @@ datart 数据图表支持以下类型控制器：
 
 #### 1.4.1 参考线
 
-可以给部分直角坐标系图表设置参考线和参考区间，目前仅支持折线图、面积图、柱状图、散点图和双Y轴图
+可以给部分直角坐标系图表设置参考线和参考区间，目前仅支持折线图、面积图、柱状图、散点图和双 Y 轴图
 
-参考线需要关联到1个指标，数值可以选择关联指标的最大值、最小值、平均值，也可以选择手动设置常量值
+参考线需要关联到 1 个指标，数值可以选择关联指标的最大值、最小值、平均值，也可以选择手动设置常量值
 
-参考区间需要设置起始值和结束值，每个值分别需要关联1个指标，数值可以选择关联指标的最大值、最小值、平均值，也可以选择手动设置常量值
+参考区间需要设置起始值和结束值，每个值分别需要关联 1 个指标，数值可以选择关联指标的最大值、最小值、平均值，也可以选择手动设置常量值
 
 #### 1.4.2 分页
 
@@ -209,65 +218,152 @@ datart 数据图表支持以下类型控制器：
 
 ![预览图表-1](/datart-docs/images/datachart/2-1-1.png)
 
-在预览区的右上角，可以点击切换图表 -> 原始数据 -> SQL语句
+在预览区的右上角，可以点击切换图表 -> 原始数据 -> SQL 语句
 
 ![预览图表-2](/datart-docs/images/datachart/2-1-2.png)
 
 ![预览图表-3](/datart-docs/images/datachart/2-1-3.png)
 
 ## 3. 基础功能
 
-### 3.1 新建数据图表和目录
+### 3.1 新建
 
-点击目录树顶部的加号按钮，选择`新建数据图表`或`新建目录`会弹出新建表单，填写名称和所属目录即可完成创建
+点击目录树顶部的加号按钮，选择“新建数据图表”或“新建目录”会弹出新建表单，填写名称和所属目录即可完成创建
 
 ![新建](/datart-docs/images/datachart/3-1-1.png)
 
-### 3.2 编辑基本信息
+### 3.2 编辑
 
-点击目录树右侧的扩展按钮按钮，选择`基本信息`，即可对数据图表/目录的基本信息进行编辑
+点击目录树右侧的扩展按钮按钮，选择“基本信息”，即可对数据图表/目录的基本信息进行编辑
 
 ![编辑](/datart-docs/images/datachart/3-1-2.png)
 
-### 3.3 发布/取消发布数据图表
+### 3.3 发布、取消发布
 
-在数据图表浏览界面的工具栏上点击`发布`按钮来发布一个数据图表，未发布前数据图表处理制作中状态，此时对拥有查看权限的成员不可见；发布之后拥有查看权限的成员才能看到
+在数据图表浏览界面的工具栏上点击“发布”按钮来发布一个数据图表，未发布前数据图表处理制作中状态，此时对拥有查看权限的成员不可见；发布之后拥有查看权限的成员才能看到
 
 ![发布-1](/datart-docs/images/datachart/3-3-1.png)
 
-数据图表发布之后，点击工具栏上的`取消发布`按钮，该图表会重新回到制作中状态
+数据图表发布之后，如果需要下架，从工具栏右侧的扩展菜单中选择“取消发布”，则图表会重新回到制作中状态
 
 ![发布-2](/datart-docs/images/datachart/3-3-2.png)
 
-### 3.4 删除目录/移至回收站
+### 3.4 同步数据
+
+如果需要更新图表中的数据，点击工具栏右侧的扩展菜单中的“同步数据”选项
+
+![同步数据-1](/datart-docs/images/datachart/3-4-1.png)
+
+### 3.5 另存为
+
+另存为功能支持将当前图表复制并保存。可以选择从目录树的扩展按钮中对图表进行另存为操作，也可以在工具栏右侧的扩展菜单中找到“另存为”选项
+
+![另存为-1](/datart-docs/images/datachart/3-9-2.png)
+
+![另存为-2](/datart-docs/images/datachart/3-5-1.png)
+
+点击之后，在弹出的对话框中输入新的图表名称和路径，点击保存完成复制
+
+### 3.6 添加到仪表板
+
+该功能支持将当前图表作为组件添加到指定仪表板。可以在工具栏右侧的扩展菜单中找到“添加到仪表板”选项
+
+![添加到仪表板-1](/datart-docs/images/datachart/3-6-1.png)
+
+点击之后，在弹出的对话框中选择想要加入的仪表板
+
+![添加到仪表板-2](/datart-docs/images/datachart/3-6-2.png)
+
+点击确定之后，随即跳转到仪表板编辑页，用户可以对新增的图表组件调整尺寸和样式
+
+![添加到仪表板-3](/datart-docs/images/datachart/3-6-3.png)
+
+### 3.7 分享管理
+
+分享管理功能用于管理当前图表的分享链接。可以在工具栏右侧的扩展菜单中找到“分享管理”选项
+
+![分享管理-1](/datart-docs/images/datachart/3-7-1.png)
+
+点击之后，在弹出的的面板中新建和编辑分享链接
+
+![分享管理-2](/datart-docs/images/datachart/3-7-2.png)
+
+点击右上角的“添加链接”按钮新建一个分享链接，需要输入以下选项
+
+- 截止日期：指定当前分享链接的过期时间；可选项，当不填写时链接永久有效。**需要注意的是，由于截止日期在应用数据库中以 timestamp 类型存储，因此不支持设置 2038 年以后的日期**
+
+- 认证方式：
+
+  - 无：公共分享，任何人都可以访问。数据权限与分享者相同
+
+    ![分享管理-3](/datart-docs/images/datachart/3-7-3.png)
+
+  - 口令：会随链接一同生成一个口令，访问分享链接时需要正确输入口令才能查看内容。数据权限与分享者相同
+
+    ![分享管理-4](/datart-docs/images/datachart/3-7-4.png)
+
+  - 登录：访问分享链接时需要登录查看内容。该认证方式会多出 2 个额外选项
+
+    - 数据权限：可以选择访问链接时所查看数据的权限。当选择“登录者”时，会依照不同的登录者展示符合其自身权限的数据；当选择“分享者”时，所有人访问链接查看到的数据与分享者相同
+    - 指定角色/成员：指定能够访问当前分享链接的角色和成员；可选项，当不填写时按照访问用户自身的[权限设定](permission)来展示内容。
+
+    ![分享管理-5](/datart-docs/images/datachart/3-7-5.png)
+
+点击确认之后，生成的分享链接会展示在面板上。可以在面板上快捷复制链接地址、编辑和删除链接
+
+![分享管理-6](/datart-docs/images/datachart/3-7-6.png)
+
+### 3.8 下载
+
+datart 支持将数据图表以 Excel、PDF、图片 3 种形式下载，PDF 和图片需要[配置截图服务](index#2-6-截图配置-可选)才能正常使用。可以在工具栏右侧的扩展菜单中找到 3 种下载选项
+
+![下载-1](/datart-docs/images/datachart/3-8-1.png)
+
+点击之后会在后台生成下载任务，datart 服务端会异步地执行下载任务，执行完成后将文件生成到配置的文件路径下。下载任务生成时界面顶部会有消息提示
+
+![下载-2](/datart-docs/images/datachart/3-8-2.png)
+
+当有新的下载任务执行完成时，主导航栏下方的“下载列表”图标上会有角标提示；打开下载列表，点击文件名称下载文件
+
+![下载-3](/datart-docs/images/datachart/3-8-3.png)
+
+### 3.9 移至回收站、删除目录
+
+在目录树中可以删除目录、以及将数据图表移动到回收站；在数据图表工具栏的扩展菜单中也有移至回收站选项
 
 点击目录树右侧的扩展按钮按钮，如果是目录，会显示`删除`按钮，点击并确认之后会永久删除该目录；如果是数据图表，会显示`移至回收站`按钮，点击并确认之后，该数据图表会被移动到回收站归档，无法再被使用
 
-![回收站-1](/datart-docs/images/datachart/3-4-1.png)
-![回收站-2](/datart-docs/images/datachart/3-4-2.png)
+<p>
+  <img width="350" src="/datart-docs/images/datachart/3-9-1.png" alt="回收站-1" />
+  <img width="350" src="/datart-docs/images/datachart/3-9-2.png" alt="回收站-2" />
+</p>
+
+扩展菜单中的移至回收站按钮
+
+![回收站-3](/datart-docs/images/datachart/3-9-3.png)
 
-### 3.5 还原
+### 3.10 还原
 
-点击目录树顶部的`扩展`按钮，进入回收站
+点击目录树顶部的扩展按钮，进入回收站
 
-![还原-1](/datart-docs/images/datachart/3-5-1.png)
+![还原-1](/datart-docs/images/datachart/3-10-1.png)
 
 系统会将移至回收站的数据图表重命名，规则为`原名称.时间戳`；点击回收站列表的任意数据图表，右侧区域会展示该数据图表的详细信息，为只读状态
 
-![还原-2](/datart-docs/images/datachart/3-5-2.png)
+![还原-2](/datart-docs/images/datachart/3-10-2.png)
 
 点击列表右侧扩展按钮，选择`还原`，在弹窗表单中需要重新填写还原后的名称和目录，填写完成后，点击保存按钮完成还原
 
-![还原-3](/datart-docs/images/datachart/3-5-3.png)
+![还原-3](/datart-docs/images/datachart/3-10-3.png)
 
-### 3.6 删除
+### 3.11 删除
 
 查看回收站列表里的数据图表信息时，点击列表右侧扩展按钮，选择`删除`，确认对话框之后，将会永久删除该数据图表
 
-![删除](/datart-docs/images/datachart/3-6-1.png)
+![删除](/datart-docs/images/datachart/3-11-1.png)
 
-### 3.7 搜索
+### 3.12 搜索
 
 点击目录树顶部的`搜索`按钮，会弹出关键字搜索框，可以按照名称检索数据图表、仪表板和目录
 
-![搜索](/datart-docs/images/datachart/3-7-1.png)
+![搜索](/datart-docs/images/datachart/3-12-1.png)