Skip to content

资源工坊

Sidebar Navigation

成为开发者

开放平台概述

应用类型与形态

用户身份体系

应用权限体系

企业自建应用开发流程

自建应用概述

创建企业自建应用

配置应用基础信息

配置应用能力信息

申请应用上架

企业审核应用

三方应用上架指南

应用上架概述

服务商认证

创建第三方企业应用

填写应用介绍

开发应用

发布应用

上架应用市场

移动端应用市场对接指引

合作与支持

产品咨询

技术支持

开发工具与资源

API在线调试器

人员选择器组件

文件选择器组件

云文档页面定制调试工具

文档水印定制组件

协议与规范

第三方服务商应用功能质量规范标准

服务商开通授权承诺函

WPS协作卡片

卡片概述

卡片整体结构

卡片状态

添加卡片待办状态

添加卡片筛选状态

展示型组件

文本

多列文本

图片

轮播图

文本+小图

文本+中图

线条

视频

文本+按钮

交互型组件

交互型组件说明

交互回传说明

按钮

下拉操作按钮

列表选择器

日期选择器

输入框

WPS工作台小组件开发

图文列表小组件外部API

WPS协作机器人开发

webhook机器人

值班机器人

WPS多维表格开发

WPS多维表格开发能力体系

在线脚本AirScript

简介

快速入门

脚本令牌

简介

接口说明

应用场景

高级服务

简介

网络 API

云文档 API

邮件 API

数据库 API

内置基础类型

脚本经典案例

内嵌使用SDK

简介

快速入门

基础用法

配置参数

挂载节点

事件处理

高级用法

界面定制案例

API文档

简介

数据表

新建数据表

删除数据表

移动数据表

添加说明

设置图标

重命名

创建副本

监听增加数据表的事件

监听重命名数据表的事件

监听删除数据表的事件

视图

新建视图

重命名

复制视图

删除视图

设置个人/公共视图

设置快速访问视图

表格视图

冻结列数

行高

甘特视图

开始日期字段

结束日期字段

时间线颜色

工时统计

定位上一页

定位至今天

设置折叠

查询视图

设置查询条件

设置背景图

日历视图

时间线颜色

开始日期字段

结束日期字段

标题设置

监听增加视图的事件

监听删除视图的事件

监听重命名视图的事件

记录

插入记录

删除记录

查看记录

筛选记录

选中记录

展开记录

关闭记录

设置单元格内容

设置单元格的字体颜色

设置单元格的填充颜色

监听修改记录的事件

监听删除记录的事件

字段

新增字段

复制字段

隐藏/显示字段

删除字段

移动字段

设置字段名

设置字段类型

设置默认值

禁止录入重复值

日期字段

获取字段值

设置字段值

显示星期

显示时间

面板标记休息日

数字字段

获取字段值

设置字段值

显示千位符

超链接字段

获取字段值

设置字段值

设置显示样式

单选项/多选项字段

获取字段值

设置字段值

设置选项

允许填写时添加选项

等级字段

获取字段值

设置字段值

设置等级

图片和附件字段

获取字段值

设置字段值

设置显示样式

仅可通过移动端拍摄上传

联系人字段

获取字段值

设置字段值

插入多个联系人

发送通知

关联字段

获取字段值

设置字段值

关联多条记录

自动关联

关联表格ID

关联视图ID

关系组集合

地址字段

获取字段值

设置字段值

填写详细地址

预设指定地址

默认值

地址级别数

公式字段

公式的文本表达式

自动任务字段

类型

通知联系人

触发时间

级联字段

获取字段值

设置字段值

设置选项

显示完整的选择路径

选项标题

最后修改人/最后修改时间字段

监听所有字段

监听某些字段

监听增加字段的事件

监听删除字段的事件

监听修改字段的事件

排序

设置排序升序属性

添加排序条件

移动排序条件

筛选

设置筛选条件

添加筛选条件

删除筛选条件

分组

添加分组

删除分组

展开分组

分组折叠

同步数据

刷新数据

解除同步关系

创建同步表

创建合并表

合并表-添加数据源

合并表-删除数据源

公告

公告-展开/收起

窗口公告栏

其他

设置导航栏可见性

代理界面元素

设置经典布局

窗口导航栏

API

Sheet

Sheet对象

——属性——

FieldDescriptors

Icon

Id

Name

RecordRange

Views

——方法——

AddDescription

AppendFromCloud

AppendFromLocal

Copy

CreateFields

Delete

DeleteFields

FieldId

GetFields

Share

UpdateFields

——事件——

OnCreateRecord

OnDelete

OnRename

Sheets

Sheets对象

——方法——

Add

Delete

GetActiveSheetId

GetActiveSheetIndex

Item

ItemById

Move

——事件——

OnCreateSheet

CalendarView

CalendarView对象

——属性——

BeginField

EndField

TimelineColor

TimelineColorFollowField

TimelineColorType

TitleField

CardViewUI

CardViewUI对象

——属性——

ViewMode

FormView

FormView对象

——方法——

RequiredFields

FormViewUI

FormViewUI对象

——方法——

DesignForm

FillInForm

GanttView

GanttView对象

——属性——

BeginField

Calendars

EndField

IsOnlyWorkDay

TimelineColor

TimelineColorFollowField

TimelineColorType

GanttViewUI

GanttViewUI对象

——属性——

GanttGridFold

ViewMode

——方法——

Today

GridView

GridView对象

——属性——

FrozenCols

RowHeight

KanbanView

KanbanView对象

——方法——

MoveUnGroupToFirst

MoveUnGroupToLast

SetGroupCondition

QueryView

QueryView对象

——属性——

BackgroundImage

QueryFields

View

View对象

——属性——

Description

Fields

Filters

Groups

Id

IsFavView

IsPersonal

Name

RecordRange

Records

Selection

Sorts

Type

ViewShare

——方法——

Activate

Copy

Delete

——事件——

OnDelete

OnRename

ViewShare

ViewShare对象

——属性——

CanAddRemoveRecords

EditableFieldsInfo

EditableRecType

ShareUrl

SharedLinkInfo

VisibleRecType

——方法——

ChangePermission

SetEnable

Views

Views对象

——属性——

ActiveView

Count

——方法——

Add

Delete

Item

ItemById

——事件——

OnCreate

Record

Record对象

——属性——

Id

Text

Value

——方法——

Delete

Item

Select

RecordRange

RecordRange对象

——属性——

Count

FieldId

Font

Id

Index

Interior

Text

Value

——方法——

Add

Condition

Delete

Item

Select

SetValues

——事件——

OnDeleteRecord

OnUpdate

Records

Records对象

——属性——

Count

——方法——

Add

Delete

FindNext

FindPrevious

Item

AddressField

AddressField对象

——属性——

IsDetailedAddress

IsUsePresetAddress

Level

PresetAddress

Attachment

Attachment对象

——属性——

FileId

FileName

FileSize

FileType

ImgSize

LinkUrl

AttachmentField

AttachmentField对象

——属性——

DisplayStyle

IsOnlyCameraUpload

AutoLinkCondition

AutoLinkCondition对象

——属性——

DateIntersectedValues

IntersectedConds

LinkSheetFieldId

OpType

SheetCondContents

SheetCondType

AutoLinkConditions

AutoLinkConditions对象

——属性——

Count

——方法——

Add

Delete

Item

AutoLinkGroup

AutoLinkGroup对象

——属性——

Conditions

AutoLinkGroups

AutoLinkGroups对象

——属性——

Count

——方法——

Add

Delete

Item

AutomationField

AutomationField对象

——属性——

ContactField

ExecuteTime

TriggerField

Type

ButtonField

ButtonField对象

——属性——

BackgroundColor

Icon

SuccessText

Text

TextColor

CascadeField

CascadeField对象

——属性——

AllCascadeOption

IsDisplayAllLevel

Title

CascadeOption

CascadeOption对象

——属性——

Children

Id

Value

CascadeOptions

CascadeOptions对象

——属性——

Count

——方法——

Add

Item

ContactField

ContactField对象

——属性——

IsSupportMulti

IsSupportNotice

DBCellValue

DBCellValue对象

——属性——

Value

DateField

DateField对象

——属性——

IsShowHoliday

IsShowTime

IsShowWeek

Field

Field对象

——属性——

FieldDescriptor

Id

Name

Type

Visible

Width

——方法——

Copy

Move

FieldDescriptor

FieldDescriptor对象

——属性——

DefaultVal

DefaultValType

Description

Id

IsSyncField

IsValueUnique

Name

NumberFormat

Type

——方法——

Apply

Delete

——事件——

OnDelete

OnUpdate

FieldDescriptors

FieldDescriptors对象

——属性——

Count

——方法——

AddField

Delete

FieldDescriptor

Item

——事件——

OnCreate

Fields

Fields对象

——属性——

Count

——方法——

Item

FormulaField

FormulaField对象

——属性——

Formula

IsShowPercentAsProgress

ValueType

LinkField

LinkField对象

——属性——

AutoLinkGroups

IsAutoLink

IsSupportMultiLinks

LinkSheet

LinkView

LookupField

LookupField对象

——属性——

LinkFieldId

LookupFieldId

LookupSheetId

LookupType

NumberField

NumberField对象

——属性——

IsShowThousand

RatingField

RatingField对象

——属性——

MaxRating

SelectField

SelectField对象

——属性——

IsAddItemWhenInputting

Items

TextLinkRun

TextLinkRun对象

——属性——

Address

Length

LinkRunsType

Pos

TextLinkRuns

TextLinkRuns对象

——属性——

Count

——方法——

Item

UrlField

UrlField对象

——属性——

HyperLinkText

