Excel.Interfaces.WorksheetData interface

描述通过调用 "toJSON ()" 返回的数据的接口。An interface describing the data returned by calling "worksheet.toJSON()".

属性

autoFilter

表示工作表的 AutoFilter 对象。Represents the AutoFilter object of the worksheet. 只读。Read-Only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

charts

返回属于工作表的图表的集合。Returns collection of charts that are part of the worksheet. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

comments

返回工作表上的所有 Comments 对象的集合。Returns a collection of all the Comments objects on the worksheet. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

enableCalculation

获取或设置工作表的 enableCalculation 属性。Gets or sets the enableCalculation property of the worksheet. 如此如果 Excel 根据需要重新计算工作表。True if Excel recalculates the worksheet when necessary. 如果 Excel 不重新计算工作表,则该值为 False。False if Excel doesn't recalculate the sheet.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

horizontalPageBreaks

获取工作表的水平分页符集合。Gets the horizontal page break collection for the worksheet. 此集合仅包含手动分页符。This collection only contains manual page breaks.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

id

返回用于唯一标识指定工作簿中工作表的值。即使工作表被重命名或移动,标识符的值仍然相同。只读。Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

name

工作表的显示名称。The display name of the worksheet.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

names

一组范围限定到当前工作表的名称。Collection of names scoped to the current worksheet. 只读。Read-only.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

pageLayout

获取工作表的 PageLayout 对象。Gets the PageLayout object of the worksheet.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

pivotTables

一组属于 worksheet 的 PivotTable 对象。Collection of PivotTables that are part of the worksheet. 只读。Read-only.

[API 集: ExcelApi 1.3][ API set: ExcelApi 1.3 ]

position

工作表在工作簿中的位置,从零开始。The zero-based position of the worksheet within the workbook.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

protection

返回表工作表的工作表保护对象。Returns sheet protection object for a worksheet. 只读。Read-only.

[API 集: ExcelApi 1.2][ API set: ExcelApi 1.2 ]

shapes

返回工作表上的所有 Shape 对象的集合。Returns the collection of all the Shape objects on the worksheet. 只读。Read-only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

showGridlines

获取或设置工作表的网格线标志。Gets or sets the worksheet's gridlines flag. 此标志确定是否对用户显示网格线。This flag determines whether gridlines are visible to the user.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

showHeadings

获取或设置工作表的标题标志。Gets or sets the worksheet's headings flag. 此标志确定是否对用户显示标题。This flag determines whether headings are visible to the user.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

slicers

返回作为工作表一部分的切片器集合。Returns collection of slicers that are part of the worksheet. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

standardHeight

返回工作表中所有行的标准(默认)行高,以磅为单位。Returns the standard (default) height of all the rows in the worksheet, in points. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

standardWidth

返回或设置工作表中所有列的标准(默认)列宽。Returns or sets the standard (default) width of all the columns in the worksheet. 一个列宽单位等于“常规”样式中一个字符的宽度。One unit of column width is equal to the width of one character in the Normal style. 对于比例字体,则使用字符 0(零)的宽度。For proportional fonts, the width of the character 0 (zero) is used.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

tabColor

获取或设置工作表标签颜色。Gets or sets the worksheet tab color. 检索选项卡颜色时, 如果工作表不可见, 则值将为 null。When retrieving the tab color, if the worksheet is invisible, the value will be null. 如果工作表可见但选项卡颜色设置为自动, 将返回一个空字符串。If the worksheet is visible but the tab color is set to auto, an empty string will be returned. 否则, 在设置颜色时, 属性将设置为颜色, 格式为#"123456", 则使用空字符串设置 "自动" 颜色, 或使用实际颜色。Otherwise, the property will be set to a color, in the form "#123456" When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

tables

属于工作表的表的集合。Collection of tables that are part of the worksheet. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

verticalPageBreaks

获取工作表的垂直分页符集合。Gets the vertical page break collection for the worksheet. 此集合仅包含手动分页符。This collection only contains manual page breaks.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

visibility

工作表的可见性。The Visibility of the worksheet.

[API 集: ExcelApi 1.1 用于读取可见性; 1.2 用于设置。[ API set: ExcelApi 1.1 for reading visibility; 1.2 for setting it. ]

属性详细信息

autoFilter

表示工作表的 AutoFilter 对象。Represents the AutoFilter object of the worksheet. 只读。Read-Only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

autoFilter?: Excel.Interfaces.AutoFilterData;

属性值

charts

返回属于工作表的图表的集合。Returns collection of charts that are part of the worksheet. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

charts?: Excel.Interfaces.ChartData[];

属性值

Excel.Interfaces.ChartData[]

comments

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回工作表上的所有 Comments 对象的集合。Returns a collection of all the Comments objects on the worksheet. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

comments?: Excel.Interfaces.CommentData[];

属性值

Excel.Interfaces.CommentData[]

enableCalculation

获取或设置工作表的 enableCalculation 属性。Gets or sets the enableCalculation property of the worksheet. 如此如果 Excel 根据需要重新计算工作表。True if Excel recalculates the worksheet when necessary. 如果 Excel 不重新计算工作表,则该值为 False。False if Excel doesn't recalculate the sheet.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

enableCalculation?: boolean;

属性值

boolean

horizontalPageBreaks

获取工作表的水平分页符集合。Gets the horizontal page break collection for the worksheet. 此集合仅包含手动分页符。This collection only contains manual page breaks.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];

属性值

Excel.Interfaces.PageBreakData[]

id

返回用于唯一标识指定工作簿中工作表的值。即使工作表被重命名或移动,标识符的值仍然相同。只读。Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

id?: string;

属性值

string

name

工作表的显示名称。The display name of the worksheet.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

name?: string;

属性值

string

names

一组范围限定到当前工作表的名称。Collection of names scoped to the current worksheet. 只读。Read-only.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

names?: Excel.Interfaces.NamedItemData[];

属性值

Excel.Interfaces.NamedItemData[]

pageLayout

获取工作表的 PageLayout 对象。Gets the PageLayout object of the worksheet.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

pageLayout?: Excel.Interfaces.PageLayoutData;

属性值

pivotTables

一组属于 worksheet 的 PivotTable 对象。Collection of PivotTables that are part of the worksheet. 只读。Read-only.

[API 集: ExcelApi 1.3][ API set: ExcelApi 1.3 ]

pivotTables?: Excel.Interfaces.PivotTableData[];

属性值

Excel.Interfaces.PivotTableData[]

position

工作表在工作簿中的位置,从零开始。The zero-based position of the worksheet within the workbook.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

position?: number;

属性值

number

protection

返回表工作表的工作表保护对象。Returns sheet protection object for a worksheet. 只读。Read-only.

[API 集: ExcelApi 1.2][ API set: ExcelApi 1.2 ]

protection?: Excel.Interfaces.WorksheetProtectionData;

属性值

shapes

返回工作表上的所有 Shape 对象的集合。Returns the collection of all the Shape objects on the worksheet. 只读。Read-only.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

shapes?: Excel.Interfaces.ShapeData[];

属性值

Excel.Interfaces.ShapeData[]

showGridlines

获取或设置工作表的网格线标志。Gets or sets the worksheet's gridlines flag. 此标志确定是否对用户显示网格线。This flag determines whether gridlines are visible to the user.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

showGridlines?: boolean;

属性值

boolean

showHeadings

获取或设置工作表的标题标志。Gets or sets the worksheet's headings flag. 此标志确定是否对用户显示标题。This flag determines whether headings are visible to the user.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

showHeadings?: boolean;

属性值

boolean

slicers

备注

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回作为工作表一部分的切片器集合。Returns collection of slicers that are part of the worksheet. 只读。Read-only.

[API 集: EXCELAPI BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

slicers?: Excel.Interfaces.SlicerData[];

属性值

Excel.Interfaces.SlicerData[]

standardHeight

返回工作表中所有行的标准(默认)行高,以磅为单位。Returns the standard (default) height of all the rows in the worksheet, in points. 只读。Read-only.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

standardHeight?: number;

属性值

number

standardWidth

返回或设置工作表中所有列的标准(默认)列宽。Returns or sets the standard (default) width of all the columns in the worksheet. 一个列宽单位等于“常规”样式中一个字符的宽度。One unit of column width is equal to the width of one character in the Normal style. 对于比例字体,则使用字符 0(零)的宽度。For proportional fonts, the width of the character 0 (zero) is used.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

standardWidth?: number;

属性值

number

tabColor

获取或设置工作表标签颜色。Gets or sets the worksheet tab color. 检索选项卡颜色时, 如果工作表不可见, 则值将为 null。When retrieving the tab color, if the worksheet is invisible, the value will be null. 如果工作表可见但选项卡颜色设置为自动, 将返回一个空字符串。If the worksheet is visible but the tab color is set to auto, an empty string will be returned. 否则, 在设置颜色时, 属性将设置为颜色, 格式为#"123456", 则使用空字符串设置 "自动" 颜色, 或使用实际颜色。Otherwise, the property will be set to a color, in the form "#123456" When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.

[API 集: ExcelApi 1.7][ API set: ExcelApi 1.7 ]

tabColor?: string;

属性值

string

tables

属于工作表的表的集合。Collection of tables that are part of the worksheet. 只读。Read-only.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

tables?: Excel.Interfaces.TableData[];

属性值

Excel.Interfaces.TableData[]

verticalPageBreaks

获取工作表的垂直分页符集合。Gets the vertical page break collection for the worksheet. 此集合仅包含手动分页符。This collection only contains manual page breaks.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

verticalPageBreaks?: Excel.Interfaces.PageBreakData[];

属性值

Excel.Interfaces.PageBreakData[]

visibility

工作表的可见性。The Visibility of the worksheet.

[API 集: ExcelApi 1.1 用于读取可见性; 1.2 用于设置。[ API set: ExcelApi 1.1 for reading visibility; 1.2 for setting it. ]

visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

属性值

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"