[]
在仪表板中,参数通常用于增强数据可视化的交互性及灵活性,允许用户动态地调整图表、筛选数据或改变分析的视角,而无需直接修改底层数据或模型。
仪表板参数既可以是一个静态数据,比如给定一个具体的常量值;也可以是动态数据,比如为参数绑定用户上下文信息、绑定某个组件的数据列或某个筛选器的动态实时数据。
参数在仪表板中的核心作用是赋予用户控制权,通过动态调整数据视图、支持交互式探索和简化设计,提升仪表板的灵活性和实用性。它们特别适合需要用户参与、场景分析或多维度数据展示的场景。
仪表板参数主要用于仪表板数据过滤,具体可用于组件筛选器、仪表板全局筛选器、仪表板跳转以及运行计划当中。
在全局设置面板中找到仪表板参数设置项,单击右侧的“ + ”即可打开仪表板参数设置窗口。
在参数设置窗口指定参数名称、提示文本以及参数类型。点击“确定”,即可保存该参数。
参数名称:为仪表板参数设置一个名称,用于参数内部识别。
提示文本:仪表板参数在具体应用时显示的名称,在实际使用时将以此名称来表示该参数。默认会与参数名称保持一致,也可以另外设置。
多值数据:在仪表板的筛选器或页面跳转场景中,当需要根据参数过滤数据时,如果希望支持多个值进行数据筛选,必须勾选多值数据。否则,系统默认只会应用参数的第一个值。
数据类型:用于设置参数的数据类型。支持如下几种数据类型:布尔型、日期型、日期时间型、整型、浮点型、字符串类型以及多维数据。
type=warning
注意:
在仪表板的过滤数据等场景中,参数的数据类型必须与被过滤字段保持一致,以确保筛选逻辑的正确性和结果的准确性。如果参数的数据类型与目标字段不匹配,可能会导致筛选失败、数据缺失或显示错误的结果。
在运行计划中使用:如果想在运行计划设置的面板中通过下拉列表来选择参数值,请勾选该选项并绑定数据来源。
允许输入多行文本:当勾选了“在运行计划中使用”且未绑定可用数据,在创建运行任务时,在输入框中输入内容会自动折行。
仪表板支持如下几种数据类型的参数:布尔型、日期型、日期时间型、整型、浮点型、字符串类型以及多维数据。
提供了4种方式来设置参数的默认值:
静态数据
用户通过输入常量值的方式来设置参数的默认值。输入的默认值的格式与参数的数据类型有关。
用户数据
获取当前登录用户的用户上下文信息,并将其设置为参数的默认值。
以下图为例,增加了一个字符串型的参数,将它的默认值设定为当前登录用户的用户名,在文本组件中显示该参数,可以看到文本组件中展示了当前登录用户的用户名。
用户的用户上下文信息通过创建用户时填入的属性值及扩展数据获得,详情请参考:用户上下文属性管理。
组织数据
和使用用户数据一样,通过用户所在组织的组织上下文信息给参数赋值,如何设置组织上下文信息,详情请参考:组织属性和组织上下文信息。
查询结果
参数的默认值还可以来源于一个查询结果。
选择通过查询结果获取默认值,点击输入框,在弹出的查询结果对话框中选择查询结果、数据字段和聚合方式,将获取到的值作为查询参数的默认值。
type=info
注意:
此处所选字段的数据类型需与参数的数据类型保持一致。
比如您想要选择一个日期字段作为参数的默认值,那么参数的数据类型也须设置为日期型。
可以为仪表板参数绑定一个组件或筛选器中的数据,使其呈现动态参数效果。实际使用时,选择不同的组件数据的数据点或筛选器的项目时,参数值也会随之动态变化。
数据列
选择数据列后,需要设置具体是哪个组件的哪个字段列。
type=info
注意:
选择字段时,仅当参数的数据类型为“多维数据”时,勾选多个字段有效。若选择其他数据类型时,勾选多个字段则以数据集中出现的第一字段为准。
勾选的字段应为绑定到该组件的字段,若勾选则字段不是绑定到组件上的字段,则获取不到对应的值。
筛选器
选择筛选器,然后设置具体绑定的筛选器。
所选的筛选器种类不同,筛选器设置对话框的内容略有不同:
标签列表
标签列表仅能绑定一个字段,当选择了该筛选器时,无需做进下一步的绑定选择。
多维列表框/多维下拉框
该类型的筛选器可以绑定一个或多个字段,当选择了该筛选器,用户可进一步选择字段。
type=info
注意:
当参数的类型为“多维数据”时,勾选多个字段有效,否则,以选中的第一个字段为准。
日期范围/相对日期
当选择日期范围筛选器,用户可以选择日期筛选器的最大值或最小值进行绑定。
当在参数设置中勾选了“多值数据”,且筛选器的显示模式被设置为“日期范围”,用户还可以选择“值区间”同时获取最大值及最小值。
type=info
注意:
参数类型必须为日期型或日期时间型。
数值范围
当选择数值范围筛选器,用户可以选择数值范围筛选器的最大值或最小值进行绑定。
当在参数设置中勾选了“多值数据”,用户还可以选择“值区间”同时获取最大值及最小值。
文本筛选器
文本筛选器仅能绑定一个字段,当选择了该筛选器时,无需做进下一步的绑定选择。
当参数的数据类型为日期型或日期时间型时,数据来源将多出一个转换选项。表示将当前获取的值进行转换。
转换规则为原始值、部分值、调整值或 UTC 字符串。
- 原始值: 即表示不转换数据,但支持转换格式。
- 部分值: 即表示将获取到的日期或日期时间转为一个仅包含部分信息的整型值。
如下图,将2018/10/18 转换为了2018,仅保留了年。此时参数的数据类型其实已经变成了整型,未来在使用该参数时,仅能过滤整型的数据。
- 调整值: 将获取到的值进行一定的调整,并可以转换格式,此时参数的数据类型不改变。
- UTC 字符串: 将获取到的值转换为 UTC 字符串格式。
这样就可以将日期时间类的值转换为 UTC 字符串进行显示,或者向外跳转传递了。
比如下图左侧为日期筛选器,右侧为富文本组件绑定了仪表板参数,该仪表板参数的值来自于左侧的日期筛选器,并且设置了 UTC 字符串转换。这样就把日期时间格式显示成了 UTC 字符串。
仪表板参数设置完成后,主要用于数据过滤,比如:
直连数据集使用仪表板参数,参考下图
先添加仪表板参数,仪表板参数设置绑定筛选器
再将仪表板参数绑定到数据集参数,即可实现动态联动