描述
配置(修改)表格行的属性。支持按通用身份对象匹配一个/多个行,并批量修改行的打印可见性、用户自定义属性(attrs)。
接口
bool SetRowConfig(identity : object, config: object)| 项目 | 说明 |
|---|---|
| 入参 | identity:行匹配条件,为 identity 通用身份对象 |
| 入参 | config:JSON 对象,描述要设置的行属性(见 config-参数) |
参数
identity-参数
配置目标行的匹配条件,必须为 identity 通用身份对象(JSON 对象)
| 字段 | 类型 | 说明 |
|---|---|---|
id |
string | 单行匹配:按 id 精确定位一个行 |
ids |
string[] | 多行匹配:按 id 列表批量定位多个行 |
name |
string | 按 name 匹配 |
uuid |
string | 按 uuid 匹配(最稳定,推荐跨会话定位) |
sourceClass |
string | 按数据源类型匹配其下所有行 |
subDocName |
string | 限定在指定子文档范围内查找(兼容旧版写在 config 中的 subDocName) |
说明:行匹配采用
MatchIdentity模式,仅返回与身份条件匹配的行;未匹配到任何行时接口返回false。
config-参数
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
id |
string | 行的 id |
|
name |
string | 行的 name |
|
sourceClass |
string | 数据源类型 | |
printVisibility |
int | 打印可见性:0=显示(默认)/ 1=隐藏 / 2=占位,不打印 |
|
attrs |
object | 用户自定义属性(键值对) | |
adjustMode |
int | 自动行高模式 | |
forbidSplit |
bool | 禁止拆分行 | |
titleRow |
bool | 标题行 | |
enterGenerateNewRow |
bool | 回车生成新行 | |
height |
number | 配置高度(cm) |
返回值
bool 类型:
| 返回值 | 含义 |
|---|---|
true |
找到至少一个匹配行并已写入(无论是否实际产生值变化) |
false |
未找到匹配行;或文档为空 / 当前文档禁止 API 编辑 |
示例代码
示例 1:按 id 修改单行打印可见性
// 隐藏指定行(不打印)
thinkEdiotr.SetRowConfig({id:"row_001"}, {printVisibility:1});
// 显示指定行
thinkEdiotr.SetRowConfig({id:"row_001"}, {printVisibility:0});文档更新时间: 2026-07-22 11:57 作者:admin