Excel.Interfaces.WorksheetData interface

一个描述通过调用 worksheet.toJSON()返回的数据的接口。

注解

使用方

属性

autoFilter

表示 AutoFilter 工作表的对象。

charts

返回属于工作表一部分的图表集合。

comments

返回工作表上的所有 Comments 对象的集合。

customProperties

获取工作表级自定义属性的集合。

enableCalculation

确定 Excel 是否应在必要时重新计算工作表。 如果 Excel 在必要时重新计算工作表,则为 true。 如果 Excel 不重新计算工作表,则该值为 False。

horizontalPageBreaks

获取工作表的水平分页符集合。 此集合仅包含手动分页符。

id

返回用于唯一标识指定工作簿中工作表的值。 即使工作表被重命名或移动,标识符的值仍然相同。

name

工作表的显示名称。 名称必须少于 32 个字符。

names

一组范围限定到当前工作表的名称。

notes

返回工作表中所有备注对象的集合。

pageLayout

获取 PageLayout 工作表的对象。

pivotTables

一组属于工作表的数据透视表对象。

position

工作表在工作簿中的位置,从零开始。

protection

返回工作表的工作表保护对象。

shapes

返回工作表上的所有 Shape 对象的集合。

showDataTypeIcons

指定数据类型图标在工作表上是否可见。 默认情况下,数据类型图标可见。

showGridlines

指定网格线是否对用户可见。

showHeadings

指定标题是否对用户可见。

slicers

返回属于工作表的切片器集合。

standardHeight

返回工作表中所有行的标准(默认)行高,以磅为单位。

standardWidth

指定工作表中所有列的标准 (默认) 宽。 一个列宽单位等于“常规”样式中一个字符的宽度。 对于比例字体,则使用字符 0(零)的宽度。

tabColor

工作表的制表符颜色。 检索选项卡颜色时,如果工作表不可见,则该值将为 null。 如果工作表可见,但选项卡颜色设置为自动,则将返回一个空字符串。 否则,该属性将设置为颜色,形式 #RRGGBB (例如“FFA500”) 。 设置颜色时,请使用空字符串设置“自动”颜色,否则使用真实颜色。

tabId

返回可由 Open Office XML 读取的表示此工作表的值。 这是一个整数值,不同于 worksheet.id () worksheet.name 返回全局唯一标识符, (返回诸如 “Sheet1”) 之类的值。

tables

属于工作表的表的集合。

verticalPageBreaks

获取工作表的垂直分页符集合。 此集合仅包含手动分页符。

visibility

工作表的可见性。

属性详细信息

autoFilter

表示 AutoFilter 工作表的对象。

autoFilter?: Excel.Interfaces.AutoFilterData;

属性值

注解

API 集:ExcelApi 1.9

charts

返回属于工作表一部分的图表集合。

charts?: Excel.Interfaces.ChartData[];

属性值

注解

API 集:ExcelApi 1.1

comments

返回工作表上的所有 Comments 对象的集合。

comments?: Excel.Interfaces.CommentData[];

属性值

注解

API 集:ExcelApi 1.10

customProperties

获取工作表级自定义属性的集合。

customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];

属性值

注解

API 集:ExcelApi 1.12

enableCalculation

确定 Excel 是否应在必要时重新计算工作表。 如果 Excel 在必要时重新计算工作表,则为 true。 如果 Excel 不重新计算工作表,则该值为 False。

enableCalculation?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.9

horizontalPageBreaks

获取工作表的水平分页符集合。 此集合仅包含手动分页符。

horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];

属性值

注解

API 集:ExcelApi 1.9

id

返回用于唯一标识指定工作簿中工作表的值。 即使工作表被重命名或移动,标识符的值仍然相同。

id?: string;

属性值

string

注解

API 集:ExcelApi 1.1

name

工作表的显示名称。 名称必须少于 32 个字符。

name?: string;

属性值

string

注解

API 集:ExcelApi 1.1

names

一组范围限定到当前工作表的名称。

names?: Excel.Interfaces.NamedItemData[];

属性值

注解

API 集:ExcelApi 1.4

notes

返回工作表中所有备注对象的集合。

notes?: Excel.Interfaces.NoteData[];

属性值

注解

API 集:ExcelApi 1.18

pageLayout

获取 PageLayout 工作表的对象。

pageLayout?: Excel.Interfaces.PageLayoutData;

属性值

注解

API 集:ExcelApi 1.9

pivotTables

一组属于工作表的数据透视表对象。

pivotTables?: Excel.Interfaces.PivotTableData[];

属性值

注解

API 集:ExcelApi 1.3

position

工作表在工作簿中的位置,从零开始。

position?: number;

属性值

number

注解

API 集:ExcelApi 1.1

protection

返回工作表的工作表保护对象。

protection?: Excel.Interfaces.WorksheetProtectionData;

属性值

注解

API 集:ExcelApi 1.2

shapes

返回工作表上的所有 Shape 对象的集合。

shapes?: Excel.Interfaces.ShapeData[];

属性值

注解

API 集:ExcelApi 1.9

showDataTypeIcons

指定数据类型图标在工作表上是否可见。 默认情况下,数据类型图标可见。

showDataTypeIcons?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.19

showGridlines

指定网格线是否对用户可见。

showGridlines?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.8

showHeadings

指定标题是否对用户可见。

showHeadings?: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.8

slicers

返回属于工作表的切片器集合。

slicers?: Excel.Interfaces.SlicerData[];

属性值

注解

API 集:ExcelApi 1.10

standardHeight

返回工作表中所有行的标准(默认)行高,以磅为单位。

standardHeight?: number;

属性值

number

注解

API 集:ExcelApi 1.7

standardWidth

指定工作表中所有列的标准 (默认) 宽。 一个列宽单位等于“常规”样式中一个字符的宽度。 对于比例字体,则使用字符 0(零)的宽度。

standardWidth?: number;

属性值

number

注解

API 集:ExcelApi 1.7

tabColor

工作表的制表符颜色。 检索选项卡颜色时,如果工作表不可见,则该值将为 null。 如果工作表可见,但选项卡颜色设置为自动,则将返回一个空字符串。 否则,该属性将设置为颜色,形式 #RRGGBB (例如“FFA500”) 。 设置颜色时,请使用空字符串设置“自动”颜色,否则使用真实颜色。

tabColor?: string;

属性值

string

注解

API 集:ExcelApi 1.7

tabId

返回可由 Open Office XML 读取的表示此工作表的值。 这是一个整数值,不同于 worksheet.id () worksheet.name 返回全局唯一标识符, (返回诸如 “Sheet1”) 之类的值。

tabId?: number;

属性值

number

注解

API 集:ExcelApi 1.14

tables

属于工作表的表的集合。

tables?: Excel.Interfaces.TableData[];

属性值

注解

API 集:ExcelApi 1.1

verticalPageBreaks

获取工作表的垂直分页符集合。 此集合仅包含手动分页符。

verticalPageBreaks?: Excel.Interfaces.PageBreakData[];

属性值

注解

API 集:ExcelApi 1.9

visibility

工作表的可见性。

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

属性值

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

注解

API 集:用于读取可见性的 ExcelApi 1.1;1.2 进行设置。