Excel.Interfaces.WorksheetData interface

  • Ссылка
Пакет:
excel

Интерфейс, описывающий данные, возвращаемые путем вызова worksheet.toJSON().

Свойства

autoFilter

Представляет AutoFilter объект листа.
charts

Возвращает коллекцию диаграмм, которые являются частью листа.
comments

Возвращает коллекцию всех объектов Comments на листе.
customProperties

Возвращает коллекцию настраиваемых свойств на уровне листа.
enableCalculation

Определяет, следует ли excel пересчитывать лист при необходимости. Значение true, если Excel пересчитывает лист при необходимости. Значение false, если Excel не пересчитывает лист.
horizontalPageBreaks

Получает коллекцию горизонтальных разрывов страницы для листа. Эта коллекция содержит только добавленные вручную разрывы страниц.
id

Возвращает значение, однозначно идентифицирующее лист в данной книге. Значение идентификатора остается прежним, даже если переименовать или переместить лист.
name

Отображаемое имя листа. Имя должно содержать менее 32 символов.
names

Коллекция имен, относящих к текущему листу.
pageLayout

PageLayout Возвращает объект листа.
pivotTables

Коллекция сводных таблиц на листе.
position

Положение листа (начиная с нуля) в книге.
protection

Возвращает объект защиты листа для листа.
shapes

Возвращает коллекцию всех объектов Shape на листе.
showGridlines

Указывает, являются ли линии сетки видимыми для пользователя.
showHeadings

Указывает, являются ли заголовки видимыми для пользователя.
slicers

Возвращает коллекцию срезов, которые являются частью листа.
standardHeight

Возвращает стандартную (по умолчанию) высоту всех строк на листе (в пунктах).
standardWidth

Задает стандартную (по умолчанию) ширину всех столбцов на листе. Одна единица ширины столбца равна ширине одного символа в обычном стиле. Для пропорциональных шрифтов используется ширина символа 0 (ноль).
tabColor

Цвет вкладки листа. При получении цвета вкладки, если лист невидим, значение будет иметь значение null. Если лист виден, но для цвета вкладки задано значение auto, возвращается пустая строка. В противном случае свойству будет присвоен цвет в форме #RRGGBB (например, FFA500). При настройке цвета используйте пустую строку, чтобы задать "автоматический" цвет или реальный цвет в противном случае.
tabId

Возвращает значение, представляющее этот лист, который может быть прочитан с помощью Open Office XML. Это целочисленное значение, которое отличается от worksheet.id (возвращает глобальный уникальный идентификатор) и worksheet.name (которое возвращает такое значение, как "Лист1").
tables

Коллекция таблиц, имеющихся на листе.
verticalPageBreaks

Получает коллекцию вертикальных разрывов страницы для листа. Эта коллекция содержит только добавленные вручную разрывы страниц.
visibility

Видимость листа.

Сведения о свойстве

autoFilter

Представляет AutoFilter объект листа.

autoFilter?: Excel.Interfaces.AutoFilterData;

Значение свойства

Excel.Interfaces.AutoFilterData

Комментарии

[ Набор API: ExcelApi 1.9 ]

charts

Возвращает коллекцию диаграмм, которые являются частью листа.

charts?: Excel.Interfaces.ChartData[];

Значение свойства

Excel.Interfaces.ChartData[]

Комментарии

[ Набор API: ExcelApi 1.1 ]

comments

Возвращает коллекцию всех объектов Comments на листе.

comments?: Excel.Interfaces.CommentData[];

Значение свойства

Excel.Interfaces.CommentData[]

Комментарии

[ Набор API: ExcelApi 1.10 ]

customProperties

Возвращает коллекцию настраиваемых свойств на уровне листа.

customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];

Значение свойства

Excel.Interfaces.WorksheetCustomPropertyData[]

Комментарии

[ Набор API: ExcelApi 1.12 ]

enableCalculation

Определяет, следует ли excel пересчитывать лист при необходимости. Значение true, если Excel пересчитывает лист при необходимости. Значение false, если Excel не пересчитывает лист.

enableCalculation?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

horizontalPageBreaks

Получает коллекцию горизонтальных разрывов страницы для листа. Эта коллекция содержит только добавленные вручную разрывы страниц.

horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];

Значение свойства

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[];

Значение свойства

Excel.Interfaces.NamedItemData[]

Комментарии

[ Набор API: ExcelApi 1.4 ]

pageLayout

PageLayout Возвращает объект листа.

pageLayout?: Excel.Interfaces.PageLayoutData;

Значение свойства

Excel.Interfaces.PageLayoutData

Комментарии

[ Набор API: ExcelApi 1.9 ]

pivotTables

Коллекция сводных таблиц на листе.

pivotTables?: Excel.Interfaces.PivotTableData[];

Значение свойства

Excel.Interfaces.PivotTableData[]

Комментарии

[ Набор API: ExcelApi 1.3 ]

position

Положение листа (начиная с нуля) в книге.

position?: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

protection

Возвращает объект защиты листа для листа.

protection?: Excel.Interfaces.WorksheetProtectionData;

Значение свойства

Excel.Interfaces.WorksheetProtectionData

Комментарии

[ Набор API: ExcelApi 1.2 ]

shapes

Возвращает коллекцию всех объектов Shape на листе.

shapes?: Excel.Interfaces.ShapeData[];

Значение свойства

Excel.Interfaces.ShapeData[]

Комментарии

[ Набор API: ExcelApi 1.9 ]

showGridlines

Указывает, являются ли линии сетки видимыми для пользователя.

showGridlines?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.8 ]

showHeadings

Указывает, являются ли заголовки видимыми для пользователя.

showHeadings?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.8 ]

slicers

Возвращает коллекцию срезов, которые являются частью листа.

slicers?: Excel.Interfaces.SlicerData[];

Значение свойства

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. Если лист виден, но для цвета вкладки задано значение auto, возвращается пустая строка. В противном случае свойству будет присвоен цвет в форме #RRGGBB (например, FFA500). При настройке цвета используйте пустую строку, чтобы задать "автоматический" цвет или реальный цвет в противном случае.

tabColor?: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

tabId

Возвращает значение, представляющее этот лист, который может быть прочитан с помощью Open Office XML. Это целочисленное значение, которое отличается от worksheet.id (возвращает глобальный уникальный идентификатор) и worksheet.name (которое возвращает такое значение, как "Лист1").

tabId?: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.14 ]

tables

Коллекция таблиц, имеющихся на листе.

tables?: Excel.Interfaces.TableData[];

Значение свойства

Excel.Interfaces.TableData[]

Комментарии

[ Набор API: ExcelApi 1.1 ]

verticalPageBreaks

Получает коллекцию вертикальных разрывов страницы для листа. Эта коллекция содержит только добавленные вручную разрывы страниц.

verticalPageBreaks?: Excel.Interfaces.PageBreakData[];

Значение свойства

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 для его настройки. ]