---
order: 3
navTitle: 组件属性
---
# 组件表达式变量{#component-properties}

<!-- AUTO-GENERATED: npm run build:meta-docs -->

本文列出组件和单元格类型在表达式中可读取的变量。表达式编辑器中通常显示中文名称。

## 使用方式{#usage}

在表达式中引用组件变量时，先选择组件，再选择变量。例如“姓名”输入框的“值”变量可写成：

```text
[姓名].[值]
```

不同组件可读取的变量不同。通用变量来自组件能力，特殊变量来自组件自己的属性配置。

## 组件变量{#component-vars}

### 表格{#component-group-table}

本组组件：交叉表（`crossTable`）、分组表（`groupTable`）、明细表（`columnTable`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 地图{#component-group-map}

本组组件：2D地图（`gisMap2D`）、3D地图（`gisMap3D`）、百度地图（`gisMapBmap`）、高德地图（`gisMapAmap`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 文本{#component-group-text}

本组组件：富文本（`richtext`）、文本（`text`）、标题（`title`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 装饰{#component-group-decoration}

本组组件：背景块（`backgroundBlock`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 容器{#component-group-container}

本组组件：分隔面板（`splitPanel`）、多页面板（`panelBook`）、对话框（`dialog`）、折叠面板（`collapsePanel`）、抽屉（`drawer`）、浮动面板（`datasetFloatPanel`）、浮动面板（`queryFloatPanel`）、网页段落栏（`section`）、面板（`panel`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。<br><br>**以下组件不支持：**<br>~~对话框（`dialog`）~~<br>~~抽屉（`drawer`）~~ |

### 输入{#component-group-input}

本组组件：列表上传（`listUpload`）、列表选择（`selector`）、勾选框（`checkbox`）、勾选框组（`checkboxGroup`）、卡片上传（`cardUpload`）、多行输入（`multipleInput`）、字段过滤（`fieldsFilter`）、密码输入（`passwordInput`）、富文本输入（`richtextInput`）、引用表（`datasources`）、快速搜索（`searchbox`）、搜索框（`searchInput`）、数值输入（`numberInput`）、文本输入（`input`）、日期选择（`dateSelector`）、时间选择（`timeSelector`）、条件指示器（`filtersViewer`）、树形选择（`treeSelector`）、签名（`signInput`）、表达式输入（`expInput`）、资源选择（`resSelector`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$value` | 值 |  |
| `$txt` | 标题 | 同`$txt` |
| `$validate` | 校验 | 所有校验规则汇总后的结果，有一条校验规则不通过，校验结果为该校验规则计算结果。<br><br>**以下组件不支持：**<br>~~条件指示器（`filtersViewer`）~~ |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |
| `$autoFilter` | 自动过滤的编译属性名 | **以下组件不支持：**<br>~~列表上传（`listUpload`）~~<br>~~卡片上传（`cardUpload`）~~<br>~~密码输入（`passwordInput`）~~<br>~~条件指示器（`filtersViewer`）~~<br>~~签名（`signInput`）~~<br>~~资源选择（`resSelector`）~~ |
| `$inputValue` | 输入值 | 输入组件处于输入状态下，用户手动输入的内容。<br><br>**仅以下组件支持：**<br>多行输入（`multipleInput`）<br>密码输入（`passwordInput`）<br>富文本输入（`richtextInput`）<br>数值输入（`numberInput`）<br>文本输入（`input`）<br>表达式输入（`expInput`） |

### 统计图{#component-group-chart}

本组组件：双向条形图（`pyramid`）、图标条形图（`hpictogramBar`）、图标柱状图（`pictogramBar`）、折线图（`line`）、散点图（`scatter`）、旭日图（`sunburst`）、条形图（`hbar`）、柱形图（`bar`）、桑基图（`sankey`）、玫瑰图（`rose`）、环形图（`ring`）、矩阵图（`treemap`）、组合图（`combo`）、词云图（`wordCloud`）、象形条形图（`hpictorialBar`）、象形柱形图（`pictorialBar`）、雷达图（`radar`）、面积图（`area`）、饼图（`pie`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 指标图{#component-group-measure}

本组组件：KPI（`kpi`）、仪表盘（`gauge`）、图标条（`iconBar`）、水位图（`waterPercent`）、进度条（`dataBar`）、进度环（`percentRing`）、里程表（`odometer`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 嵌入{#component-group-embed}

本组组件：Superpage（`embedSuperpage`）、仪表板（`embedDashboard`）、报表（`embedReport`）、数据模型（`embedDataModel`）、文档（`document`）、流程进度（`embedFlowProgress`）、程序流（`embedActionFlow`）、表单（`embedForm`）、表单应用（`embedFapp`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。<br><br>**以下组件不支持：**<br>~~程序流（`embedActionFlow`）~~ |

### 按钮{#component-group-button}

本组组件：图标按钮（`iconButton`）、按钮（`button`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 媒体{#component-group-media}

本组组件：图标（`icon`）、图片（`image`）、视频（`video`）、装饰图标（`decorativeIcon`）、音频（`audio`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 导航{#component-group-navigator}

本组组件：卡片标签页（`tabbarCard`）、按钮标签页（`tabbarButton`）、简洁分页栏（`paginationSimple`）、简约标签页（`tabbarSimple`）、菜单（`menu`）、阶梯分页栏（`paginationStep`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。<br><br>**以下组件不支持：**<br>~~菜单（`menu`）~~ |
| `$pagingStatus_targetComponent` | 分页状态 | 分页栏组件的分页状态系统属性，由系统自动生成并维护，记录分页栏所需的分页状态数据。其<br>值为包含 pageSize, pageNum, totalRowCount 的 JSON 对象。<br><br>件。<br><br>**仅以下组件支持：**<br>简洁分页栏（`paginationSimple`）<br>阶梯分页栏（`paginationStep`） |

### 开发{#component-group-develop}

本组组件：HTML（`html`）、JS组件（`jsComponent`）、网页（`webview`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 工具{#component-group-util}

本组组件：二维码（`qrcode`）、条形码（`barcode`）、计时器（`timer`）、选中分组（`selectionGroup`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。<br><br>**仅以下组件支持：**<br>二维码（`qrcode`）<br>条形码（`barcode`） |
| `$time` | 时间 | **仅以下组件支持：**<br>计时器（`timer`） |
| `$steps` | 触发次数 | **仅以下组件支持：**<br>计时器（`timer`） |
| `$seconds` | 秒 | **仅以下组件支持：**<br>计时器（`timer`） |
| `$active` | 激活状态 | **仅以下组件支持：**<br>计时器（`timer`） |
| `$value` | 值 | **仅以下组件支持：**<br>选中分组（`selectionGroup`） |

### 图层{#component-group-layer}

本组组件：区块图层（`districtLayer`）、图片图层（`imageLayer`）、底图图层（`amapBaseLayer`）、底图图层（`bmapBaseLayer`）、底图图层（`leafletBaseLayer`）、散点图层（`scatterLayer`）、标记图层（`markerLayer`）、棱柱图层（`prismLayer`）、气泡图层（`bubbleLayer`）、热力图层（`heatMapLayer`）、百度区块图层（`bmapDistrictLayer`）、百度散点图层（`bmapScatterLayer`）、百度热力图层（`bmapHeatmapLayer`）、百度特效点图层（`bmapEffectPointLayer`）、百度飞线图层（`bmapFlyLineLayer`）、飞线图层（`flyLineLayer`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 数据{#component-group-data}

本组组件：Excel列表（`excelList`）、树（`tree`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |

### 其他组件{#component-group-other}

本组组件：categoryTree（`categoryTree`）、dataList（`dataList`）、dataPeriodList（`dataPeriodList`）、detailDataList（`detailDataList`）、leafOrgPeriodList（`leafOrgPeriodList`）、orgTree（`orgTree`）、页面（`fillForms`）。

本组组件可读取以下变量。多个组件共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |

## 单元格类型变量{#celltype-vars}

### 单元格类型{#celltype-group-cell-type}

本组单元格类型：HTML（`html`）、列表上传（`listUpload`）、列表选择（`selector`）、勾选框（`checkbox`）、勾选框组（`checkboxGroup`）、卡片上传（`cardUpload`）、图片（`image`）、多行（`multipleInput`）、按钮组（`buttonGroup`）、数值（`numberInput`）、文本（`input`）、文本（`text`）、日期（`dateSelector`）、时间（`timeSelector`）、标签（`label`）、树形选择（`treeSelector`）、计算（`calculate`）、评分（`rating`）、进度（`progress`）、链接（`link`）。

本组单元格类型可读取以下变量。多个单元格类型共用同一个变量时，变量说明只写一次。

| 变量 | 名称 | 说明 |
| :--- | :--- | :--- |
| `$sorts` | 组件排序条件 | 组件排序条件是运行时动态作用到查询上的排序条件，作用于组件定义的第一个查询。排序条件<br>格式为`组件ID 排序方式`，排序方式见`SortDirection`。<br><br>组件排序条件**会**覆盖数据集排序。<br><br>合法的排序条件：<br>- `col1 asc`，col1 是列子组件 ID<br>- `col1 desc`<br>- `col1 asc, col2 desc`，多个排序条目用逗号分隔<br><br>**使用场景**<br><br>- 列表的列头排序<br>- 分组表的列头排序<br>- 交叉表的行维度列头排序 |
| `$pageSize` | 每页行数 | 控制组件的分页大小。超出最大行数限制时会抛出异常。 |
| `$pageNum` | 当前页 | 控制组件的分页数。超出最大页数时，会返回空结果集。 |
| `$totalRowCount` | 总行数 |  |
| `$pageRowCount` | 当前页行数 | 当前页的查询结果行数，如果不是最后一页，则返回`pageSize`，最后一页不满分页大小时，返回实<br>际行数。 |
| `$totalPageCount` | 总页数 | 该属性由`总行数 / 分页大小`计算得出。 |
| `$hasNextPage` | 是否有下一页 | 当前页码为最大页码时返回`false`。 |
| `$hasPreviousPage` | 是否有上一页 | 当前页码为0时返回`false`。 |
| `$value` | 值 | **以下组件不支持：**<br>~~图片（`image`）~~<br>~~按钮组（`buttonGroup`）~~<br>~~链接（`link`）~~ |
| `$id` | 组件ID | 唯一标识一个组件，如程序流中的一个节点、页面中的一个可视化组件。<br><br>也用作数据行的下级变量，表示当前行的标识值。行标识值并非固定字段，而是根据<br>计算区域的查询类型动态推断：<br><br>- 分组查询：值为维度成员值，即分组字段的聚合键。<br>- 层次展开的明细查询：值为层次路径值，表示当前行在层次树中的位置。<br>- 纯明细查询：值为行主键值。<br>- 单行计算区域：无行标识，返回 undefined。 |
| `$name` | 名称 | 如输入组件的标题、字段的名称（不是物理字段名）、程序流节点的标题…… |
| `$type` | 类型 | 一个字符串，表示组件的类型。<br><br>如程序流节点的类型、可视化组件的类型…… |
| `$visible` | 显示 | 1. 对可视化组件，表示组件是否是显示的，如按钮、菜单是否可见。<br>2. 对程序流节点，没有效果，总是true<br>3. 对于数据集字段，表示字段是否可查询数据，例如列权限限制了某些字段不能查看或提交，或者当<br>   前用户在工作流的某个节点不能查看某些字段，有时候字段可以查看，但是不能提交，见<br>   `$enable`。<br>4. 对于数据集，表示是否可以查询数据，例如没有任何列权限，或者当前用户在工作流的某个节点不能<br>   查看数据集的所有字段。 |
| `$txt` | 标题 | 同`$txt`<br><br>**以下组件不支持：**<br>~~HTML（`html`）~~<br>~~图片（`image`）~~<br>~~按钮组（`buttonGroup`）~~<br>~~链接（`link`）~~ |
| `$validate` | 校验 | 所有校验规则汇总后的结果，有一条校验规则不通过，校验结果为该校验规则计算结果。<br><br>**以下组件不支持：**<br>~~HTML（`html`）~~<br>~~图片（`image`）~~<br>~~按钮组（`buttonGroup`）~~<br>~~文本（`text`）~~<br>~~链接（`link`）~~ |
| `$autoFilter` | 自动过滤的编译属性名 | **以下组件不支持：**<br>~~HTML（`html`）~~<br>~~列表上传（`listUpload`）~~<br>~~卡片上传（`cardUpload`）~~<br>~~图片（`image`）~~<br>~~按钮组（`buttonGroup`）~~<br>~~文本（`text`）~~<br>~~链接（`link`）~~ |
| `$inputValue` | 输入值 | 输入组件处于输入状态下，用户手动输入的内容。<br><br>**仅以下组件支持：**<br>多行（`multipleInput`）<br>数值（`numberInput`）<br>文本（`input`） |