组件命令

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

按组件分组查看

输入

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

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

命令	名称	支持组件	说明
focus	聚焦	以下组件不支持： 条件指示器（filtersViewer）	聚焦。
blur	失去焦点	以下组件不支持： 条件指示器（filtersViewer）	失焦。
clear	清空	所有输入	清空组件内容。
uploadFile	上传文件	仅以下组件支持： 卡片上传（cardUpload） 列表上传（listUpload）

数据

本组组件：树（tree）。

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

命令	名称	支持组件	说明
find	搜索	所有数据	按关键字搜索。
locateNextFoundItem	定位下一个节点	所有数据	定位到下一个或上一个搜索结果。

嵌入

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

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

命令	名称	支持组件	说明
addBlankRows	新增行	仅以下组件支持： 表单（embedForm） 表单应用（embedFapp）	增加空白行。
removeRows	删除行	仅以下组件支持： 表单（embedForm） 表单应用（embedFapp）	删除指定行。
forceRefresh	刷新	所有嵌入
zoomIn	放大	仅以下组件支持： 文档（document）
zoomOut	缩小	仅以下组件支持： 文档（document）
print	打印	仅以下组件支持： 报表（embedReport） 文档（document） Superpage（embedSuperpage）
export	导出	仅以下组件支持： 报表（embedReport） 文档（document）
search	搜索	仅以下组件支持： 文档（document）
validateForm	校验	仅以下组件支持： 表单应用（embedFapp）
saveDraft	保存	仅以下组件支持： 表单应用（embedFapp）
submitData	提交	仅以下组件支持： 表单应用（embedFapp）
importData	导入	仅以下组件支持： 表单应用（embedFapp）
exportData	导出数据	仅以下组件支持： 表单应用（embedFapp）
lockData	锁定	仅以下组件支持： 表单应用（embedFapp）
unlockData	解锁	仅以下组件支持： 表单应用（embedFapp）
calculateForm	计算	仅以下组件支持： 表单应用（embedFapp）
deleteFAppData	删除	仅以下组件支持： 表单应用（embedFapp）

工具

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

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

命令	名称	支持组件	说明
start	开始	所有工具	启动计时器。
stop	停止	所有工具	停止计时器。

媒体

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

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

命令	名称	支持组件	说明
stop	停止	仅以下组件支持： 视频（video）	停止计时器。
forceRefresh	刷新	仅以下组件支持： 音频（audio）
play	播放	仅以下组件支持： 视频（video）
fullScreen	最大化	仅以下组件支持： 视频（video）
setMuted	设置是否静音播放	仅以下组件支持： 视频（video）

地图

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

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

命令	名称	支持组件	说明
rollup	上卷	所有地图
setView	设置地图视角	所有地图

统计图

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

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

命令	名称	支持组件	说明
rollup	上卷	所有统计图

指标图

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

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

命令	名称	支持组件	说明
rollup	上卷	所有指标图

开发

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

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

命令	名称	支持组件	说明
forceRefresh	刷新	以下组件不支持： HTML（html）
print	打印	以下组件不支持： JS组件（jsComponent）

命令详情

setProperty

设置组件属性。

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

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

focus

聚焦。

blur

失焦。

clear

清空组件内容。

find

按关键字搜索。

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

locateNextFoundItem

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

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

addBlankRows

增加空白行。

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

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

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

removeRows

删除指定行。

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

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

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

start

启动计时器。

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

stop

停止计时器。

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

rollup

forceRefresh

uploadFile

zoomIn

参数	类型	说明
level		缩放值。

zoomOut

参数	类型	说明
level		缩放值。

print

export - document

参数	类型	说明
name		文件名。

export - exportFormat

参数	类型	说明
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

validateForm

saveDraft

submitData

importData

exportData

lockData

unlockData

calculateForm

deleteFAppData

setView

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

play

fullScreen

setMuted

参数	类型	说明
muted		是否静音。