---
order: 20
navTitle: 组件命令
---
# 组件命令{#component-commands}

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

本文列出程序流“执行组件命令”节点可以调用的组件命令。配置时先选择目标组件，再选择该组件支持的命令；可以先按组件分组查看支持哪些命令，再到命令详情中查看参数。

## 按组件分组查看{#command-groups}

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

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

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`focus`](#command-focus) | 聚焦 | **以下组件不支持：**<br>~~条件指示器（`filtersViewer`）~~ | 聚焦。 |
| [`blur`](#command-blur) | 失去焦点 | **以下组件不支持：**<br>~~条件指示器（`filtersViewer`）~~ | 失焦。 |
| [`clear`](#command-clear) | 清空 | 所有输入 | 清空组件内容。 |
| [`uploadFile`](#command-upload-file) | 上传文件 | **仅以下组件支持：**<br>列表上传（`listUpload`）<br>卡片上传（`cardUpload`） |  |

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

本组组件：树（`tree`）。

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`find`](#command-find) | 搜索 | 所有数据 | 按关键字搜索。 |
| [`locateNextFoundItem`](#command-locate-next-found-item) | 定位下一个节点 | 所有数据 | 定位到下一个或上一个搜索结果。 |

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

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

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`addBlankRows`](#command-add-blank-rows) | 新增行 | **仅以下组件支持：**<br>表单（`embedForm`）<br>表单应用（`embedFapp`） | 增加空白行。 |
| [`removeRows`](#command-remove-rows) | 删除行 | **仅以下组件支持：**<br>表单（`embedForm`）<br>表单应用（`embedFapp`） | 删除指定行。 |
| [`forceRefresh`](#command-force-refresh) | 刷新 | 所有嵌入 |  |
| [`zoomIn`](#command-zoom-in) | 放大 | **仅以下组件支持：**<br>文档（`document`） |  |
| [`zoomOut`](#command-zoom-out) | 缩小 | **仅以下组件支持：**<br>文档（`document`） |  |
| [`print`](#command-print) | 打印 | **仅以下组件支持：**<br>Superpage（`embedSuperpage`）<br>报表（`embedReport`）<br>文档（`document`） |  |
| [`export`](#command-export) | 导出 | **仅以下组件支持：**<br>报表（`embedReport`）<br>文档（`document`） |  |
| [`search`](#command-search) | 搜索 | **仅以下组件支持：**<br>文档（`document`） |  |
| [`validateForm`](#command-validate-form) | 校验 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |
| [`saveDraft`](#command-save-draft) | 保存 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |
| [`submitData`](#command-submit-data) | 提交 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |
| [`importData`](#command-import-data) | 导入 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |
| [`exportData`](#command-export-data) | 导出数据 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |
| [`lockData`](#command-lock-data) | 锁定 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |
| [`unlockData`](#command-unlock-data) | 解锁 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |
| [`calculateForm`](#command-calculate-form) | 计算 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |
| [`deleteFAppData`](#command-delete-fapp-data) | 删除 | **仅以下组件支持：**<br>表单应用（`embedFapp`） |  |

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

本组组件：计时器（`timer`）。

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`start`](#command-start) | 开始 | 所有工具 | 启动计时器。 |
| [`stop`](#command-stop) | 停止 | 所有工具 | 停止计时器。 |

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

本组组件：视频（`video`）、音频（`audio`）。

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`stop`](#command-stop) | 停止 | **仅以下组件支持：**<br>视频（`video`） | 停止计时器。 |
| [`forceRefresh`](#command-force-refresh) | 刷新 | **仅以下组件支持：**<br>音频（`audio`） |  |
| [`play`](#command-play) | 播放 | **仅以下组件支持：**<br>视频（`video`） |  |
| [`fullScreen`](#command-full-screen) | 最大化 | **仅以下组件支持：**<br>视频（`video`） |  |
| [`setMuted`](#command-set-muted) | 设置是否静音播放 | **仅以下组件支持：**<br>视频（`video`） |  |

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

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

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`rollup`](#command-rollup) | 上卷 | 所有地图 |  |
| [`setView`](#command-set-view) | 设置地图视角 | 所有地图 |  |

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

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

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`rollup`](#command-rollup) | 上卷 | 所有统计图 |  |

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

本组组件：仪表盘（`gauge`）、水位图（`waterPercent`）、进度环（`percentRing`）。

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`rollup`](#command-rollup) | 上卷 | 所有指标图 |  |

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

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

本组支持以下命令。多个组件共用同一个命令时，命令详情只在后文写一次。

| 命令 | 名称 | 支持组件 | 说明 |
| :--- | :--- | :--- | :--- |
| [`forceRefresh`](#command-force-refresh) | 刷新 | **以下组件不支持：**<br>~~HTML（`html`）~~ |  |
| [`print`](#command-print) | 打印 | **以下组件不支持：**<br>~~JS组件（`jsComponent`）~~ |  |

## 命令详情{#command-details}

### setProperty{#command-set-property}

设置组件属性。

例如：设置组件显示隐藏、启用禁用、输入只读等。

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `name` | `字符串` | 属性名。 |
| `value` | `任意值` | 属性值。 |

### focus{#command-focus}

聚焦。

### blur{#command-blur}

失焦。

### clear{#command-clear}

清空组件内容。

### find{#command-find}

按关键字搜索。

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `keyword` | `字符串` | 搜索关键字。 |
| `searchMode` | `ComponentSearchMode` | 搜索模式。默认值：`flatFilter`。可选值：、、。 |

### locateNextFoundItem{#command-locate-next-found-item}

定位到下一个或上一个搜索结果。

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `forward` | `布尔值` | 是否向后定位。默认值：`true`。为`true`时定位下一个搜索结果，为`false`时定位上一个搜索结果。 |
| `recursive` | `布尔值` | 是否循环定位。默认值：`true`。为`true`时到达边界后从另一端继续定位。 |

### addBlankRows{#command-add-blank-rows}

增加空白行。

在目标行位置插入一行或多行空白数据。可指定插入位置（前/后、下级）和初始数据。未指定
`targetRow` 时，插入到数据视图的末尾。

启用行操作特征`rowOperation`才支持此命令。

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `count` | `数值` | 新增行数。默认值：`1`。 |
| `targetRow` | `JSON` | 插入目标行，不存在时插入到表格最后一行。 |
| `asChild` | `布尔值` | 为true时插入到目标行下级。默认值：`false`。 |
| `insertBefore` | `布尔值` | 为true时插入到目标行之前，否则插入到目标行之后。默认值：`false`。 |
| `data` | `JSON \| JSON[]` | 新增空行的初始化数据。单行时传一个 JSON 对象；新增多行时传 JSON 对象数组，数组下标和新建行顺序一一对应。<br>没有提供对应下标的数据时，该行保持空白。<br><br>JSON 对象的 key 是组件 id，如 `"column1"`、`"column2"`；value 是要写入该组件的值。 |
| `autoSelect` | `布尔值` | 自动选中插入的行。默认值：`false`。 |

### removeRows{#command-remove-rows}

删除指定行。

未传 `row` 时，默认删除触发命令的当前行；若当前行也不存在会弹出警告
提示。

启用行操作特征`rowOperation`才支持此命令。

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `row` | `JSON \| JSON[]` | 操作的行。 |
| `autoSelect` | `布尔值` | 自动选中其他行。默认值：`false`。 |

### start{#command-start}

启动计时器。

启动或恢复计时器的运行，开始按配置的间隔或持续时间执行计时逻辑。

### stop{#command-stop}

停止计时器。

暂停计时器的运行，停止所有定时回调。

### rollup{#command-rollup}

### forceRefresh{#command-force-refresh}

### uploadFile{#command-upload-file}

### zoomIn{#command-zoom-in}

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `level` |  | 缩放值。 |

### zoomOut{#command-zoom-out}

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `level` |  | 缩放值。 |

### print{#command-print}

### export - document{#command-export-document}

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `name` |  | 文件名。 |

### export - exportFormat{#command-export-export-format}

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `fileName` |  | 文件名。 |
| `exportFormat` |  | 导出格式。默认值：`xlsx`。可选值：`xlsx`、`pdf`。 |
| `sheet` |  | 工作表。默认值：`current`。可选值：`current`：当前、`all`：所有。 |
| `exportPage` |  | 导出页。默认值：`currentPage`。可选值：`currentPage`：当前页、`allPage`：所有页。 |
| `showExportDialog` |  | 弹出导出选项对话框。默认值：`false`。 |
| `selectPageEnabled` |  | 允许选择导出页。默认值：`false`。 |
| `selectSheetEnabled` |  | 允许选择工作表。默认值：`false`。 |
| `selectFormatEnabled` |  | 允许选择导出格式。默认值：`false`。 |
| `allSelectFormat` |  | 可选格式。默认值：`["xlsx","pdf"]`。可选值：`xlsx`、`pdf`。 |

### search{#command-search}

### validateForm{#command-validate-form}

### saveDraft{#command-save-draft}

### submitData{#command-submit-data}

### importData{#command-import-data}

### exportData{#command-export-data}

### lockData{#command-lock-data}

### unlockData{#command-unlock-data}

### calculateForm{#command-calculate-form}

### deleteFAppData{#command-delete-fapp-data}

### setView{#command-set-view}

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `zoom` |  | 缩放级别。 |
| `centerLng` |  | 中心经度。 |
| `centerLat` |  | 中心纬度。 |
| `rotation` |  | 旋转角度。 |
| `pitch` |  | 俯仰角度。 |
| `animation` |  | 显示过渡动画。 |

### play{#command-play}

### fullScreen{#command-full-screen}

### setMuted{#command-set-muted}

| 参数 | 类型 | 说明 |
| :--- | :--- | :--- |
| `muted` |  | 是否静音。 |