数据可视化开发指南
数据源
数据源添加是进行数据可视化分析的第一步,它支持从数据库、文件和 Http 接口获取数据
- 注意事项
当测试连接提示缺少驱动类时,用户需要手动填写驱动类名称。 开启服务端聚合适合数据源端计算效率低的情况。 文件数据源和 Http 数据源都利用内置的 H2 数据库进行数据计算。
数据源类型
支持以下几种数据源类型
JDBC 数据源
通过 JDBC 连接数据库获取数据。
- JDBC 支持的数据库类型
默认支持多达34种 JDBC 数据库。如果用户的数据库不在默认支持的列表中,可以通过扩展 DataProvider 类来自定义数据源。默认支持的 JDBC 数据库类型列表如下: ACCESS、BIG_QUERY、CALCITE、CLICKHOUSE、DB2、DERBY、DM、DORIS、FIREBIRD、H2、HIVE、HSQLDB、IMPALA、INFOBRIGHT INFORMIX、INGRES、INTERBASE、JETHRO、KINGBASE8、LUCIDDB、MSSQL、MYSQL、NEOVIEWNETEZZA、ORACLE、PHOENIX POSTGRESQL、PRESTO、SPARK、SQLSTREAM、STARROCKS、SYBASE、TAOS、TERADATA、VERTICA
- 配置说明
创建一个 JDBC 数据源通常需要配置以下内容:
名称: 数据源名称,要求唯一 数据库类型::默认支持 30+种 JDBC 数据库。如果你的数据库不在选项中,请参照扩展 JDBC 数据源章节 连接地址: 通常格式为 jdbc:<数据源名称>://<数据源域名或IP>:(<端口>)/<数据源实例>(?<连接参数>) 用户: 数据库连接用户名 密码: 数据库连接密码 驱动类:当测试连接提示缺少驱动类时,表明没有内置所选数据库的驱动类,用户需要手动填写驱动类名称 开启服务端聚合:开启后,在执行 SQL 时,会将数据视图中 SQL 查询的结果集全量拉取到服务端,然后进行本地分组聚合计算。这个选项适合数据源端计算效率低,或者计算能力弱的数据源进行开启。如果源端本身具有较强的计算能力,则不需要开启这个选项 允许未识别 SQL 执行:默认只允许 DQL 执行,禁止 DML 和 DDL 执行。其它类型的 SQL(如存储过程)是否允许执行,可通过该选项进行配置 定时同步数据库库表信息:开启后,将按照指定时间间隔定时同步数据库库表信息 定时同步时间间隔(分钟):定时同步数据库库表信息开启时填写,默认为60分钟 连接池参数:键值对形式
- 配置示例
文件
支持上传 Excel 和 CSV 文件作为数据源,一个数据源下可以添加多个文件。 文件上传后被存储在服务端;在查询文件数据源时,读取文件到内置的 H2 数据库中,使用 H2 数据库对原始数据进行计算。 支持在数据视图中编写 SQL 对一个数据源下的多个文件进行关联与聚合操作。
- 配置说明
新增配置: 即新增文件上传,点击后会弹出文件上传窗口 文件: 可以上传 excel 或 csv 文件 列:上传文件的数据列 是否开启缓存: 发起查询时、H2 首次读取文件之后是否缓存数据 缓存超时: 数据缓存的超时时间
- 配置示例
Http
使用 Http 接口响应数据作为数据来源,一个数据源下可以添加多个连接信息 在查询 Http 数据源时,datart 使用内置的 H2 数据库对 Http 接口响应数据进行计算。 支持在数据视图中编写 SQL 对一个数据源下的多个 Http 接口响应数据进行关联与聚合操作
- 配置说明
新增配置: 即新增 Http 连接信息,点击后会弹出 Http 连接信息窗口 表名: 一个数据源下唯一 地址: Http 接口地址 请求方式: GET / POST / PUT / DELETE 解析字段: 返回数据中需要解析的属性,指定的属性必须是一个数组结构。多层嵌套用 . 隔开(如 data.users)。如返回数据结构是数组,这个属性不填。 用户名:可选,支持 Basic access authentication 身份验证方式 密码: 可选 结果解析器:默认为空。如果返回数据格式特殊,可通过实现 datart.data.provider.HttpResponseParser,然后通过这个参数指定具体的 Parser 实现类 请求头:键值对形式 路径参数:键值对形式 请求体:文本 contentType:默认值 application/json 是否开启缓存:发起查询时、H2 首次 Http 接口获取数据之后是否缓存数据 缓存超时:数据缓存的超时时间
- 配置示例:
数据源操作
新建: 点击数据源列表顶部的加号按钮,填写信息后保存。 测试连接: 配置完成后,测试 JDBC 或 Http 数据源的连接是否有效。 编辑: 选择数据源,编辑配置信息后保存。 移至回收站: 将不再使用的数据源移动到回收站。 还原: 从回收站还原数据源到可用状态。 删除: 从回收站永久删除数据源。 搜索: 按名称搜索数据源。
扩展数据源
默认支持的数据源类别不满足需求,用户可以在源码中扩展 DataProvider 类来自定义数据源
数据视图
数据视图是一个关键功能,它允许用户从数据源中选取所需的数据,并支持对所选数据进行转换和加工。即让用户来定义数据的来源、结构和加工逻辑。加工逻辑和字段模型会被保存下来,用于分析和可视化制作.
- 注意事项
确保 SQL 查询语句正确无误,避免语法错误或逻辑错误。 在设置字段属性时,注意数据类型的匹配和格式的正确性。 在配置关联关系时,确保数据的一致性和完整性。 在设置列权限时,根据实际需求合理分配角色的访问权限。 在使用并发控制和缓存功能时,注意其对数据实时性的影响。
数据视图类型
支持以下两种数据视图类型:
表视图
通过图形界面配置数据源中的表之间的关联关系,如一对一、一对多等,从而构建复杂的数据模型。
- 新建表视图
进入数据视图页面,点击"新建数据视图"。 选择"表视图"类型。
- 选择主表
从数据源中选择一个主表作为数据视图的基础。
- 配置关联关系
根据需要,选择其他表的关联字段与主表的关联字段。一个主表可以添加多个关联表。 关联关系有:左连接、右连接、内连接
- 选择字段
从关联表中选择需要的字段,并将它们添加到数据视图的字段列表中。
- 设置字段属性
为每个字段设置数据类型、格式等属性。 可以设置的类型和格式有:字符、数值、日期(YYYY-MM-DD HH.mm.ss、YYYY-MM-DD)、分类(国家、省份、城市、区县)
- 执行查询并预览结果
执行查询,检查结果是否符合预期。
- 数据模型
数据模型记录了当前数据视图查询结果的表结构和字段信息,可以修改数据模型中字段的类型或结构,也可以添加新的计算字段。
- 设置层次结构,可以基于层次结构对可视化对象进行钻取操作;
创建一个计算字段需要填写名称、类型和表达式;在中部的编辑器内编写表达式,计算字段的表达式仅允许包含以下内容:
- 字段名称:表达式中所使用的字段名称格式为 [字段名称],点击左侧字段列表中的字段,会自动添加字段名称到编辑器光标所在处
- 运算符: 支持 + - * / 等常规 SQL 运算符
- 函数:内置55 个通用函数,在右侧以列表展示,点击函数名称会自动添加到编辑器光标所在处。在编辑器中光标移动到函数名称上时,下方会提示函数简介和语法,支持的函数如下所列:
- SUM:总计、AVG:平均数、MAX:最大值、MIN:最小值、COUNT:计数、DISTINCT:去重计数、VAR:方差、STDDEV:标准差、MEDIAN:中位数
- ABS:绝对值、CEILING:向上取整、FLOOR:向下取整、POWER:返回指定数字的乘幂、ROUND:按指定位数四舍五入、SQRT:平方根
- EXP:返回e的n次方、LOG10:返回以10为底的对数、LN:返回数字的自然对数、MOD:取余、RAND:随机数、DEGREES:将弧度转换为角度
- RADIANS:将角度转换为弧度、TRUNC:删除数字的小数部分、SIGN:返回数字的符号、ACOS:反余弦、ASIN:反正弦、ATAN:反正切
- ATAN2:返回指定的X轴及Y轴坐标值的反正切、SIN:正弦、COS:余弦、TAN:正切、COT:余切、LENGTH:字符串长度、CONCAT:字符串拼接
- REPLACE:字符串替换、SUBSTRING:返回指定位置及长度的子字符串、LOWER:转换为小写、UPPER:转换为大写、LTRIM:去除前导空格
- RTRIM:去除尾部空格、TRIM:去除头尾空格、NOW:返回当前时间和日期、SECOND:返回时间值的秒数、MINUTE:返回时间值的分钟数
- HOUR:返回时间值的小时数、DAY:返回指定日期在当月的第几天、WEEK:返回日期的在当年的周数、QUARTER:返回日期的在当年的季度
- MONTH:返回日期中的月份、YEAR:返回日期中的年份、DAY_OF_WEEK:返回某个日期为一周中的第几天
- DAY_OF_MONTH:返回某个日期为当月的第几天、DAY_OF_YEAR:返回某个日期为当年的第几天
- IF:判断表达式,如果为真返回参数2,假则返回参数3、COALESCE:返回列表中的第一个非空值
- 计算字段还可以在做数据图表的编辑页面进行添加。
- 数据视图中不同字段类型有不同的前缀图标,字符和日期型显示为蓝色,数值型显示为绿色,计算字段显示为橙色。
设置列权限
设置不同角色对字段的访问权限。
- 配置示例:
SQL 视图
允许用户直接编写 SQ L语句来定义数据视图,适合对 SQL 熟悉的用户或需要复杂数据处理的场景。
- 新建 SQL 视图
进入数据视图页面,点击"新建数据视图"。 选择" SQL 视图"类型。
- 定义变量
在 SQL 视图配置中定义所需的变量,包括变量名称、类型(如字符串、数字等)、默认值。 变量可以在 SQL 语句和 Freemarker 模板中使用。
- SQL 代码编辑器
支持常用 SQL 关键字、数据源库/表/字段、变量名称提示 支持执行选中 SQL 片段 支持快捷键操作 执行:Ctrl / Cmd + Enter 保存:Ctrl / Cmd + s
- 代码编辑区工具栏
选择数据源 执行 美化 SQL 设置查询结果总行数 查询时长记录 保存 编辑基本信息 另存为
- 编写 SQL 语句
使用 Freemarker 模板语法编写 SQL 语句。 例如:SELECT * FROM table WHERE column = $variable$ 使用 Freemarker 的逻辑指令,如<#if>、<#elseif>、<#else>,来嵌入条件逻辑。
- 执行 SQL 并预览结果
执行 SQL 语句,传入相应的变量值,检查查询结果是否符合预期。
- 设置字段属性
为每个字段设置数据类型、格式等属性。 可以设置的类型和格式有:字符、数值、日期(YYYY-MM-DD HH.mm.ss、YYYY-MM-DD)、分类(国家、省份、城市、区县)
- 定义加工逻辑
如果需要,对查询结果进行进一步加工,如计算、转换等。
- 数据模型
参照 表视图 数据模型 说明。
- 列权限设置
以角色为主体,设置不同角色对字段的访问权限。
- 高级配置
根据需要配置并发控制和缓存策略。
- 配置示例:
数据视图加工流程
选择数据视图类型: 根据需求选择表视图或 SQL 视图。 配置表关系/编辑 SQL 语句:在表视图中,通过拖拽和连接表来设置关系;在 SQL 视图中,编写或粘贴 SQL 查询语句。 执行并预览:执行配置或编写的 SQL 语句,预览查询结果以确保数据正确。 设置数据模型和列权限: 定义字段的数据类型、格式和权限,确保数据的准确性和安全性。 保存数据视图: 只有当整个查询成功执行后,才能保存数据视图。
变量
通过使用变量允许在数据加工逻辑(SQL 语句)中加入参数,通过传入不同值来得到期望的查询结果。变量的使用场景包括仪表板中的动态筛选和不同用户的数据行权限控制
- 变量类型
查询变量:与仪表板筛选关联,通过筛选控制器传入不同的值来得到不同的查询结果。通常用于比字段筛选更灵活的筛选查询场景。 权限变量:与角色或用户绑定后预设值,用于控制不同用户返回不同的查询结果,实现数据行权限控制。 权限变量与查询变量不同在于,权限变量的值是预设的、在其关联的同一权限主体下是固定的,而查询变量的值在使用中是可以改变的。
内置包含用户信息的权限变量:
$DATART_USER_ID$ # 用户 ID
$DATART_USER_USERNAME$ # 用户名
$DATART_USER_EMAIL$# 用户 Email
$DATART_USER_NAME$ # 用户姓名
- 变量设置
可以在组织级别(主导航栏上)设置公共变量,这些变量可以被组织下的所有数据视图使用。 也可以在具体数据视图中创建专有变量(数据视图侧边栏的变量设置面板)。
公共变量与专有变量的区别:专有权限变量只能关联角色;专有变量只能在当前数据视图中使用。
- 新建和编辑变量
新建变量时,配置变量的名称、类型、值类型、默认值等。对于权限变量,还需关联权限主体并预设值。
名称:在 SQL 中输入的变量名称。 标题:用于组织成员自行编辑时显示的标题。 类型:查询变量、权限变量。 值类型: 不同值类型在解析时会做不同处理,其中字符和日期类型值会自动添加引号作为字符处理。有四种类型,分别是:字符、数值、日期和表达式。 编辑权限:提供给组织成员自行编辑的权限设置。 默认值: 预设默认值,可以添加多个;输入之后需要回车或点击右侧 √ 按钮确认添加。 使用表达式作为默认值: 在一些场景下,需要使用 SQL 表达式作为默认值,但在变量值变化时保持原始值类型。这种场景主要发生在查询变量的使用上,比如一个日期变量,默认值为 now(),但后续使用的是日期筛选控制器传递过来的日期格式化字符串,这种情况下值类型设为日期,但默认值使用表达式作为默认值即可。
- 变量的使用
查询变量在确定变量值为单值的情况下,可以在 SQL 语句中直接引入变量;在变量值可能为多值的情况下,需要在 SQL 语句中做一些处理。 权限变量无论是单值还是多值,都可以在 SQL 语句中直接引入,且需要登录具体角色或成员进入可视化页面查看。 变量在 SQL 语句中以 $变量名称$ 形式引用。 可以使用 freemarker 的条件语法来达到一些动态效果。 变量在 if 语句中前后不要使用 $ 包裹,更多详细的使用方式可以参考 freemarker 文档。
<#switch CREATETIMETYPE>
<#case 1>DATE_FORMAT(sCreateTime, '%Y-%m-%d') between ${STARTDAY?has_content?then("'" + CREATESTARTDAY + "'", "DATE_FORMAT(date_sub(now(),interval 365 day), '%Y-%m-%d') ")} and ${CREATEENDDAY?has_content?then("'" + CREATEENDDAY + "'", "DATE_FORMAT(now(), '%Y-%m-%d') ")} <#break>
</#switch>
<#if !TYPENAME?contains('所有') >
AND sTypeName IN ($TYPENAME$)
<#else></#if>
- 仪表板控制器中关联变量
在仪表板控制器中,可以关联变量以实现动态筛选和数据展示。
- 变量的删除
点击变量列表右侧的“删除”按钮,确认后可以永久删除该变量。
- 变量的高级使用
利用内置的权限变量,如 $DATART_USER_ID$、$DATART_USER_USERNAME$ 等,可以在数据视图中直接使用,实现基于用户信息的动态数据展示。
- 注意事项
确保变量的使用符合数据视图的预期效果,特别是在处理查询变量的多值情况时。 在设置权限变量时,明确角色或用户的权限,以确保数据安全。
- 配置示例:
视图高级配置
并发控制
并发控制是用于优化数据视图并发查询性能的功能。它主要应用于 SQL 加工逻辑复杂或数据库负载较大的情况,减少对数据库的重复查询压力(比如反复刷新图表和仪表板的情况下),优化用户体验。
- 并发控制策略
延迟刷新:对于来源于同一个数据视图、SQL 语句完全相同的请求,当首次查询未完成时,后续相同 SQL 语句的查询不会真正发送到数据库,而是在服务器队列中等待。首次查询返回结果后,服务器会将结果返回给所有队列中的查询,并清空队列。
例如某个数据视图查询需要 10 分钟,那么第一条查询发起后的 10 分钟内,相同 SQL 语句的查询将不再发送到数据库执行;直到第一条查询结果返回之后,这 10 分钟内发起的所有相同 SQL 语句的查询将会拿到同样的结果
延迟刷新的副作用是会导致数据时效性受到影响,对时效性要求较高的场景,开发者可以手动关闭并发控制选项。
- 并发控制与缓存
缓存功能与并发控制独立作用,可以一起开启。当两者同时开启时,首次查询结果会被缓存,后续相同 SQL 语句的查询会直接从缓存中获取结果,同时保持队列管理
- 并发控制的配置
并发控制功能在创建数据视图时默认开启。 可以在数据视图的高级配置选项中手动关闭或调整并发控制策略。 并发控制仅在可视化中生效,在数据视图开发阶段无效。
缓存
缓存用于提升数据查询性能,它可以存储首次查询的结果,并在后续相同查询中直接使用这些结果,避免重复查询数据库,从而提高数据视图的响应速度和减轻数据库负担。
- 缓存配置
缓存功能可以在数据视图的高级配置选项中开启或关闭。 缓存配置通常包括缓存过期时间的设置,即缓存数据的有效期。
- 缓存与并发控制
缓存可以与并发控制策略结合使用,以进一步提升性能。 当并发控制和缓存同时开启时,首次查询结果会被缓存,并在并发请求中被复用。
- 缓存失效策略
缓存数据会在设定的过期时间后自动失效,需要根据实际业务需求合理配置缓存时间。 缓存数据也可以根据数据源的更新情况手动或自动刷新。
- 注意事项
对于数据实时性要求较高的场景,应谨慎使用缓存,或设置较短的缓存过期时间。
- 缓存与数据安全
缓存中的数据应遵循与原始数据相同的安全和隐私标准。 需要确保缓存数据的访问同样受到适当的权限控制。
- 配置示例:
可视化设计
数据图表
数据图表是可视化的基础单元,允许用户通过拖拽字段到配置区进行可视化属性配置,将查询结果以图表形式展现。
- 创建数据图表
数据图表可以在可视化功能的目录树中创建,也可以在仪表板中直接创建。在目录树中创建的数据图表称作公共数据图表,可以独立展示、也可以被多个仪表板引用,与仪表板共同显示在目录树中;在仪表板中直接创建的数据图表称为专有数据图表,仅能与所属仪表板一起展示。
在主导航栏点击“可视化”菜单,点击“目录”顶部的加号按钮并 开始分析,进入图表编辑器,图表编辑器左侧关联数据视图的字段列表,中部是配置区,右侧是图表预览区,用于选择图表类型和预览图表。
数据配置变化会触发重新查询。
数据设置
- 字段列表
字段列表显示关联数据视图的字段,可以通过字段类型图标区分字段,字段列表可以 按名称排序 或 按原始字段顺序排序。 可以创建数据视图计算字段,填写名称、类型和表达式,支持字段名称、内置函数和运算符。具体内容请查看 数据视图 中相关内容。
将字段拖拽到数据配置栏中确定图表的数据来源,触发重新查询。 通过图表的数据配置项类型处理字段,如维度进行分组处理,指标进行聚合处理。
- 维度(可钻取)
别名:显示的列名称 排序:升序、降序
支持钻取的图表,在配置界面上会拥有一个“可钻取”的维度配置项,支持拖入多个字段,默认情况下将首个字段的值作为图表维度进行展示。
钻取需要在图表配置里记录一组维度字段,这一组字段将按照添加顺序自动构成钻取路径,在预览图表时通过左键点击或右键菜单来对当前展示的维度进行筛选、并进入到路径中下一个维度查看数据。通常情况下,这一组维度字段具有层次结构,来满足层层递进探索数据的目的。
支持钻取的图表,点击右键菜单可以看到以下 3 个选项: 显示下一层级:使用钻取路径中的下一个维度来替换当前维度展示图表; 展开下一层级:将钻取路径中的下一个维度与当前维度合并展示图表; 开启“点击下钻”:点击启用之后,左键点击图表元素将视为同时触发以下 2 个行为: 以该元素的维度值作为筛选条件 显示下一层级 当钻取到下一层级时,可以通过图表左下角的钻取路径导航、或是右键菜单的“上卷”选项来回到上一级。
- 指标
别名:显示的列名称 格式:默认格式,数值:可以设置小数位数、单位和千分位分隔;货币:可以设置小数位数、单位和千分位分隔;百分比:可以设置小数位数;科学型:可以设置小数位数 着色:部分图表支持设置指标数据在图表上显示的颜色,优先级低于着色配置项 聚合:对于计算字段且表达式有聚合函数,则不提供聚合选项;数值型字段支持 总计、平均值、计数、去重计数、最大值、最小值 6 种聚合方式,字符和日期型字段支持 计数、去重计数 2 种聚合方式 排序:升序、降序
- 筛选
筛选配置项支持拖入任意字段,不同的字段类型配置面板有所差别,支持将筛选字段以控制器形式展示出来供用户操作。
- 着色
支持放入一个字段来对图表做颜色可视化编码,目前仅支持拖入字符型字段。图表会依据字段值和预设的颜色分成多系列进行展示。
- 信息
部分直角坐标系图表支持,只能放置数值型字段,拖入的字段会被当做指标做聚合处理
- 尺寸
用于散点图和气泡地图做节点大小编码,拖入的字段会被当做指标做聚合处理
样式设置
样式配置栏用于改变图表展示规则,不影响数据查询。
分析设置
- 分页
表格支持在分析栏中启用分页和设置每页行数。
- 总行数
除表格外的其他图表都可以在分析栏中设置总行数,用于限制图表展示的数据总量。
- 参考线
可以给部分直角坐标系图表设置参考线和参考区间,目前仅支持折线图、面积图、柱状图、散点图和双 Y 轴图。
参考线需要关联到 1 个指标,数值可以选择关联指标的最大值、最小值、平均值,也可以选择手动设置常量值。
参考区间需要设置起始值和结束值,每个值分别需要关联 1 个指标,数值可以选择关联指标的最大值、最小值、平均值,也可以选择手动设置常量值。
- 汇总列、总计、小计
表格支持在分析栏中设置汇总列;汇总列只能是数值字段。
交互设置
交互栏可以设置“跳转”和“查看数据”等交互行为。
- 交互规则
一个图表可以同时拥有钻取、跳转、查看数据多种交互行为;下面是一些通用交互规则:
默认情况下,左键点击为选择图表元素;可以按住 Command / Ctrl 键来多选; 如果有多个交互行为都使用左键单击作为触发事件,那么在左键单击时都会触发。如果一个图表包含多个交互行为,建议将交互事件都设为右键菜单;
- 跳转
触发跳转时,浏览器会跳转到目标页面,并通过携带的 url 参数对目标页面进行数据筛选。 支持设置 3 种目标页面类型: 图表:通过 URL 上的参数对目标图表的数据视图字段进行筛选、或对变量进行赋值。 仪表板:匹配与 URL 参数名称相同的控制器,将参数值赋给控制器作为默认值。 URL:跳转到 URL 无法控制参数的使用。
每个图表可以创建多条跳转规则,每一条跳转规则需要设置以下内容: 名称 类型:跳转目的地类型 跳转到图表 跳转到仪表板 跳转到 URL 交互事件:触发交互行为的事件 左键单击:鼠标左键点击触发 右键菜单:打开鼠标右键菜单,通过选择菜单中的选项触发 打开方式 从当前页打开:改变浏览器地址,重定向到目标页 打开新窗口:从浏览器新窗口打开目标页 打开对话框:从弹窗中打开目标页 关系设置:不同的跳转类型关系设置不一样: 跳转到图表:需要设置当前图表与目标图表之间的字段关联关系;选项如下: 自动:按字段名称自动匹配,触发跳转时,会将当前图表中已作用的所有筛选条件,通过字段名称匹配传递到目标图表 自定义:手动配置字段关系,触发跳转时,仅将满足配置关系的筛选条件传递到目标图表 跳转到仪表板:需要设置当前图表与目标仪表板控制器之间的关联关系;触发跳转时,会将符合匹配关系的筛选条件值传递给目标仪表板控制器作为默认值 跳转到 URL:需要设置当前图表与目标地址 URL 参数的匹配关系;触发跳转是,会将符合匹配关系的筛选条件值赋给目标地址对应的 URL 参数
如果配置了跳转或查看数据行为在左键单击,那么点击图表元素时会立即触发行为;如果配置在右键菜单,当选择图表元素之后打开右键菜单,可以看到跳转和查看数据的选项;
触发跳转时,如果没有配置关系,或配置的关系未生效,依然会跳转到目标地址,但不携带任何参数。
- 查看数据
启用了查看数据配置之后,在图表中触发查看数据时,会弹窗展示所选择图表元素的汇总数据和明细数据。需要配置以下内容:
交互事件:触发交互行为的事件
左键单击:鼠标左键点击触发
右键菜单:打开鼠标右键菜单,通过选择菜单中的选项触发
选择字段:选择需要展示的字段
图表预览
可以在图表编辑器右侧即时预览图表,可以选择预览区域上方的小图标切换图表。
鼠标悬停到图标上可以查看该图表正常展示所需的条件。
在预览区的右上角,可以点击切换图表,查看原始数据(图表对应的数据)、SQL语句(图表对应数据的 SQL)、导出到 Excel(图表对应数据导出为 excel 表格并下载)等操作。
仪表板
仪表板通常用于呈现一组具有相关性的数据图表,由多种类型的组件构成,包括图表组件、媒体组件、容器组件和筛选组件等 。
- 创建仪表板
在主导航栏点击“可视化”菜单,点击“目录”顶部的加号按钮创建仪表板 。
- 仪表板编辑栏
添加数据图表组件 添加控制器 添加媒体组件 添加容器 撤销操作:点击保存按钮之前。都可以撤销。 重做操作:点击保存按钮之前。都可以重做。 删除组件 图层置顶(自由布局面板中) 图层置地(自由布局面板中) 复制组件:轻松地复制一个组件,复制出来的组件标题名称会自动修改 粘贴组件
布局
组件可以在自由布局模式下精确设置位置和尺寸,或在自动布局模式下由系统自动调整 。
- 自动布局
流式布局,会根据组件尺寸和位置自动填充屏幕,常用于制作移动端页面,在仪表板可视区域宽度 768 像素以上时组件会按照用户定义的比例进行显示,在 768 像素以下时会响应为移动端观看模式。
- 自由布局
可以设定面板具体尺寸,任意调整组件大小和位置,并且组件可以上下重叠,常用于制作大屏类页面。 可以设置面板的具体尺寸。默认为 1920*1080。 可以设置面板的缩放模式,[‘等比宽度缩放’,’等比高度缩放’,’全屏铺满’,’实际尺寸’]。 可以设置整个面板的背景颜色,以及背景图片。
组件通用设置
- 组件标题
可以修改组件的名称。在一个仪表板中,组件名称是唯一的。
- 位置&尺寸
在自由布局模式可以精确设置组件的位置和宽高。
- 标题格式
设置组件名称颜色。控制组件名称的显示,不显示。
- 背景
组件背景可以设置,组件的背景色,以及背景图片。
- 内边距
设置组件的内编辑,也可以理解为 widget 内的 padding 值。
- 边框
组件边框可以设置其边框的显示隐藏,边框的粗细,边框的样式,边框的颜色,边框的圆角。
- 自动刷新数据
组件可以设置是否开启自动刷新,以及设置自动刷新的频率,开启后默认 60 秒刷新一次数据。
图表组件
仪表板支持添加公共数据图表和私有图表。公共图表可被多个仪表板引用,而私有图表仅属于当前仪表板 。
公共图表:公共图表指得是在文件目录可见的,独立图表(dataChart),它可以被多个仪表板引入使用。
私有图表:是指在仪表板内创建的只属于当前仪表板的私有图表,不能被其他的仪表板使用。
控制器
用于筛选条件的可视化展示,允许用户通过预定义的控制器形式更改筛选值,实现动态查询数据的功能。提供的控制器: 常规、下拉列表、多选下拉列表、单选按钮、多选框、文本、下拉树、日期、日期范围、数值、数值范围、滑块、范围滑块、按钮、查询、重置
媒体组件
媒体组件用于展示图文和多媒体信息 。提供的媒体组件:
图片:可以上传本地图片或使用 URL
富文本: 双击进入编辑模式
计时器: 时间格式默认是 YYYY-MM-DD HH:mm:ss
iframe :双击输入网址
视频: 输入一个视频的地址
边框装饰:选择边框样式,配置主色和副色,输入文本内容
容器组件
容器组件,可以放置其他组件,支持标签页切换展示,增加仪表板的交互性和灵活性 。提供的容器组件:
标签卡:每个 Tab 控件可添加多个标签页,每个标签页内可放置多张图表。
轮播卡
- 交互与自动刷新
仪表板支持设置组件自动刷新,以及定义组件间的交互行为,如联动、跳转等 。
- 导出与分享
仪表板支持导出数据到 Excel,或将仪表板截图导出为图片文件或 PDF 。 支持导出仪表板配置为模板文件,并在任意 datart 服务导入模板文件来创建仪表板 。
故事板
故事板是用于组织和展示一系列可视化作品的工具。它通过编排顺序、播放模式和动画效果,通常用于类似演示文稿或轮播大屏展示场景 。
- 新建故事板
找到“演示”菜单,点击下方的加号按钮,输入配置项,保存后即可创建一个新的空白故事板 。需要配置的项: 故事板名称 添加故事页按钮 故事页切入动画效果 故事页切出动画效果 切换效果的快慢设置 是否开启自动播放 自动播放时每页的停留时间(秒)
- 添加故事页
进入故事板编辑器,点击“添加故事页”按钮,从弹出的对话框中选择一个仪表板加入,每个仪表板将成为故事板的一个故事页 。
- 删除故事页
在编辑模式下,选中一个故事页,使用键盘上的“back”键,弹出删除确认对话框后,确认即可删除该故事页 。
- 设计切换效果
可以为每个故事页设计切入和切出动画效果,点击预览可以观看切换效果 。
- 设置自动播放
在编辑器中可以开启自动播放功能,并设置每页的停留时间。预览时,用户可以通过播放页面的控制按钮手动控制播放 。
- 分享管理
故事板支持分享管理功能,可以新建和编辑分享链接,并设置认证方式,如公共分享、口令保护或登录访问,并定义数据权限 。
- 移至回收站与还原
故事板可以被移至回收站进行归档,或从回收站还原。在回收站中,故事板会被重命名,格式为“原名称.时间戳”,并可以通过填写新的名称和目录来完成还原 。
- 删除故事板
在回收站中查看故事板信息时,可以选择“删除”来永久删除故事板 。
视图其他设置
- 发布
未发布前是制作中状态,此时对拥有查看权限的成员不可见;发布之后拥有查看权限的成员才能看到。 取消发布后会重新回到制作中状态。
- 同步数据
如果需要更新图表中的数据,点击工具栏右侧的扩展菜单中的“同步数据”选项。
- 另存为
另存为功能支持将当前图表复制并保存。
- 分享
分享管理功能用于管理当前图表的分享链接。可以在工具栏右侧的扩展菜单中找到“分享管理”选项。
截止日期:指定当前分享链接的过期时间;可选项,当不填写时链接永久有效。需要注意的是,由于截止日期在应用数据库中以 timestamp 类型存储,因此不支持设置 2038 年以后的日期
认证方式:
无:公共分享,任何人都可以访问。数据权限与分享者相同。 口令:会随链接一同生成一个口令,访问分享链接时需要正确输入口令才能查看内容。数据权限与分享者相同。 登录:访问分享链接时需要登录查看内容。该认证方式会多出 2 个额外选项。
数据权限:可以选择访问链接时所查看数据的权限。当选择“登录者”时,会依照不同的登录者展示符合其自身权限的数据;当选择“分享者”时,所有人访问链接查看到的数据与分享者相同 指定角色/成员:指定能够访问当前分享链接的角色和成员;可选项,当不填写时按照访问用户自身的权限设定来展示内容。
点击确认之后,生成的分享链接会展示在面板上。可以在面板上快捷复制链接地址、编辑和删除链接
- 导出图表
支持将图表以 Excel、PDF、图片 3 种形式导出。会自动异步地执行下载任务。
- 导出模板
可以将图表配置导出为 .drt(datart template file)模板文件;点击扩展按钮中的“导出为模板”选项即可导出,导出的模板中包括样例数据。
- 导入模板
支持在任意 datart 服务导入模板文件来创建图表;点击可视化目录顶部的新建按钮,选择“导入模板”即可根据模板创建图表,创建好的图表使用的是样例数据,可以替换为自己的数据视图。
- 回收站
删除目录会永久删除该目录,删除图表会将图表先放到回收站,或点击扩展菜单中的 移至回收站 选项也能将图表移到回收站,移至回收站的数据图表会被重命名为原名称.时间戳,且为只读状态;
回收站的图表不能被使用,经过 还原 操作后可以继续使用,还原时可以修改还原后的名称和目录。
定时任务
定时任务功能允许用户将可视化作品以截图或文件形式自动发送到其他终端,如通过邮件或企业微信。定时任务需要正确配置邮箱和截图服务才能正常使用
- 新建定时任务
访问主导航栏的“定时任务”菜单,点击列表顶部的加号按钮,开始新建表单。 新建表单包含基本信息(任务名称、类型、描述、定时任务生效时间范围和执行周期等)。 发送内容时,选择需要发送的仪表板或数据图表
- 邮件配置
对于邮件类型的定时任务,配置项如下:。 主题:邮件主题名称 文件类型(图片或 excel): 图片:发送内容的截图,需要设置截图宽度 excel: 发送内容的查询原始数据 收件人: 仅支持发送给已注册用户,输入用户名/姓名/邮箱会有提示 抄送/密送 内容:邮件正文,支持插入图片
- 企业微信配置
对于企业微信类型的定时任务,配置项如下: 机器人 webhook 地址:企业微信群聊机器人的 webhook 地址 文件类型: 同邮件一致
- 操作定时任务
创建完成后,可以启动/停止定时任务,或立即执行该任务
- 编辑和删除定时任务
可以编辑已创建的定时任务,但需注意,已启动的定时任务无法编辑和删除,需要先停止 。 可以移至回收站归档不再使用的定时任务,或从回收站还原和删除它们。
- 配置示例: