跳至主要內容

全局参数

2025年1月13日大约 8 分钟

全局参数是看板内公用的参数,是可以在看板内任何地方访问和使用的参数或变量,可用于存储一些需要共享的数据。

全局参数入口

全局参数展示于看板的高级属性里。

  • (① 清空): 点击清空按钮后出现二次弹窗确认按钮,再次确定清空当前看板的全局参数设置。

  • (② 删除): 鼠标悬浮在某个全局参数展示区时,该区域右上角出现红色删除按钮,点击后删除当前全局参数。

  • 参数配置: 点击后打开全局参数配置弹窗。

配置介绍

  • ① 关闭: 点击按钮关闭全局参数弹窗,添加和修改的参数和规则不会被保存。

  • ② 取消/确定: 取消按钮规则同关闭;只有点击确定按钮时添加和修改的参数及规则才会生效。

  • ③ 参数管理区: 用于添加和管理全局参数。

    • (① 添加): 点击添加一个全局参数,添加的全局参数数量无限制。

    • (② 删除): 鼠标悬浮在某个全局参数上时,该区域右侧出现红色删除按钮,点击后删除当前全局参数。

    • 参数名: 展示当前全局参数的名称,双击变为输入框,可修改全局参数名称。

  • ④ 参数配置区: 设置全局参数的基本信息。

    • ① 标题: 设置全局参数的标题,默认与名称相同,在使用全局参数时展示的就是标题值。

    • ② 类型: 设置全局参数的类型,可设置为文本、数字或布尔值。

    • ③ 默认值: 设置全局参数的默认值,当全局参数无值或被清空时,使用默认值。

    • ④ 接收参数: 开启时接收 url 里的同名参数值为全局参数初始值。

  • ⑤ 添加规则: 点击此按钮可在规则区添加一条规则,可添加的规则数量无限制。

  • ⑥ 规则区: 展示使用该全局参数的规则列表,即当该全局参数的值发生变化时,规则中定义的组件列表中被勾选的组件会在选择的字段上按照此值进行联动筛选。

    • (① 删除): 删除当前的规则。

    • ② 数据资源: 选择使用规则的数据资源,下拉列表展示的是当前看板中使用到的全部的数据资源。选中数据资源后,使用该数据资源的组件会展示在组件列表中。

    • ③ 字段: 选择发生联动筛选时使用的字段名,下拉列表展示的是当前选中的数据资源的全部字段。

    • ④ 组件列表: 显示当前数据资源下的组件列表,被勾选的组件才会在全局参数的值变化时发起联动筛选。

    • ⑤ 组件过滤器: 当组件列表过多不方便查找时,可以通过此过滤器来查找目标组件。

    • ⑥ 全选: 将当前组件列表中展示的组件全部选中,全选被勾选时点击可实现全部取消选中,可配合组件过滤器使用。

使用场景

添加全局参数

  1. 在右侧边栏的看板高级属性配置中点击参数配置进入全局参数面板。

  2. 在左侧的参数定义栏点击添加一个名为prov的全局参数。

  3. 在弹窗右侧设置全局参数基本信息,标题修改为“省”,类型为“文本”,默认值为空,接受请求参数打开。

  4. 点击弹窗右下方的确定按钮,完成全局参数的添加操作。

联动中的使用和设置

  1. 创建数据卡片: 进入卡片设计器,数据资源选择超市-订单[示例],列设置为(维度),行设置为数量(度量),名称改为超市-省-数量,保存并发布。

  2. 看板内添加分析卡片: 进入看板设计器,将超市-省-数量组件拖入设计器作为看板的一个分析卡片组件。

  3. 添加全局参数和使用规则: 添加一个全局参数并在此全局参数下添加一条使用规则。

    3.1 按照添加全局参数步骤,添加一个名为prov的全局参数。

    3.2 点击参数配置,点击弹窗右侧底部的添加关联资源按钮添加一条全局参数的使用规则。

    3.3 使用规则的数据资源选中超市-订单[示例],字段选择,组件列表勾选超市-省-数量

    3.4 点击弹窗右下方的确定按钮,使规则生效。当全局参数prov的值发生变化时,超市-省-数量组件就会在字段上按照prov的值发生联动过滤了。

  4. 添加设置全局参数的规则: 在联动配置中添加用于设置全局参数的规则。

    4.1 从左侧边栏标准组件中拖拽一个下拉框组件到设计器中。

    4.2 选中下拉框组件,在右侧边栏高级选项卡中为下拉框设置数据配置,为防止自动联动规则产生影响,我们选择手动录入的方式添加下拉选项。

    4.3 在右侧边栏高级选项卡中点击联动配置进入组件联动配置面板,并在弹窗左侧选中全局参数联动

    4.4 点击弹窗右侧底部的添加规则按钮添加一条全局参数设置规则。

    4.5 源字段选择下拉框(组件标题),全局参数选择(全局参数标题)。

    4.6 点击弹窗右下方的确定按钮,使规则生效。当下拉框的值发生变化时,全局参数prov(省)也会随之变化。

经过以上的步骤,当下拉框组件改变时,超市-省-数量卡片就可以发起联动筛选了。效果示例:

在默认值中使用

  1. 按照添加全局参数步骤,添加一个名为prov的全局参数。

  2. 从左侧边栏标准组件中拖拽一个文本输入组件到设计器中。

  3. 选中文本输入组件,在右侧边栏配置面板中找到默认值配置,勾选全局参数选项,在下方的下拉框中选择想要使用的全局参数。

  4. 为方便演示,我们按照联动中的使用和设置下的第 4 大步添加一个下拉框作为改变全局规则的来源。

经过以上步骤,文本输入组件的默认值就会随着全局参数prov的变化而变化了。效果示例:

在富文本中使用

  1. 按照添加全局参数步骤,添加一个名为prov的全局参数。

  2. 从左侧边栏标准组件中拖拽一个富文本组件到设计器中。

  3. 富文本组件内输入文案“全局参数”,然后点击富文本组件的插入全局参数按钮,从下拉列表中选择全局参数“省”。

  4. 为方便演示,我们按照联动中的使用和设置下的第 4 大步添加一个下拉框作为改变全局规则的来源。

经过以上步骤,富文本内的全局参数就可以实时展示当前最新值。效果示例:

在参数配置中使用

  1. 按照添加全局参数步骤,添加一个名为prov的全局参数。

  2. 看板内添加一个按钮组件,在右侧边栏中点击链接配置按钮打开链接配置弹窗。

  3. 链接看板选择一个已发布的看板。

  4. 链接参数配置项中点击添加一个参数。

  5. 输入参数名,值类型选择为全局参数,参数值就会变为下拉列表,选择全局参数prov

  6. 为方便演示,我们按照联动中的使用和设置下的第 4 大步添加一个下拉框作为改变全局规则的来源。

经过以上步骤,点击按钮时,就会打开目标看板,并且在参数中携带 prov 参数。演示示例:

批量修改

全局参数支持通过 postMessage 传入实现批量修改,传入格式为

{hetu: {params: {key1: 'value1', key2: 'value2'}}}

对应的看板接收到 message 后,会将名称为key1的全局参数赋值为 value1,名称为key2的全局参数赋值为 value2

上次编辑于: 2025/2/26 18:32:09
贡献者: guohuizheng,zhangshuai