Новые возможности API JavaScript для Excel 1.12

  • Статья

ExcelApi 1.12 увеличил поддержку формул в диапазонах, добавив API для отслеживания динамических массивов и поиска прямых прецедентов формул. Кроме того, добавлен элемент управления API для фильтров сводной таблицы. Также были внесены улучшения в области функций комментариев, параметров и региональных параметров и настраиваемых свойств.

Функциональная область Описание Соответствующие объекты
Закомментировать события Добавляет события для добавления, изменения и удаления в коллекцию комментариев. CommentCollection
Параметры даты и времени и региональных параметров Предоставляет доступ к дополнительным культурным параметрам форматирования даты и времени. CultureInfo, Приложение NumberFormatInfo
Прямые прецеденты Возвращает диапазоны, используемые для вычисления формулы ячейки. Range
Фильтры сводных данных Применяет фильтры на основе значений к полям сводной таблицы. PivotField, PivotFilters
Разлив диапазона Позволяет надстройкам находить диапазоны, связанные с результатами динамического массива . Range
Настраиваемые свойства на уровне листа Позволяет ограничить область настраиваемых свойств на уровне листа, а также область действия на уровне книги. WorksheetCustomProperty, WorksheetCustomPropertyCollection

Список API

В следующей таблице перечислены API в наборе обязательных api JavaScript для Excel 1.12. Справочную документацию по API для всех API, поддерживаемых набором обязательных API JavaScript для Excel 1.12 или более ранней версии, см. в статье Api Excel в наборе требований 1.12 или более ранней версии.

