WPS API总览

API总览#

API

全部表格实例(Application)工作簿(Workbook)工作表(Sheet)区域(Range)筛选(AutoFilter)排序(Sort)排序字段(SortField)字体(Font)边框(Border)图形(Shape)图表(Chart)超链接(Hyperlink)条件格式集合(FormatConditions)条件格式(FormatCondition)数据有效性规则(Validation)工作表函数(WorksheetFunction)枚举(Enum)

分类

全部attributefunction

表格实例(Application)

属性数据类型简介

ActiveSheet	Sheet	当前的活动工作表
Sheets	Sheets	当前文件的所有工作表
ActiveWorkbook	Workbook	当前的文档
Selection	Range	当前的选区对象
Cells	Range	当前工作表所有单元格
Columns	Range	当前工作表所有列
Rows	Range	当前工作表所有行
FileInfo	Object	当前文档的信息
UserInfo	Object	当前文档的用户信息
Enum	Enum	所有的枚举类型

方法返回类型简介

Range(address)	Range	获取当前 ActiveSheet 的某个区域(address 指定)
Sheets(name)	Sheet	获取名称为 name 的工作表

工作簿(Workbook)

属性数据类型简介

ActiveSheet	Sheet	工作簿中的活动工作表
Sheets	Sheets	工作表的所有对象集合
ReadOnly	Boolean	文档是否只读
ReadOnlyComment	Boolean	文档是否只读可评论的权限
SupportReadOnlyComment	Boolean	文档是否支持只读可评论权限

方法返回类型简介

Save()	String(JSON)	保存文件的改动
GetComments()	String(JSON)	获取整个 Workbook 的评论
ExportAsFixedFormat()	String(JSON)	导出整个表格的 PDF 或者 Img 图片

工作表(Sheet)

属性数据类型简介

Id	String	该工作表的 Id
Name	String	该工作表的名称
Index	Number	该工作表在所有工作表的索引值
Cells	Range	该工作表上所有单元格的集合
Columns	Range	该工作表上所有列的集合
Rows	Range	该工作表上所有行的集合
UsedRange	Range	该工作表的使用范围
Visible	Boolean	该工作表是否可见
Type	String	该工作表的类型
Hyperlinks	Hyperlinks	该工作表上所有超链接的集合
Shapes	Shapes	该工作表上所有图形的集合
Sort	Sort	该工作表上排序对象

方法返回类型简介

Range()	Range	一个单元格或单元格区域
Cells()	Range	该工作表上的某个单元格
Activate()	undefined	切换(激活)工作表
Move()	undefined	移动工作表
Delete()	undefined	删除工作表

区域(Range)

属性数据类型简介

Count	Number	区域中单元格的数量
Text	String	【只读】读取单元格格式化文本
Value/Value2	any/[][]any	读写单元格中的值
FormatConditions	FormatConditions	用于控制 Excel 中的条件格式
Formula	String	以 A1 样式表示法表示的对象的隐式交叉的公式
FormulaArray	String	返回或设置区域的数组公式
NumberFormat	String	获取或者设置区域的数字格式
Hidden	Boolean	行或者列的隐藏
Interior.Color	String	内部颜色的十六进制 RGB
HorizontalAlignment	Enum.XlHAlign	设置区域的水平对齐方式
VerticalAlignment	Enum.XlVAlign	设置区域的垂直对齐方式
WrapText	Boolean	获取或者设置区域自动换行
IndentLevel	Number	单元格缩进
MergeArea	Range	单元格的合并区域
MergeCells	Boolean	区域内是否存在合并的单元格
Cells	Range	区域中的单元格集合
Rows	Range	区域中的行集合
Columns	Range	区域中的列集合
EntireRow	Range	区域所在行的整行
EntireColumn	Range	区域所在列的整列
Row	Number	区域中第一行的行号
RowEnd	Number	区域中最后一行的行号
Column	Number	区域中第一列的列号
ColumnEnd	Number	区域中最后一列的列号
Borders	Borders	边框集合对象

方法返回类型简介

BorderAround()	undefined	向区域添加边框，并为新边框设置 Border 对象的 Color、LineStyle 和 Weight 属性
Each()	undefined	遍历选区所选单元格
Item()	Range	表示区域中指定的位置
Offset()	undefined	对指定区域进行迁移操作
Replace()	undefined	对单元格内文本执行替换操作
Delete()	undefined	单元格、行、列的删除
Insert()	undefined	单元格、行、列的新增
InsertImage()	undefined	插入单元格图片
Merge()	undefined	合并单元格
UnMerge()	undefined	取消合并单元格
Address()	String	获取表示使用宏语言的区域引用的 String 值
AddComment()	undefined	添加评论
ClearComments()	undefined	清除区域的评论
Clear()	undefined	清空指定区域数据和样式
ClearContents()	undefined	清除区域的内容
ClearFormats()	undefined	清除区域的样式
ClearHyperlinks()	undefined	清除区域的超链接样式
Contain()	Boolean	判断区域是否重叠
Copy()	Boolean	将当前区域对象复制到剪贴板
Cut()	Boolean	将当前区域对象粘贴到目标区域
PasteSpecial()	undefined	将剪贴板中的内容粘贴到指定的单元格或范围
FillLeft()	undefined	对指定区域中的单元格执行从右往左填充
FillRight()	undefined	对指定区域中的单元格执行从左往右填充
FillDown()	undefined	对指定区域中的单元格执行从上往下填充
FillUp()	undefined	对指定区域中的单元格执行从下往上填充
AutoFill()	undefined	对指定区域中的单元格执行自动填充
AutoFilter()	undefined	对指定区域中的单元格执行自动筛选
AutoFit()	undefined	更改区域中的列宽或行高以达到最佳匹配
Select()	undefined	选择区域
TextToColumns()	undefined	将包含文本的一列单元格分解为若干列

筛选(AutoFilter)

属性数据类型简介

Filters	Filters	筛选对象集合
Range	Range	筛选区域

方法返回类型简介

ApplyFilter()	undefined	应用筛选到当前工作表
ShowAllData()	undefined	清除所有筛选条件，显示所有数据

排序(Sort)

属性数据类型简介

Header	XlYesNoGuess	指定第一行是否包含标题信息
MatchCase	Boolean	是否区分大小写
Orientation	XlSortOrientation	指定排序方向
Rng	Range	返回要执行排序的值的区域
SortFields	SortFields	该对象代表与 **Sort** 对象关联的排序字段的集合
SortMethod	XlSortMethod	中文排序方法

方法返回类型简介

Apply()	undefined	根据当前应用的排序状态对区域进行排序
SetRange()	undefined	设置排序发生的范围

排序字段(SortField)

代表与 **Sort** 对象关联的排序字段对象

属性数据类型简介

CustomOrder	Variant	指定对字段进行排序的自定义次序
DataOption	XlSortDataOption	指定如何在 SortField 对象中指定的区域中对文本进行排序
Key	Range	指定排序字段，该字段确定要排序的值
Order	XlSortOrder	确定关键字所指定的值的排序次序
Priority	Number	指定排序字段的优先级
SortOn	XlSortOn	返回或设置要排序的单元格的属性
SortOnValue	Object	返回针对指定的 SortField 对象执行排序的值

方法返回类型简介

Delete()	undefined	从 SortFields 集合中删除指定的 SortField 对象
ModifyKey()	undefined	修改字段中按其排序的键值

字体(Font)

单元格内字体的属性，包括加粗，颜色，大小，斜体，删除线和下划线。

属性数据类型简介

Bold	Boolean	字体是否加粗
Color	String	字体的颜色
Italic	Boolean	字体是否斜体
Name	String	字体的名称
Size	Number	字体的大小
Strikethrough	Boolean	字体是否有删除线
Underline	Enum.XlUnderlineStyle	字体是否有下划线

边框(Border)

边框对象，Borders 集合里的某一边框

属性数据类型简介

Color	Number	边框的颜色
Weight	Enum.XlBorderWeight	边框的粗细
LineStyle	Enum.XlLineStyle	边框的线条样式

图形(Shape)

某个工作表上的单个 Shape 图形对象

属性数据类型简介

ID	String	图形 ID
Name	String	图形名称
Title	String	图形标题
Chart	Chart	图表对象

方法返回类型简介

Delete

undefined

删除Shape

图表(Chart)

单个图表对象

属性数据类型简介

ChartTitle.Text	String	图表标题
HasTitle	Boolean	图表标题是否可见

方法返回类型简介

SetSourceData()

undefined

为图表设置源数据区域

超链接(Hyperlink)

单个超链接对象，有转跳地址和显示文本两个属性，两者可以不相等。

属性数据类型简介

Address	String	超链接转跳的地址
TextToDisplay	String	超链接显示的文本

条件格式集合(FormatConditions)

FormatConditions 集合对象用于控制 Excel 中的条件格式。

属性数据类型简介

Count

Number

返回 FormatConditions 集合中的对象数

方法返回类型简介

Add()	FormatCondition	向 FormatConditions 集合中添加一个条件格式
AddAboveAverage()	AboveAverage	返回表示指定区域的条件格式规则的新 AboveAverage 对象
AddIconSetCondition()	IconSetCondition	代表指定区域的图标集条件格式规则
AddColorScale()	ColorScale	该条件格式规则使用单元格颜色中的渐变来指示所选区域中包含的单元格值的相对差异
AddTop10()	Top10	该条件格式可以根据指定的截止值查找单元格区域中的最高值和最低值
AddUniqueValues()	UniqueValues	返回表示指定区域的条件格式规则的新 UniqueValues 对象
Delete()	undefined	删除该区域下的条件格式
Item()	FormatCondition	从条件格式集合中返回一个条件格式对象

条件格式(FormatCondition)

区域内的某个条件格式

属性数据类型简介

AppliesTo	Range	应用格式规则的单元格区域
Borders	Border	返回一个 Borders 集合
Font	Font	返回一个 Font 对象
Formula1	String	返回与条件格式或者数据有效性相关联的值或表达式
Formula2	String	返回与条件格式或数据有效性验证第二部分相关联的值或表达式
Interior	Interior	表示指定对象的内部
NumberFormat	String	单元格的数字格式
Operator	XlFormatConditionOperator	条件格式的运算符
Priority	Number	返回或设置条件格式规则的优先级值
Type	XlFormatConditionType	条件格式对象类型

方法返回类型简介

Modify()	undefined	更改现有条件格式
ModifyAppliesToRange()	undefined	设置此格式规则所应用于的单元格区域
SetFirstPriority()	undefined	将此条件格式规则的优先级值设置为“1”
SetLastPriority()	undefined	将此条件格式规则的优先级值增加“1”

数据有效性规则(Validation)

代表工作表区域的数据有效性规则

方法返回类型简介

Add()	undefined	新增数据有效性规则
Modify()	undefined	修改数据有效性规则
Delete()	undefined	删除数据有效性规则

工作表函数(WorksheetFunction)

工作表函数对象是 Excel 中的一个内置对象，它包含了许多常用的 Excel 函数，例如 Sum、Average、Min、Max 等。使用 WorksheetFunction 对象可以在 VBA 中调用这些 Excel 函数，以实现对工作表数据的处理和分析。

方法返回类型简介

Average()	Number	用于计算指定区域内数字的平均值
AverageIf()	Number	用于计算指定区域内满足给定条件的所有单元格的平均值
Small()	Number	返回数据集中第 k 个最小值
Large()	Number	用于在一个数组或一列数据中返回第 k 个最大值
Min()	Number	用于在一个数组或一列数据中返回最小值
Max()	Number	用于在一个数组或一列数据中返回最大值
Sum()	Number	对某单元格区域中的所有数字求和

枚举(Enum)

枚举类型，存放在 Application 下