Api

Spreadsheet API 的主类。用于获取活动工作簿、工作表、区域和当前选区，以及添加工作表、定义名称和自定义函数。

属性

名称	类型	描述
ActiveSheet	ApiWorksheet	返回表示活动工作表的对象。
AllComments	ApiComment[]	返回当前工作簿中的所有批注，包括所有工作表中的批注。
Comments	ApiComment[]	返回与整个工作簿相关的所有批注。
FreezePanes	FreezePaneType	返回或设置冻结窗格的类型。
PivotTables	ApiPivotTable[]	返回所有数据透视表。
ReferenceStyle	ReferenceStyle	返回或设置引用样式。
Selection	ApiRange	返回表示所选范围的对象。
Sheets	ApiWorksheet[]	返回表示活动工作簿中所有工作表的 Sheets 集合。
WorksheetFunction	ApiWorksheetFunction	返回表示函数列表的对象。

方法

下表列出了可用的方法。

方法	返回值	描述
AddComment	ApiComment | null	返回 ApiComment 对象的数组。
AddCustomFunction	无	创建新的自定义函数。
AddCustomFunctionLibrary	无	注册新的自定义函数库（参见 SetCustomFunctions 插件方法）。
AddDefName	boolean	向单元格范围添加新名称。
AddSheet	ApiWorksheet	创建新工作表。
CentimetersToPoints	number	将厘米转换为磅。
ClearCustomFunctions	boolean	清除所有自定义函数。
Color	ApiColor	从通用输入创建 ApiColor。
CreateBlipFill	ApiFill	创建图片填充，使用所选图像作为对象背景应用于对象。
CreateBullet	ApiBullet	使用 sSymbol 参数指定的字符或符号为段落创建项目符号。
CreateColorByName	ApiColor	从可用的颜色预设中选择创建颜色。
CreateColorFromRGB	ApiColor	通过设置红、绿、蓝颜色分量的适当值来创建 RGB 颜色。
CreateCustomGeometry	ApiGeometry	创建新的自定义几何图形。
CreateGradientStop	ApiGradientStop	创建用于不同类型渐变的渐变光圈。
CreateLinearGradientFill	ApiFill	创建线性渐变填充，使用所选线性渐变作为对象背景应用于对象。
CreateNewHistoryPoint	boolean	创建新的历史记录点。
CreateNoFill	ApiFill	创建无填充并移除元素的填充。
CreateNumbering	ApiBullet	使用 numType 参数指定的编号字符或符号为段落创建项目符号。
CreateParagraph	ApiParagraph	创建新段落。
CreatePatternFill	ApiFill	创建图案填充，使用所选图案作为对象背景应用于对象。
CreatePresetColor	ApiPresetColor	从可用的颜色预设中选择创建颜色。
CreatePresetGeometry	ApiGeometry | null	使用可用的预设形状之一创建几何图形。
CreateRGBColor	ApiRGBColor	通过设置红、绿、蓝颜色分量的适当值来创建 RGB 颜色。
CreateRadialGradientFill	ApiFill	创建径向渐变填充，使用所选径向渐变作为对象背景应用于对象。
CreateRun	ApiRun	创建要插入到当前段落或表格中的新的较小文本块。
CreateSchemeColor	ApiSchemeColor	从可用的配色方案中选择创建复杂配色方案。
CreateSolidFill	ApiFill	创建纯色填充，使用所选纯色作为对象背景应用于对象。
CreateStroke	ApiStroke	创建为元素添加阴影的笔触。
CreateTextPr	ApiTextPr	创建空的文本属性。
EmusToMillimeters	mm	将英制度量单位 (EMU) 转换为毫米。
EmusToPoints	number	将 EMU（英制度量单位）转换为磅。
Format	string	返回根据格式表达式中包含的指令格式化的类。
GetActiveSheet	ApiWorksheet	返回表示活动工作表的对象。
GetActiveWorkbook	ApiWorkbook	返回表示活动工作簿的对象。
GetAllComments	ApiComment[]	返回当前工作簿中的所有批注，包括所有工作表中的批注。
GetAllPivotTables	ApiPivotTable[]	返回所有数据透视表。
GetCommentById	ApiComment	通过 ID 从当前文档返回批注。
GetComments	ApiComment[]	返回与整个工作簿相关的所有批注。
GetCore	ApiCore	返回工作簿的核心属性接口。
GetCustomProperties	ApiCustomProperties	返回工作簿的自定义属性。
GetDefName	ApiName	根据范围名称返回 ApiName 对象。
GetDefNames	ApiName[]	返回工作簿中定义的所有 ApiName 对象的数组，涵盖所有作用域（工作簿级和工作表级）。
GetDocumentInfo	object	返回文档信息：
GetFreezePanesType	FreezePaneType	返回冻结窗格类型。
GetFullName	string	返回当前打开文件的完整名称。
GetLocale	number	返回当前区域设置 ID。
GetMailMergeData	string[][]	返回邮件合并数据。
GetPivotByName	ApiPivotTable | null	根据名称返回数据透视表，如果不存在则返回 null。
GetRange	ApiRange	根据范围引用返回 ApiRange 对象。
GetReferenceStyle	ReferenceStyle	返回单元格引用样式。
GetSelection	ApiRange	返回表示所选范围的对象。
GetSheet	ApiWorksheet | null	返回表示工作表的对象。
GetSheets	ApiWorksheet[]	返回表示活动工作簿中所有工作表的工作表集合。
GetThemesColors	string[]	返回电子表格所有可用主题颜色的列表。
GetWorksheetFunction	ApiWorksheetFunction	返回 ApiWorksheetFunction 对象。
HexColor	ApiColor	从十六进制字符串创建颜色。
InchesToPoints	number	将英寸转换为磅。
InsertPivotExistingWorksheet	ApiPivotTable	将指定的数据透视表插入到现有工作表中。
InsertPivotNewWorksheet	ApiPivotTable	将指定的数据透视表插入到新工作表中。
Intersect	ApiRange | null	返回表示两个或多个范围的矩形交集的 ApiRange 对象。
LinesToPoints	number	将行转换为磅（1 行 = 12 磅）。
MillimetersToEmus	EMU	将毫米转换为英制度量单位 (EMU)。
MillimetersToPixels	number	将毫米转换为像素。
MillimetersToPoints	number	将毫米转换为磅。
PicasToPoints	number	将派卡转换为磅。
PixelsToEmus	number	将像素转换为 EMU（英制度量单位）。
PixelsToPoints	number	将像素转换为磅。
PointsToCentimeters	number	将磅转换为厘米。
PointsToEmus	number	将磅转换为 EMU（英制度量单位）。
PointsToInches	number	将磅转换为英寸。
PointsToLines	number	将磅转换为行（1 行 = 12 磅）。
PointsToMillimeters	number	将磅转换为毫米。
PointsToPicas	number	将磅转换为派卡（1 派卡 = 12 磅）。
PointsToPixels	number	将磅转换为像素。
PointsToTwips	number	将磅转换为缇。
RGB	ApiColor	从红、绿、蓝分量创建 RGB 颜色。
RGBA	ApiColor	从红、绿、蓝和透明度分量创建 RGBA 颜色。
RecalculateAllFormulas	boolean	重新计算活动工作簿中的所有公式。
RefreshAllPivots	无	刷新所有数据透视表。
RemoveCustomFunction	boolean	删除自定义函数。
ReplaceTextSmart	boolean	用字符串数组中的相应文本替换选区中的每个段落（或单元格中的文本）。
Save	boolean	保存对指定文档的更改。
SetFreezePanesType	无	设置冻结窗格的类型。
SetLocale	boolean	设置文档的区域设置。
SetReferenceStyle	无	设置单元格引用样式。
SetThemeColors	boolean	设置当前电子表格的主题颜色。
ThemeColor	ApiColor	创建主题颜色。
TwipsToPoints	number	将缇转换为磅。
attachEvent	无	订阅指定事件，并在事件触发时调用回调函数。
detachEvent	无	取消订阅指定事件。