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

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

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

Список API

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

Класс Поля Описание
ChartAxisTitle textOrientation Указывает угол, под который ориентирован текст для заголовка оси диаграммы.
ChartSeries getDimensionValues(измерение: 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 ИдентификаторComment Представляет идентификатор примечания.
replyIds Представляет идентификаторы связанных ответов, которые относятся к комментарию.
CommentReply contentType Тип содержимого ответа.
CultureInfo datetimeFormat Определяет приемлемый формат отображения даты и времени с учетом культурных особенностей.
DatetimeFormatInfo dateSeparator Получает строку, используемую в качестве разделителя даты.
longDatePattern Получает строку формата для длинного значения даты.
longTimePattern Получает строку формата для значения long time.
shortDatePattern Получает строку формата для короткого значения даты.
разделитель времени Получает строку, используемую в качестве разделителя времени.
PivotDateFilter компаратор Компаратор — это статическое значение, с которым сравниваются другие значения.
условие Задает условие фильтра, определяющее необходимые критерии фильтрации.
Эксклюзив Если true, фильтр исключает элементы, соответствующие критериям.
lowerBound Нижняя граница диапазона для условия фильтра between .
upperBound Верхняя граница диапазона для условия фильтра between .
WholeDays Для equals, before, after, и between условия фильтра, указывает, должны ли сравнения выполняться как целые дни.
PivotField applyFilter(filter: Excel.PivotFilters) Устанавливает один или несколько текущих фильтров сводных фильтров поля и применяет их к полю.
clearAllFilters() Удаляет все условия из всех фильтров поля.
clearFilter(filterType: Excel.PivotFilterType) Удаляет все существующие условия из фильтра поля данного типа (если он применяется в данный момент).
getFilters() Получает все фильтры, примененные к этому полю.
isFiltered(filterType?: Excel.PivotFilterType) Проверяет, есть ли в поле примененные фильтры.
PivotFilters dateFilter Применяемый фильтр даты в поле PivotField.
labelFilter Применяемый фильтр меток поля сводных таблиц.
manualFilter Примененный в настоящее время ручной фильтр Сводного поля.
valueFilter Применяемый фильтр значений поля сводки.
PivotLabelFilter компаратор Компаратор — это статическое значение, с которым сравниваются другие значения.
условие Задает условие фильтра, определяющее необходимые критерии фильтрации.
Эксклюзив Если true, фильтр исключает элементы, соответствующие критериям.
lowerBound Нижняя граница диапазона для условия фильтра between .
substring Подстрока beginsWith, используемая для условий , endsWithи contains filter.
upperBound Верхняя граница диапазона для условия фильтра between .
PivotManualFilter selectedItems Список выбранных элементов для ручной фильтрации.
PivotTable allowMultipleFiltersPerField Указывает, допускает ли сводная таблица применение нескольких фильтров сводных фильтров к заданному полю сводных данных в таблице.
PivotTableScopedCollection getCount() Получает количество сводных таблиц в коллекции.
getFirst() Получение первой сводной таблицы в коллекции.
getItem(key: string) Получает сводную таблицу по имени.
getItemOrNullObject(имя: строка) Получает сводную таблицу по имени.
items Получает загруженные дочерние элементы в этой коллекции.
PivotValueFilter компаратор Компаратор — это статическое значение, с которым сравниваются другие значения.
условие Задает условие фильтра, определяющее необходимые критерии фильтрации.
Эксклюзив Если true, фильтр исключает элементы, соответствующие критериям.
lowerBound Нижняя граница диапазона для условия фильтра between .
selectionType Указывает, охватывает ли фильтр первые и последние N элементов, первые и последние N процентов или первые и последние N чисел.
пороговое значение Пороговое количество элементов, процентов или сумма, количество которых необходимо отфильтровать для фильтра "первый/нижний".
upperBound Верхняя граница диапазона для условия фильтра between .
value Имя выбранного "значения" в поле, по которому требуется выполнить фильтрацию.
Range getDirectPrecedents() Возвращает объект, WorkbookRangeAreas представляющий диапазон, содержащий все прямые предшествующие ячейки указанного диапазона на том же листе или на нескольких листах.
getPivotTables(fullyContained?: логический) Получает коллекцию сводных таблиц, которые перекрываются диапазоном.
getSpillParent() Получает объект диапазона, содержащий базовую ячейку для переносимой ячейки.
getSpillParentOrNullObject() Получает объект диапазона, содержащий ячейку привязки для переносимой ячейки.
getSpillingToRange() Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки.
getSpillingToRangeOrNullObject() Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки.
hasSpill Указывает, есть ли во всех ячейках граница переноса.
числоФорматКатегорий Представляет числовой формат каждой ячейки.
savedAsArray Представляет, все ли ячейки будут сохранены в формулу массива.
RangeAreasCollection getCount() Получает количество RangeAreas объектов в этой коллекции.
getItemAt(index: number) Возвращает RangeAreas объект на основе позиции в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
WorkbookRangeAreas addresses Возвращает массив адресов в стиле А1.
areas Возвращает объект.RangeAreasCollection
getRangeAreasBySheet (ключ: строка) Возвращает объект на основе идентификатора RangeAreas или имени листа в коллекции.
getRangeAreasOrNullObjectBySheet (ключ: строка) Возвращает объект на основе имени или идентификатора RangeAreas листа в коллекции.
диапазоны Возвращает диапазоны, из которых состоит этот объект в объекте RangeCollection .
Worksheet customProperties Получает коллекцию настраиваемых свойств на уровне листа.
WorksheetCustomProperty delete() Удаляет настраиваемое свойство.
key Возвращает ключ настраиваемого свойства.
value Задает значение настраиваемого свойства.
WorksheetCustomPropertyCollection add(ключ: строка; значение: строка) Добавляет новое настраиваемое свойство, сопоставленное с предоставленным ключом.
getCount() Получает количество настраиваемых свойств на этом листе.
getItem(key: string) Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра.
getItemOrNullObject(key: string) Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра.
items Получает загруженные дочерние элементы в этой коллекции.

См. также

  • Last updated on