Excel JavaScript API 1.9 中的新增功能
超过 500 个新 Excel API 随 1.9 要求集一起推出。 第一个表提供了 API 的简明摘要,而后续表提供了详细列表。
功能区域 | 说明 | 相关对象 |
---|---|---|
Shape | 插入、定位和格式化图像、几何形状和文本框。 | ShapeCollectionShapeGeometricShape图像 |
自动筛选 | 为区域添加筛选器。 | AutoFilter |
Areas | 支持非连续区域。 | RangeAreas |
特殊单元格 | 获取在区域内包含日期、备注或公式的单元格。 | Range |
查找 | 查找区域或工作表中的值或公式。 | RangeWorksheet |
复制和粘贴 | 将值、格式和公式从一个区域复制到另一个区域。 | Range |
Calculation | 更好地控制 Excel 计算引擎。 | 应用程序 |
新图表 | 了解我们支持的新图表类型:地图、箱形图、瀑布图、旭日图、排列图 和漏斗图。 | Chart |
RangeFormat | 新功能及区域格式。 | Range |
API 列表
下表列出了 Excel JavaScript API 要求集 1.9 中的 API。 若要查看 Excel JavaScript API 要求集 1.9 或更低版本支持的所有 API 的 API 参考文档,请参阅 要求集 1.9 或更低版本中的 Excel API。
类 | 域 | 说明 |
---|---|---|
Application | calculationEngineVersion | 返回用于上次完整重新计算的 Excel 计算引擎版本。 |
calculationState | 返回应用程序的计算状态。 | |
iterativeCalculation | 返回迭代计算设置。 | |
suspendScreenUpdatingUntilNextSync() | 暂停屏幕更新,直到调用下一个 context.sync() 。 |
|
AutoFilter | 应用 (范围:范围 |string, columnIndex?: number, criteria?: Excel.FilterCriteria) | 将自动筛选器应用于区域。 |
clearCriteria() | 清除自动筛选的筛选条件和排序状态。 | |
criteria | 在自动筛选区域中保留所有筛选条件的数组。 | |
enabled | 指定是否启用自动筛选。 | |
getRange() | 返回对象, Range 该对象表示自动筛选应用到的范围。 |
|
getRangeOrNullObject() | 返回对象, Range 该对象表示自动筛选应用到的范围。 |
|
isDataFiltered | 指定自动筛选是否具有筛选条件。 | |
reapply() | 应用区域上当前指定的 AutoFilter 对象。 | |
remove() | 删除区域的自动筛选。 | |
CellBorder | color | 表示color 单个边框的属性。 |
style | 表示style 单个边框的属性。 |
|
tintAndShade | 表示tintAndShade 单个边框的属性。 |
|
weight | 表示weight 单个边框的属性。 |
|
CellBorderCollection | bottom | 表示format.borders.bottom 属性。 |
diagonalDown | 表示format.borders.diagonalDown 属性。 |
|
diagonalUp | 表示format.borders.diagonalUp 属性。 |
|
horizontal | 表示format.borders.horizontal 属性。 |
|
left | 表示format.borders.left 属性。 |
|
right | 表示format.borders.right 属性。 |
|
top | 表示format.borders.top 属性。 |
|
vertical | 表示format.borders.vertical 属性。 |
|
CellProperties | address | 表示address 属性。 |
addressLocal | 表示addressLocal 属性。 |
|
hidden | 表示hidden 属性。 |
|
CellPropertiesFill | color | 表示format.fill.color 属性。 |
pattern | 表示format.fill.pattern 属性。 |
|
patternColor | 表示format.fill.patternColor 属性。 |
|
patternTintAndShade | 表示format.fill.patternTintAndShade 属性。 |
|
tintAndShade | 表示format.fill.tintAndShade 属性。 |
|
CellPropertiesFont | bold | 表示format.font.bold 属性。 |
color | 表示format.font.color 属性。 |
|
italic | 表示format.font.italic 属性。 |
|
name | 表示format.font.name 属性。 |
|
size | 表示format.font.size 属性。 |
|
strikethrough | 表示format.font.strikethrough 属性。 |
|
subscript | 表示format.font.subscript 属性。 |
|
superscript | 表示format.font.superscript 属性。 |
|
tintAndShade | 表示format.font.tintAndShade 属性。 |
|
underline | 表示format.font.underline 属性。 |
|
CellPropertiesFormat | autoIndent | 表示autoIndent 属性。 |
Borders | 表示borders 属性。 |
|
fill | 表示fill 属性。 |
|
font | 表示font 属性。 |
|
horizontalAlignment | 表示horizontalAlignment 属性。 |
|
indentLevel | 表示indentLevel 属性。 |
|
protection | 表示protection 属性。 |
|
readingOrder | 表示readingOrder 属性。 |
|
shrinkToFit | 表示shrinkToFit 属性。 |
|
textOrientation | 表示textOrientation 属性。 |
|
useStandardHeight | 表示useStandardHeight 属性。 |
|
useStandardWidth | 表示useStandardWidth 属性。 |
|
verticalAlignment | 表示verticalAlignment 属性。 |
|
wrapText | 表示wrapText 属性。 |
|
CellPropertiesProtection | formulaHidden | 表示format.protection.formulaHidden 属性。 |
locked | 表示format.protection.locked 属性。 |
|
ChangedEventDetail | valueAfter | 表示更改后的值。 |
valueBefore | 表示更改前的值。 | |
valueTypeAfter | 表示更改后的值的类型。 | |
valueTypeBefore | 表示更改前的值的类型。 | |
Chart | activate() | 在 Excel UI 中激活图表。 |
pivotOptions | 封装数据透视图的选项。 | |
ChartAreaFormat | colorScheme | 指定图表的配色方案。 |
roundedCorners | 指定图表的图表区域是否具有圆角。 | |
ChartAxis | linkNumberFormat | 指定数字格式是否链接到单元格。 |
ChartBinOptions | allowOverflow | 指定是在直方图还是直方图中启用箱溢出。 |
allowUnderflow | 指定是在直方图还是直方图中启用 bin 下溢。 | |
count | 指定直方图或直方图的箱数。 | |
overflowValue | 指定直方图或直方图的箱溢出值。 | |
type | 指定直方图或直方图的箱类型。 | |
underflowValue | 指定直方图或直方图的箱下溢值。 | |
width | 指定直方图或直方图的箱宽度值。 | |
ChartBoxwhiskerOptions | quartileCalculation | 指定框和须须图的四分位计算类型。 |
showInnerPoints | 指定是否在框图和须形图中显示内部点。 | |
showMeanLine | 指定平均线是否显示在框图和须形图中。 | |
showMeanMarker | 指定平均标记是否显示在框图和须形图中。 | |
showOutlierPoints | 指定是否在框图和胡须图中显示离群点。 | |
ChartDataLabel | linkNumberFormat | 指定数字格式是否链接到单元格 (以便数字格式在单元格) 更改时标签中更改。 |
ChartDataLabels | linkNumberFormat | 指定数字格式是否链接到单元格。 |
ChartErrorBars | endStyleCap | 指定误差线是否具有结束样式上限。 |
format | 指定误差线的格式类型。 | |
include | 指定包含误差线的哪些部分。 | |
type | 误差线标记的区域类型。 | |
visible | 指定是否显示误差线。 | |
ChartErrorBarsFormat | line | 表示图表线条格式。 |
ChartMapOptions | labelStrategy | 指定区域地图图表的系列地图标签策略。 |
level | 指定区域地图图表的系列映射级别。 | |
projectionType | 指定区域地图图表的系列投影类型。 | |
ChartPivotOptions | showAxisFieldButtons | 指定是否在数据透视图上显示轴字段按钮。 |
showLegendFieldButtons | 指定是否在数据透视图上显示图例字段按钮。 | |
showReportFilterFieldButtons | 指定是否在数据透视图上显示报表筛选器字段按钮。 | |
showValueFieldButtons | 指定是否在数据透视图上显示“显示值字段”按钮。 | |
ChartSeries | binOptions | 封装直方图和排列图的容器选项。 |
boxwhiskerOptions | 封装箱形图的选项。 | |
bubbleScale | 这可以是从 0(零)到 300 的整数值,表示默认大小的百分比。 | |
gradientMaximumColor | 指定区域地图图表系列最大值的颜色。 | |
gradientMaximumType | 指定区域地图图表系列最大值的类型。 | |
gradientMaximumValue | 指定区域地图图表系列的最大值。 | |
gradientMidpointColor | 指定区域地图图表系列的中点值的颜色。 | |
gradientMidpointType | 指定区域地图图表系列的中点值的类型。 | |
gradientMidpointValue | 指定区域地图图表系列的中点值。 | |
gradientMinimumColor | 指定区域地图图表系列的最小值的颜色。 | |
gradientMinimumType | 指定区域地图图表系列的最小值的类型。 | |
gradientMinimumValue | 指定区域地图图表系列的最小值。 | |
gradientStyle | 指定区域地图图表的系列渐变样式。 | |
invertColor | 指定序列中负数据点的填充颜色。 | |
mapOptions | 封装区域地图图表的选项。 | |
parentLabelStrategy | 指定树状图的系列父标签策略区域。 | |
showConnectorLines | 指定是否在瀑布图中显示连接线。 | |
showLeaderLines | 指定是否为系列中的每个数据标签显示前导线。 | |
splitValue | 指定用于分隔饼图或饼条形图的两个部分的阈值。 | |
xErrorBars | 表示图表系列的误差线对象。 | |
yErrorBars | 表示图表系列的误差线对象。 | |
ChartTrendlineLabel | linkNumberFormat | 指定数字格式是否链接到单元格 (以便数字格式在单元格) 更改时标签中更改。 |
ColumnProperties | address | 表示address 属性。 |
addressLocal | 表示addressLocal 属性。 |
|
columnIndex | 表示columnIndex 属性。 |
|
ConditionalFormat | getRanges() | 返回 , RangeAreas 它包含一个或多个矩形区域,将应用 conditonal 格式。 |
DataValidation | getInvalidCells() | 返回一个 RangeAreas 对象,该对象包含一个或多个矩形区域,其单元格值无效。 |
getInvalidCellsOrNullObject() | 返回一个 RangeAreas 对象,该对象包含一个或多个矩形区域,其单元格值无效。 |
|
FilterCriteria | subField | 筛选器用于对富值执行丰富筛选的属性。 |
GeometricShape | id | 返回形状标识符。 |
shape | 返回 Shape 几何形状的 对象。 |
|
GroupShapeCollection | getCount() | 返回形状组中的形状数量。 |
getItem(key: string) | 使用形状的名称或 ID 获取形状。 | |
getItemAt(index: number) | 根据其在集合中的位置获取形状。 | |
items | 获取此集合中已加载的子项。 | |
HeaderFooter | centerFooter | 工作表的中心页脚。 |
centerHeader | 工作表的中心页眉。 | |
LeftFooter | 工作表的左脚。 | |
leftHeader | 工作表的左标题。 | |
rightFooter | 工作表的右页脚。 | |
rightHeader | 工作表的右标题。 | |
HeaderFooterGroup | defaultForAllPages | 常规页眉/页脚,除非指定偶数页/奇数页或首页,否则适用于所有页面, |
evenPages | 用于偶数页的页眉/页脚,需要为奇数页指定奇数页页眉/页脚。 | |
firstPage | 首页的页眉/页脚,为所有其他页使用常规或偶数页/奇数页页眉/页脚。 | |
oddPages | 用于奇数页的页眉/页脚,需要为偶数页指定偶数页页眉/页脚。 | |
state | 设置页眉/页脚的状态。 | |
useSheetMargins | 获取或设置一个标记,指示页眉/页脚是否与工作表的页面布局选项中设置的页边距对齐。 | |
useSheetScale | 获取或设置一个标记,指示是否应按照工作表的页面布局选项中设置的页面缩放百分比来缩放页眉/页脚。 | |
Image | format | 返回图像的格式。 |
id | 指定图像对象的形状标识符。 | |
shape | 返回与 Shape 图像关联的 对象。 |
|
IterativeCalculation | enabled | 如果 Excel 使用迭代来处理循环引用,则为 True。 |
maxChange | 指定 Excel 解析循环引用时每次迭代之间的最大更改量。 | |
maxIteration | 指定 Excel 可用于解析循环引用的最大迭代次数。 | |
Line | beginArrowheadLength | 表示指定线条始端的箭头长度。 |
beginArrowheadStyle | 表示指定线条始端的箭头样式。 | |
beginArrowheadWidth | 表示指定线条始端的箭头宽度。 | |
beginConnectedShape | 表示指定线条始端所附加到的形状。 | |
beginConnectedSite | 表示连接线始端所连接的连接站点。 | |
connectBeginShape(shape: Excel.Shape, connectionSite: number) | 将指定连接线的始端附加到指定形状。 | |
connectEndShape(shape: Excel.Shape, connectionSite: number) | 将指定连接线的末端附加到指定形状。 | |
connectorType | 表示线条的连接器类型。 | |
disconnectBeginShape() | 使指定连接线的始端与形状脱离。 | |
disconnectEndShape() | 使指定连接线的末端与形状脱离。 | |
endArrowheadLength | 表示指定线条末端的箭头长度。 | |
endArrowheadStyle | 表示指定线条末端的箭头样式。 | |
endArrowheadWidth | 表示指定线条末端的箭头宽度。 | |
endConnectedShape | 表示指定线条末端所附加到的形状。 | |
endConnectedSite | 表示连接线末端所连接的连接站点。 | |
id | 指定形状标识符。 | |
isBeginConnected | 指定指定线条的开头是否连接到形状。 | |
isEndConnected | 指定指定线条的末尾是否连接到形状。 | |
shape | 返回与 Shape 行关联的 对象。 |
|
PageBreak | columnIndex | 指定分页符的列索引。 |
delete() | 删除分页符对象。 | |
getCellAfterBreak() | 获取分页符后的第一个单元格。 | |
rowIndex | 指定分页符的行索引。 | |
PageBreakCollection | add (pageBreakRange: Range |字符串) | 在指定区域的左上角单元格之前添加分页符。 |
getCount() | 获取集合中的分页符数量。 | |
getItem(index: number) | 通过索引获取分页符对象。 | |
items | 获取此集合中已加载的子项。 | |
removePageBreaks() | 重置集合中的所有手动分页符。 | |
PageLayout | blackAndWhite | 工作表的黑白打印选项。 |
bottomMargin | 用于打印的工作表的下页边距(以磅为单位)。 | |
centerHorizontally | 工作表的中心水平标记。 | |
centerVertically | 工作表的中心垂直标志。 | |
draftMode | 工作表的草稿模式选项。 | |
firstPageNumber | 要打印的工作表的第一页码。 | |
footerMargin | 工作表的页脚边距(以磅为单位),以便在打印时使用。 | |
getPrintArea() |
RangeAreas 获取对象,该对象包含一个或多个矩形区域,该矩形区域表示工作表的打印区域。 |
|
getPrintAreaOrNullObject() |
RangeAreas 获取对象,该对象包含一个或多个矩形区域,该矩形区域表示工作表的打印区域。 |
|
getPrintTitleColumns() | 获取表示标题列的 Range 对象。 | |
getPrintTitleColumnsOrNullObject() | 获取表示标题列的 Range 对象。 | |
getPrintTitleRows() | 获取表示标题行的 Range 对象。 | |
getPrintTitleRowsOrNullObject() | 获取表示标题行的 Range 对象。 | |
headerMargin | 工作表的页眉边距(以磅为单位),以便在打印时使用。 | |
headersFooters | 工作表的页眉和页脚配置。 | |
leftMargin | 工作表的左边距(以磅为单位),以便在打印时使用。 | |
orientation | 工作表的页面方向。 | |
paperSize | 工作表的页面纸张大小。 | |
printComments | 指定打印时是否应显示工作表的批注。 | |
printErrors | 工作表的打印错误选项。 | |
printGridlines | 指定是否打印工作表的网格线。 | |
printHeadings | 指定是否打印工作表的标题。 | |
printOrder | 工作表的页面打印顺序选项。 | |
rightMargin | 工作表的右边距(以磅为单位),以便在打印时使用。 | |
setPrintArea (printArea:Range |RangeAreas |字符串) | 设置工作表的打印区域。 | |
setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions) | 设置带单位的工作表的页边距。 | |
setPrintTitleColumns (printTitleColumns: Range |字符串) | 设置列,这些列包含要在打印的工作表的每页左侧重复的单元格。 | |
setPrintTitleRows (printTitleRows:Range |字符串) | 设置行,这些行包含要在打印的工作表的每页顶部重复的单元格。 | |
topMargin | 工作表的上边距(以磅为单位),以便在打印时使用。 | |
zoom | 工作表的打印缩放选项。 | |
PageLayoutMarginOptions | bottom | 指定用于打印的单位中的页面布局下边距。 |
footer | 指定用于打印的单位中的页面布局页脚边距。 | |
header | 指定用于打印的单位中的页面布局页眉边距。 | |
left | 指定用于打印的单位中的页面布局左边距。 | |
right | 指定用于打印的单位中的页面布局右边距。 | |
top | 指定用于打印的单位中的页面布局上边距。 | |
PageLayoutZoomOptions | horizontalFitToPages | 水平放置的页数。 |
scale | 打印页面缩放值可以介于 10 至 400 之间。 | |
verticalFitToPages | 垂直放置的页数。 | |
PivotField | sortByValues (sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>) | 按给定范围中的指定值对 PivotField 进行排序。 |
PivotLayout | autoFormat | 指定在刷新时还是移动字段时自动设置格式设置格式。 |
getDataHierarchy (单元格: Range |字符串) | 获取 DataHierarchy,它用于计算数据透视表中指定区域内的值。 | |
getPivotItems (轴: Excel.PivotAxis, 单元格: Range |字符串) | 从构成数据透视表中指定区域内的值的轴获取 PivotItems。 | |
preserveFormatting | 指定在通过透视、排序或更改页字段项等操作刷新或重新计算报表时是否保留格式。 | |
setAutoSortOnCell (单元格:Range |string,sortBy:Excel.SortBy) | 将数据透视表设置为使用指定的单元格设置自动排序,以自动选择排序的所有条件和上下文。 | |
PivotTable | enableDataValueEditing | 指定数据透视表是否允许用户编辑数据正文中的值。 |
useCustomSortLists | 指定数据透视表在排序时是否使用自定义列表。 | |
区域 | autoFill (destinationRange?: Range |string, autoFillType?: Excel.AutoFillType) | 使用指定的自动填充逻辑填充从当前范围到目标范围的范围。 |
convertDataTypeToText() | 将数据类型为文本的区域单元格。 | |
convertToLinkedDataType(serviceID: number, languageCulture: string) | 在工作表中将区域单元格转换为链接数据类型。 | |
copyFrom (sourceRange: Range |RangeAreas |string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean) | 将单元格数据或格式从源区域或 RangeAreas 复制到当前区域。 |
|
find(text: string, criteria: Excel.SearchCriteria) | 根据指定的条件查找给定的字符串。 | |
findOrNullObject(text: string, criteria: Excel.SearchCriteria) | 根据指定的条件查找给定的字符串。 | |
flashFill() | 对当前范围执行快速填充。 | |
getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions) | 返回一个 2D 数组,其中封装了每个单元格的字体、填充、边框、对齐方式和其他属性数据。 | |
getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions) | 返回一个一维数组,其中封装了每个列的字体、填充、边框、对齐方式和其他属性数据。 | |
getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions) | 返回一个一维数组,其中封装了每个行的字体、填充、边框、对齐方式和其他属性数据。 | |
getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) |
RangeAreas 获取对象,该对象包含一个或多个矩形区域,该对象表示与指定类型和值匹配的所有单元格。 |
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) |
RangeAreas 获取由一个或多个区域组成的 对象,该对象表示与指定类型和值匹配的所有单元格。 |
|
getTables(fullyContained?: boolean) | 获取与区域重叠的限定范围的表格集合。 | |
linkedDataTypeState | 表示每个单元格的数据类型状态。 | |
removeDuplicates(columns: number[], includesHeader: boolean) | 从列指定的区域中删除重复值。 | |
replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria) | 根据当前区域内指定的条件查找并替换给定的字符串。 | |
setCellProperties(cellPropertiesData: SettableCellProperties[][]) | 基于单元格属性的 2D 数组汇报区域,封装字体、填充、边框和对齐等内容。 | |
setColumnProperties(columnPropertiesData: SettableColumnProperties[]) | 基于列属性的单维数组汇报范围,并封装字体、填充、边框和对齐方式等内容。 | |
setDirty() | 设置下一次重新计算发生时要重新计算的区域。 | |
setRowProperties(rowPropertiesData: SettableRowProperties[]) | 基于行属性的一维数组汇报区域,并封装字体、填充、边框和对齐方式等内容。 | |
RangeAreas | address | 返回 RangeAreas A1 样式的引用。 |
addressLocal | 返回 RangeAreas 用户区域设置中的引用。 |
|
areaCount | 返回构成此 RangeAreas 对象的矩形区域的数目。 |
|
areas | 返回构成此 RangeAreas 对象的矩形范围的集合。 |
|
calculate() | 计算 中的所有 RangeAreas 单元格。 |
|
cellCount | 返回 对象中的 RangeAreas 单元格数,并汇总所有单个矩形区域的单元格计数。 |
|
clear(applyTo?: Excel.ClearApplyTo) | 清除构成此 RangeAreas 对象的每个区域的值、格式、填充、边框和其他属性。 |
|
conditionalFormats | 返回与此 RangeAreas 对象中的任何单元格相交的条件格式的集合。 |
|
convertDataTypeToText() | 将 中 RangeAreas 具有数据类型的所有单元格转换为文本。 |
|
convertToLinkedDataType(serviceID: number, languageCulture: string) | 将 中的所有 RangeAreas 单元格转换为链接数据类型。 |
|
copyFrom (sourceRange: Range |RangeAreas |string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean) | 将单元格数据或格式从源区域 或 RangeAreas 复制到当前 RangeAreas 。 |
|
dataValidation | 返回 中所有范围 RangeAreas 的数据验证对象。 |
|
format | 返回一个 RangeFormat 对象,该对象封装对象中 RangeAreas 所有区域的字体、填充、边框、对齐方式和其他属性。 |
|
getEntireColumn() | 返回一个 RangeAreas 对象,该对象代表 (的 RangeAreas 整个列,例如,如果当前 RangeAreas 表示单元格“B4:E11, H2”,则返回一个 RangeAreas 表示列“B:E, H:H”) 。 |
|
getEntireRow() | 返回一个 RangeAreas 对象,该对象代表 (的整个行 RangeAreas ,例如,如果当前 RangeAreas 表示单元格“B4:E11”,则返回表示 RangeAreas 行“4:11”) 。 |
|
getIntersection (anotherRange: Range |RangeAreas |字符串) | 返回 RangeAreas 表示给定区域或 RangeAreas 的交集的对象。 |
|
getIntersectionOrNullObject (anotherRange: Range |RangeAreas |字符串) | 返回 RangeAreas 表示给定区域或 RangeAreas 的交集的对象。 |
|
getOffsetRangeAreas(rowOffset: number, columnOffset: number) | 返回由 RangeAreas 特定行和列偏移量移动的对象。 |
|
getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) | 返回一个 RangeAreas 对象,该对象表示与指定类型和值匹配的所有单元格。 |
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) | 返回一个 RangeAreas 对象,该对象表示与指定类型和值匹配的所有单元格。 |
|
getTables(fullyContained?: boolean) | 返回与此 RangeAreas 对象中的任何范围重叠的表的作用域集合。 |
|
getUsedRangeAreas(valuesOnly?: boolean) | 返回包含对象中RangeAreas 各个矩形区域的所有已用区域的使用的 RangeAreas 。 |
|
getUsedRangeAreasOrNullObject(valuesOnly?: boolean) | 返回包含对象中RangeAreas 各个矩形区域的所有已用区域的使用的 RangeAreas 。 |
|
isEntireColumn | 指定此 RangeAreas 对象上的所有区域是否表示整个列 (例如“A:C, Q:Z”) 。 |
|
isEntireRow | 指定此 RangeAreas 对象上的所有区域是否表示 (整行,例如“1:3, 5:7”) 。 |
|
setDirty() |
RangeAreas 设置在下一次重新计算时要重新计算的 。 |
|
style | 表示此 RangeAreas 对象中所有区域的样式。 |
|
worksheet | 返回当前 RangeAreas 的工作表。 |
|
RangeBorder | tintAndShade | 指定为范围边框的颜色变亮或变暗的双精度值,该值介于 -1 (最暗) 和 1 (最亮) 之间,原始颜色为 0。 |
RangeBorderCollection | tintAndShade | 指定一个使范围边框的颜色变浅或变暗的双精度值。 |
RangeCollection | getCount() | 返回 中的 RangeCollection 范围数。 |
getItemAt(index: number) | 根据范围对象在 中 RangeCollection 的位置返回范围对象。 |
|
items | 获取此集合中已加载的子项。 | |
RangeFill | pattern | 范围的模式。 |
patternColor | 表示范围图案颜色的 HTML 颜色代码,格式 #RRGGBB (例如“FFA500”) ,或作为命名的 HTML 颜色 (,例如“橙色”) 。 | |
patternTintAndShade | 指定一个使范围填充的图案颜色变亮或变暗的双精度值。 | |
tintAndShade | 指定一个使范围填充的颜色变浅或变暗的双精度值。 | |
RangeFont | strikethrough | 指定字体的删除线状态。 |
subscript | 指定字体的下标状态。 | |
superscript | 指定字体的上标状态。 | |
tintAndShade | 指定使范围字体的颜色变浅或变暗的双精度值。 | |
RangeFormat | autoIndent | 指定当文本对齐方式设置为相等分布时,是否自动缩进文本。 |
indentLevel | 0 到 250 之间的一个整数,指示缩进水平。 | |
readingOrder | 区域的读取顺序。 | |
shrinkToFit | 指定文本是否自动收缩以适应可用的列宽。 | |
RemoveDuplicatesResult | removed | 由操作删除的重复行数。 |
uniqueRemaining | 所生成的区域中存在的剩余唯一行数。 | |
ReplaceCriteria | completeMatch | 指定匹配是需要完整匹配还是部分匹配。 |
matchCase | 指定匹配项是否区分大小写。 | |
RowProperties | address | 表示address 属性。 |
addressLocal | 表示addressLocal 属性。 |
|
rowIndex | 表示rowIndex 属性。 |
|
SearchCriteria | completeMatch | 指定匹配是需要完整匹配还是部分匹配。 |
matchCase | 指定匹配项是否区分大小写。 | |
searchDirection | 指定搜索方向。 | |
SettableCellProperties | format | 表示format 属性。 |
hyperlink | 表示hyperlink 属性。 |
|
style | 表示style 属性。 |
|
SettableColumnProperties | columnHidden | 表示columnHidden 属性。 |
format | 表示format 属性。 |
|
SettableRowProperties | format | 表示format 属性。 |
rowHidden | 表示rowHidden 属性。 |
|
Shape | altTextDescription | 指定对象的可选说明文本 Shape 。 |
altTextTitle | 指定对象的可选标题文本 Shape 。 |
|
connectionSiteCount | 返回此形状上的连接站点数。 | |
delete() | 从工作表删除形状。 | |
fill | 返回此形状的填充格式。 | |
geometricShape | 返回与形状关联的几何形状。 | |
geometricShapeType | 指定此几何形状的几何形状类型。 | |
getAsImage(format: Excel.PictureFormat) | 将形状转换为图像,并将图像作为 Base64 编码的字符串返回。 | |
组 | 返回与形状关联的形状组。 | |
height | 指定形状的高度(以磅为单位)。 | |
id | 指定形状标识符。 | |
image | 返回与形状关联的图像。 | |
incrementLeft(increment: number) | 以指定磅数水平移动形状。 | |
incrementRotation(increment: number) | 将形状围绕 z 轴旋转特定度数。 | |
incrementTop(increment: number) | 以指定磅数垂直移动形状。 | |
left | 从形状左侧到工作表左侧的距离(以磅为单位)。 | |
level | 指定指定形状的级别。 | |
line | 返回与形状关联的线条。 | |
lineFormat | 返回此形状的线条格式。 | |
lockAspectRatio | 指定是否锁定此形状的纵横比。 | |
名称 | 指定形状的名称。 | |
onActivated | 当激活形状时发生此事件。 | |
onDeactivated | 当停用形状时发生此事件。 | |
parentGroup | 指定此形状的父组。 | |
rotation | 指定形状的旋转(以度为单位)。 | |
scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom) | 按指定因子缩放形状的高度。 | |
scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom) | 按指定因子缩放形状的宽度。 | |
setZOrder(position: Excel.ShapeZOrder) | 将指定形状沿集合的 z 顺序向上或向下移动,将其移动到其他形状的前面或后面。 | |
textFrame | 返回此形状的文本框对象。 | |
top | 从形状上边缘到工作表上边缘之间的距离(以磅为单位)。 | |
type | 返回此形状的类型。 | |
visible | 指定形状是否可见。 | |
width | 指定形状的宽度(以磅为单位)。 | |
zOrderPosition | 返回指定形状在 z 顺序中的位置,0 表示顺序堆栈的底部。 | |
ShapeActivatedEventArgs | shapeId | 获取已激活形状的 ID。 |
type | 获取事件的类型。 | |
worksheetId | 获取在其中激活形状的工作表的 ID。 | |
ShapeCollection | addGeometricShape(geometricShapeType: Excel.GeometricShapeType) | 将几何形状添加到工作表。 |
addGroup (值:数组<字符串 |形状>) | 在此集合的工作表中对形状的子集进行分组。 | |
addImage(base64ImageString: string) | 从 Base64 编码的字符串创建图像,并将其添加到工作表。 | |
addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType) | 将线条添加到工作表。 | |
addTextBox(text?: string) | 使用提供的文本作为内容,将文本框添加到工作表。 | |
getCount() | 返回工作表中的形状数。 | |
getItem(key: string) | 使用形状的名称或 ID 获取形状。 | |
getItemAt(index: number) | 使用其在集合中的位置获取形状。 | |
items | 获取此集合中已加载的子项。 | |
ShapeDeactivatedEventArgs | shapeId | 获取已停用的形状的 ID。 |
type | 获取事件的类型。 | |
worksheetId | 获取在其中停用形状的工作表的 ID。 | |
ShapeFill | clear() | 清除此形状的填充格式。 |
foregroundColor | 以 HTML 颜色格式表示形状填充前景色,在窗体 #RRGGBB (例如“FFA500”) 或作为命名的 HTML 颜色 (例如“橙色”) | |
setSolidColor(color: string) | 将形状的填充格式设置为统一颜色。 | |
transparency | 将填充的透明度百分比指定为从 0.0 (不透明) 到 1.0 (清除) 的值。 | |
type | 返回形状的填充类型。 | |
ShapeFont | bold | 表示字体的加粗状态。 |
color | 文本颜色 (的 HTML 颜色代码表示形式,例如,“#FF0000”表示红色) 。 | |
italic | 表示字体的斜体状态。 | |
名称 | 表示字体名称 (例如“Calibri”) 。 | |
size | 以磅为单位表示字号 (,例如 11) 。 | |
underline | 应用于字体的下划线类型。 | |
ShapeGroup | id | 指定形状标识符。 |
shape | 返回与 Shape 组关联的 对象。 |
|
shapes | 返回 对象的集合 Shape 。 |
|
ungroup() | 取消分组指定形状组中的任何已分组形状。 | |
ShapeLineFormat | color | 表示 HTML 颜色格式的线条颜色,格式 #RRGGBB (例如“FFA500”) 或命名的 HTML 颜色 (例如“orange”) 。 |
dashStyle | 表示形状的线条样式。 | |
style | 表示形状的线条样式。 | |
transparency | 将指定线条的透明度表示为从 0.0(不透明)到 1.0(清晰)的值。 | |
visible | 指定形状元素的线条格式是否可见。 | |
weight | 表示线条的粗细(以磅为单位)。 | |
SortField | subField | 指定要排序的富值的目标属性名称的子字段。 |
StyleCollection | getCount() | 获取集合中的样式数量。 |
getItemAt(index: number) | 根据其在集合中的位置获取样式。 | |
Table | autoFilter | 表示 AutoFilter 表的 对象。 |
TableAddedEventArgs | source | 获取事件源。 |
tableId | 获取所添加表的 ID。 | |
type | 获取事件的类型。 | |
worksheetId | 获取在其中添加表格的工作表的 ID。 | |
TableChangedEventArgs | details | 获取有关更改详细信息的信息。 |
TableCollection | onAdded | 在工作簿中添加新表时发生。 |
onDeleted | 在工作簿中删除指定的表格时发生。 | |
TableDeletedEventArgs | source | 获取事件源。 |
tableId | 获取已删除的表的 ID。 | |
tableName | 获取已删除的表的名称。 | |
type | 获取事件的类型。 | |
worksheetId | 获取在其中删除表格的工作表的 ID。 | |
TableScopedCollection | getCount() | 获取集合中的表数量。 |
getFirst() | 获取集合中的第一个表格。 | |
getItem(key: string) | 按名称或 ID 获取表。 | |
items | 获取此集合中已加载的子项。 | |
TextFrame | autoSizeSetting | 文本框的自动调整大小设置。 |
bottomMargin | 表示文本框的下边距(以磅为单位)。 | |
deleteText() | 删除文本框中的所有文本。 | |
hasText | 指定文本框是否包含文本。 | |
horizontalAlignment | 表示文本框的水平对齐方式。 | |
horizontalOverflow | 表示文本框的水平溢出行为。 | |
leftMargin | 表示文本框的左边距(以磅为单位)。 | |
orientation | 表示文本框架所指向的角度。 | |
readingOrder | 表示文本框从左到右或从右到左的读取顺序。 | |
rightMargin | 表示文本框的右边距(以磅为单位)。 | |
textRange | 表示附加到文本框中形状上的文本,以及用于操作文本的属性和方法。 | |
topMargin | 表示文本框的上边距(以磅为单位)。 | |
verticalAlignment | 表示文本框的垂直对齐方式。 | |
verticalOverflow | 表示文本框的垂直溢出行为。 | |
TextRange | font | 返回一个 ShapeFont 对象,该对象代表文本区域的字体属性。 |
getSubstring(start: number, length?: number) | 返回给定区域内子字符串的 TextRange 对象。 | |
text | 表示文本范围的纯文本内容。 | |
Workbook | autoSave | 指定工作簿是否处于自动保存模式。 |
calculationEngineVersion | 返回有关 Excel 计算引擎的版本号。 | |
chartDataPointTrack | 如果工作簿中的所有图表都跟踪它们所附加的实际数据点,则为 True。 | |
getActiveChart() | 获取工作簿中的当前活动图表。 | |
getActiveChartOrNullObject() | 获取工作簿中的当前活动图表。 | |
getIsActiveCollabSession() |
true 如果多个用户正在编辑工作簿, (通过共同创作) ,则返回 。 |
|
getSelectedRanges() | 从工作簿中获取当前选定的一个或多个区域。 | |
isDirty | 指定自上次保存工作簿以来是否进行了更改。 | |
onAutoSaveSettingChanged | 在工作簿上更改自动保存设置时发生。 | |
previouslySaved | 指定工作簿是在本地保存还是联机保存。 | |
usePrecisionAsDisplayed | 如果此工作簿中的计算仅使用显示的数字精度来完成,则为 True。 | |
WorkbookAutoSaveSettingChangedEventArgs | type | 获取事件的类型。 |
Worksheet | autoFilter | 表示 AutoFilter 工作表的 对象。 |
enableCalculation | 确定 Excel 是否应在必要时重新计算工作表。 | |
findAll(text: string, criteria: Excel.WorksheetSearchCriteria) | 根据指定的条件查找给定字符串的所有匹配项,并将其作为 RangeAreas 对象返回,包括一个或多个矩形区域。 |
|
findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria) | 根据指定的条件查找给定字符串的所有匹配项,并将其作为 RangeAreas 对象返回,包括一个或多个矩形区域。 |
|
getRanges(address?: string) |
RangeAreas 获取 对象,该对象表示由地址或名称指定的一个或多个矩形区域块。 |
|
horizontalPageBreaks | 获取工作表的水平分页符集合。 | |
onFormatChanged | 在特定工作表上更改格式时发生。 | |
pageLayout | 获取 PageLayout 工作表的 对象。 |
|
replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria) | 根据当前工作表中指定的条件查找并替换给定的字符串。 | |
shapes | 返回工作表上的所有 Shape 对象的集合。 | |
verticalPageBreaks | 获取工作表的垂直分页符集合。 | |
WorksheetChangedEventArgs | details | 表示有关更改详细信息的信息。 |
WorksheetCollection | onChanged | 在更改工作簿中的任何工作表时发生。 |
onFormatChanged | 当工作簿中的任何工作表的格式已更改时发生。 | |
onSelectionChanged | 在任何工作表上更改选择时发生。 | |
WorksheetFormatChangedEventArgs | address | 获取区域地址,该地址表示特定工作表上的更改区域。 |
getRange(ctx: Excel.RequestContext) | 获取区域,该区域表示特定工作表上的更改区域。 | |
getRangeOrNullObject(ctx: Excel.RequestContext) | 获取区域,该区域表示特定工作表上的更改区域。 | |
source | 获取事件源。 | |
type | 获取事件的类型。 | |
worksheetId | 获取数据更改的工作表的 ID。 | |
WorksheetSearchCriteria | completeMatch | 指定匹配是需要完整匹配还是部分匹配。 |
matchCase | 指定匹配项是否区分大小写。 |