仪表板参数

功能概述

仪表板参数是一个全局参数，在定义仪表板参数时即确定了参数的数据来源以及数据类型。

仪表板参数既可以是一个静态数据，比如给定一个具体的数值；也可以是动态数据，比如为参数绑定用户上下文信息、绑定某个组件的数据列或某个筛选器的动态实时数据。

仪表板参数主要用于仪表板数据过滤，具体可用于组件筛选器、仪表板全局筛选器、仪表板跳转以及运行计划当中。

仪表板参数

添加参数

在全局设置面板中找到仪表板参数设置项，单击右侧的“ + ”即可打开仪表板参数设置窗口。

参数设置面板分为上下两部分：上方设置参数的基本属性；下方设置参数的数据来源。

参数属性设置

首先我们来看参数的各个基本属性。

属性	说明	示例
参数名称	为仪表板参数设置一个名称，用于参数内部识别。	--
提示文本	仪表板参数在具体应用时显示出的名称，在实际使用时将以此名称来表示该参数。默认会与参数名称保持一致，也可以另外设置。
数据类型	按照实际情况选择参数值的数据类型。支持布尔型、日期型、日期时间型、整型、浮点型、字符串型和多维数据类型。
	- 当选择数据类型为日期型或日期时间型时，可使用转换功能。具体用法请见本页下方的数据来源内容。
	- 多维数据是一个特殊的数据类型，表示该参数可以获取到当前数据点中多个维度的数据。当参数的数据类型为多维数据时，可为其绑定数据列或筛选器（多维列表或多维下拉筛选器），并且可以选择多个字段进行参数赋值。
多值数据	用于筛选器或仪表板跳转时过滤数据，当需要多个值进行数据筛选时，则需开启多值数据功能。否则仅第一值生效。	--
多行数据	用于仪表板运行计划中。开启多行数据功能后，文档参数输入框将支持自动回行显示。

参数数据来源

接下来我们来看参数的数据来源。

参数其实是一个传递数据的载体，我们给参数赋予一定的数据来源，接下来使用该参数的地方就可以接收到我们设定的那些数据。

数据来源	说明	示例
默认数据	设置仪表板参数的默认数据。开启参数属性中的多值数据属性后，可添加多个默认数据。支持静态数据、用户数据、组织数据和查询结果。
	静态数据：也即手动输入固定的静态数据。
	用户数据：选择用户的上下文信息，不同用户登录时参数值会根据当前用户的信息改变。
	组织数据：选择一个组织上下文信息，不同组织的用户登录时参数值会根据当前用户的组织信息改变。
	查询结果：选择一个数据集或数据模型中的某个字段，并设定参数默认为该字段中的最大值或最小值。请注意此处所选字段的数据类型需与参数的数据类型保持一致。比如您想要选择一个日期字段作为参数的默认值，那么参数的数据类型也须设置为日期型。
绑定	您也可以为仪表板参数绑定某一个组件或筛选器中的数据，使其呈现动态参数效果。实际使用时，选择不同的组件数据或筛选器数据时，参数的值也就随之动态变化。
	数据列：选择数据列后，需要设置具体是哪个组件的哪个字段列。数据列设置对话框中的组件，指的是组件名称。选择字段时，仅当参数的数据类型为“多维数据”时，勾选多个字段有效。其他数据类型时，勾选多个字段则以数据集中出现的第一字段为准。
	筛选器：选择筛选器，然后设置具体绑定的筛选器以及字段。同样，筛选器设置对话框中选择筛选时，呈现的是筛选器的名称。选择字段时，仅当参数的数据类型为多维数据时，勾选多个字段有效。其他数据类型时，勾选多个字段则以数据集中出现的第一字段为准。另外，当我们绑定数值范围或日期范围筛选器时，需要选择绑定的具体值是这个范围的最大值还是最小值。当将参数的多值属性打开时，这里就可以选择值区间，这样参数获取的值为两个值，也即这个范围的最大值和最小值。
转换	当仪表板参数的数据类型为日期型或日期时间型时，数据来源将多出一个转换选项。表示将当前获取的值进行转换。转换规则为原始值、部分值、调整值或 UTC 字符串。 - 原始值：即表示不转换数据，但支持转换格式。 - 部分值：即表示将获取到的日期或日期时间转为一个仅包含部分信息的整型值。如下图，将2018/10/18 转换为了2018，仅保留了年。此时参数的数据类型其实已经变成了整型，未来在使用该参数时，仅能过滤整型的数据。 - 调整值：将获取到的值进行一定的调整，并可以转换格式，此时参数的数据类型不改变。 - UTC 字符串：将获取到的值转换为 UTC 字符串格式。这样就可以将日期时间类的值转换为 UTC 字符串进行显示，或者向外跳转传递了。比如下图左侧为日期筛选器，右侧为富文本组件绑定了仪表板参数，该仪表板参数的值来自于左侧的日期筛选器，并且设置了 UTC 字符串转换。这样就把日期时间格式显示成了 UTC 字符串。