WatchedField

WatchedField对象

——属性——

IsWatchedAll

WatchedFields

Sort

Sort对象

——属性——

Field

IsAscending

——方法——

Delete

Sorts

Sorts对象

——属性——

Count

IsAuto

——方法——

Add

ChangeOrder

Item

Criteria

Criteria对象

——属性——

Field

Op

Value

Filter

Filter对象

——属性——

Criteria

FieldId

FilterId

——方法——

Delete

Filters

Filters对象

——属性——

Count

Operator

——方法——

Add

Clear

Item

Group

Group对象

——属性——

Field

IsAscending

Unit

——方法——

Delete

Groups

Groups对象

——属性——

Count

IsTempUnFold

——方法——

Add

FoldAll

Item

UnFoldAll

DbComment

DbComment对象

——属性——

Id

Text

——方法——

Delete

RecordComment

RecordComment对象

——属性——

Count

——方法——

Add

Delete

Item

RecordComments

RecordComments对象

——属性——

Count

——方法——

Item

——事件——

OnCreate

OnDelete

DataSource

DataSource对象

——方法——

CreateSummarySheet

CreateSyncDBSheets

ImportFromCloud

ImportFromLocal

SummarySheet

SummarySheet对象

——属性——

SourceConfigs

——方法——

RefreshSyncSheet

RemoveSheetSyncLink

Permission2

Permission2对象

——属性——

Collaborators

DefaultRole

GroupDefaultRole

Roles

PermissionSetting

PermissionSetting对象

——属性——

EditableAndViewableRecordsConfigType

EditableFieldSetting

EditableRecordSetting

IsAllowAddRecord

IsAllowRemoveRecord

PermissionType

Sheet

ViewableFieldSetting

ViewableRecordSetting

PermissionSettings

PermissionSettings对象

——属性——

Count

——方法——

Item

Role

Role对象

——属性——

Description

Id

IsBuiltIn

Name

PermissionSettings

Type

Users

——方法——

AddUser

DeleteAndReplacedBy

DeleteUser

Roles

Roles对象

——属性——

Count

NoPermissionRole

——方法——

Add

Item

Chart

Chart对象

——属性——

Id

Name

Type

——方法——

Copy

Delete

Charts

Charts对象

——属性——

Count

——方法——

Add

Item

Selection

Selection对象

——方法——

GetSelectionType

IsCell

IsRowSelect

SelectCell

SelectCol

SelectRange

SelectRow

SummarySourceConfig

SummarySourceConfig对象

——属性——

FileId

SheetIds

——方法——

SetSheets

SetUrl

SummarySourceConfigs

SummarySourceConfigs对象

——属性——

Count

——方法——

Add

Apply

Delete

Item

SyncDBSheet

SyncDBSheet对象

——方法——

RefreshSyncSheet

RemoveSheetSyncLink

NoticeBar

NoticeBar对象

——属性——

Visible

ApiResult

ApiResult对象

——属性——

Code

Message

枚举值

DbAutomationPresetType

DbButtonIcon

DbFieldValueType

DbFilterCriteriaOpType

DbGroupUnit

DbLookupFunction

DbPermissionType

DbSharedCriteriaType

EditableAndViewableRecordsConfigType

FilterOpType

RoleBuildInType

SharedLinkPermissionType

SharedLinkToType

Font

Font对象

——属性——

Color

Interior

Interior对象

——属性——

Color

Navigator

Navigator对象

——属性——

Visible

Window

Window对象

——属性——

FormViewUI

GanttViewUI

GridViewUI

Navigator

NoticeBar

——方法——

BailHook

DisplayRecord

HiddenAllRecord

SetLayout

本文内容

高级用法

更多高级用法可参考多维表API

Pager

上一篇事件处理

下一篇界面定制案例

脚本令牌

高级服务

基础用法

数据表

视图

表格视图

甘特视图

查询视图

日历视图

记录

字段

日期字段

数字字段

超链接字段

单选项/多选项字段

等级字段

图片和附件字段

联系人字段

关联字段

地址字段

公式字段

自动任务字段

级联字段

最后修改人/最后修改时间字段

排序

筛选

分组

评论

同步数据

公告

其他

API

Sheet

Sheets

CalendarView

CardViewUI

FormView

FormViewUI

GanttView

GanttViewUI

GridView

KanbanView

QueryView

View

ViewShare

Views

Record

RecordRange

Records

AddressField

Attachment

AttachmentField

AutoLinkCondition

AutoLinkConditions

AutoLinkGroup

AutoLinkGroups

AutomationField

ButtonField

CascadeField

CascadeOption

CascadeOptions

ContactField

DBCellValue

DateField

Field

FieldDescriptor

FieldDescriptors

Fields

FormulaField

LinkField

LookupField

NumberField

RatingField

SelectField

TextLinkRun

TextLinkRuns

UrlField

WatchedField

Sort

Sorts

高级用法