Класс Поля Описание
ChartAxisTitle textOrientation Задает угол, на который ориентирован текст для заголовка оси диаграммы.
ChartSeries getDimensionValues(dimension: Excel.ChartSeriesDimension) Возвращает значения из одного измерения ряда диаграммы.
Comment contentType Возвращает тип содержимого комментария.
CommentAddedEventArgs commentDetails CommentDetail Возвращает массив, содержащий идентификатор комментария и идентификаторы связанных ответов.
source Указывает источник события.
type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором произошло событие.
CommentChangedEventArgs changeType Возвращает тип изменения, представляющий способ активации события изменения.
commentDetails CommentDetail Получите массив, содержащий идентификатор комментария и идентификаторы связанных ответов.
source Указывает источник события.
type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором произошло событие.
CommentCollection onAdded Происходит при добавлении комментариев.
onChanged Происходит при изменении комментариев или ответов в коллекции комментариев, в том числе при удалении ответов.
onDeleted Происходит при удалении комментариев в коллекции комментариев.
CommentDeletedEventArgs commentDetails CommentDetail Возвращает массив, содержащий идентификатор комментария и идентификаторы связанных ответов.
source Указывает источник события.
type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором произошло событие.
CommentDetail commentId Представляет идентификатор комментария.
replyIds Представляет идентификаторы связанных ответов, принадлежащих к комментарии.
CommentReply contentType Тип содержимого ответа.
CultureInfo Datetimeformat Определяет формат отображения даты и времени, соответствующий культуре.
DatetimeFormatInfo dateSeparator Возвращает строку, используемую в качестве разделителя даты.
longDatePattern Возвращает строку формата для длинного значения даты.
longTimePattern Возвращает строку формата для длительного значения времени.
shortDatePattern Возвращает строку формата для короткого значения даты.
timeSeparator Возвращает строку, используемую в качестве разделителя времени.
PivotDateFilter Компаратор Компаратор — это статическое значение, с которым сравниваются другие значения.
Состояние Указывает условие для фильтра, определяющее необходимые критерии фильтрации.
Эксклюзивные Если trueзадано значение , фильтр исключает элементы, соответствующие условиям.
lowerBound Нижняя граница диапазона для between условия фильтра.
upperBound Верхняя граница диапазона для between условия фильтра.
wholeDays Для equalsусловий фильтра , before, afterи between указывает, следует ли сравнивать целые дни.
PivotField applyFilter(filter: Excel.PivotFilters) Задает один или несколько текущих PivotFilters поля и применяет их к полю.
clearAllFilters() Очищает все критерии из всех фильтров поля.
clearFilter(filterType: Excel.PivotFilterType) Очищает все существующие критерии из фильтра поля заданного типа (если он применяется в данный момент).
getFilters() Возвращает все фильтры, применяемые в настоящее время к полю.
isFiltered(filterType?: Excel.PivotFilterType) Проверяет наличие примененных фильтров к полю.
PivotFilters dateFilter Текущий фильтр даты сводного поля.
labelFilter Текущий фильтр меток сводного поля.
manualFilter В настоящее время применяется фильтр PivotField вручную.
valueFilter Текущий фильтр значений сводного поля.
PivotLabelFilter Компаратор Компаратор — это статическое значение, с которым сравниваются другие значения.
Состояние Указывает условие для фильтра, определяющее необходимые критерии фильтрации.
Эксклюзивные Если trueзадано значение , фильтр исключает элементы, соответствующие условиям.
lowerBound Нижняя граница диапазона для between условия фильтра.
substring Подстрока, используемая для условий beginsWithфильтра , endsWithи contains .
upperBound Верхняя граница диапазона для between условия фильтра.
PivotManualFilter selectedItems Список выбранных элементов для фильтрации вручную.
PivotTable allowMultipleFiltersPerField Указывает, допускает ли сводная таблица применение нескольких PivotFilter для заданного сводного поля в таблице.
PivotTableScopedCollection getCount() Возвращает количество сводных таблиц в коллекции.
getFirst() Возвращает первую сводную таблицу в коллекции.
getItem(key: string) Получает сводную таблицу по имени.
getItemOrNullObject(имя: строка) Получает сводную таблицу по имени.
items Получает загруженные дочерние элементы в этой коллекции.
PivotValueFilter Компаратор Компаратор — это статическое значение, с которым сравниваются другие значения.
Состояние Указывает условие для фильтра, определяющее необходимые критерии фильтрации.
Эксклюзивные Если trueзадано значение , фильтр исключает элементы, соответствующие условиям.
lowerBound Нижняя граница диапазона для between условия фильтра.
selectionType Указывает, используется ли фильтр для верхнего или нижнего N элементов, верхнего или нижнего N процентов или верхней/нижней суммы N.
Порог Пороговое число "N" элементов, процентов или сумм, которые должны быть отфильтрованы для верхнего или нижнего условий фильтра.
upperBound Верхняя граница диапазона для between условия фильтра.
value Имя выбранного значения в поле, по которому выполняется фильтрация.
Range getDirectPrecedents() WorkbookRangeAreas Возвращает объект , представляющий диапазон, содержащий все ячейки прямого прецедента указанного диапазона на одном листе или на нескольких листах.
getPivotTables(fullyContained?: boolean) Возвращает коллекцию сводных таблиц с заданной областью, перекрывающуюся с диапазоном.
getSpillParent() Получает объект диапазона, содержащий базовую ячейку для переносимой ячейки.
getSpillParentOrNullObject() Возвращает объект диапазона, содержащий ячейку привязки для ячейки, в нее попадает.
getSpillingToRange() Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки.
getSpillingToRangeOrNullObject() Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки.
hasSpill Указывает, есть ли во всех ячейках граница переноса.
numberFormatCategories Представляет категорию числового формата каждой ячейки.
savedAsArray Представляет, будут ли все ячейки сохранены в виде формулы массива.
RangeAreasCollection getCount() Возвращает количество RangeAreas объектов в этой коллекции.
getItemAt(index: number) Возвращает объект на RangeAreas основе позиции в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
WorkbookRangeAreas addresses Возвращает массив адресов в стиле A1.
areas RangeAreasCollection Возвращает объект .
getRangeAreasBySheet(key: string) Возвращает объект на основе идентификатора RangeAreas листа или имени в коллекции.
getRangeAreasOrNullObjectBySheet(key: string) Возвращает объект на RangeAreas основе имени листа или идентификатора в коллекции.
Диапазоны Возвращает диапазоны, составляющие этот объект в объекте RangeCollection .
Worksheet customProperties Возвращает коллекцию настраиваемых свойств на уровне листа.
WorksheetCustomProperty delete() Удаляет настраиваемое свойство.
key Возвращает ключ настраиваемого свойства.
value Получает или задает значение настраиваемого свойства.
WorksheetCustomPropertyCollection add(key: string, value: string) Добавляет новое пользовательское свойство, которое сопоставляется с предоставленным ключом.
getCount() Возвращает количество настраиваемых свойств на этом листе.
getItem(key: string) Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра.
getItemOrNullObject(key: string) Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра.
items Получает загруженные дочерние элементы в этой коллекции.

См. также