Excel.Interfaces.WorksheetData interface

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

Комментарии

Используется

Свойства

autoFilter

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

charts

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

comments

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

customProperties

Получает коллекцию настраиваемых свойств на уровне листа.

enableCalculation

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

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 (который возвращает значение, например "Лист1").

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 при необходимости пересчитать лист. Имеет значение "True", если Excel пересчитывает лист при необходимости. Значение false, если Excel не пересчитывает лист.

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 (который возвращает значение, например "Лист1").

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