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

Статья
2025-04-23

Функции набора обязательных элементов API JavaScript для Excel 1.8 включают API для сводных таблиц, проверку данных, диаграммы, события для диаграмм, параметры производительности и создание рабочей книги.

Сводная таблица

Этап 2 для API сводной таблицы позволяет надстройкам устанавливать иерархии сводной таблицы. Теперь вы можете управлять данными и способом их сведения. Наша статья о сводной таблице содержит дополнительные сведения о новых функциональных возможностях сводной таблицы.

Проверка данных

Проверка данных позволяет управлять данными, которые вводит в лист пользователь. Вы можете ограничить ячейки предопределенными наборами ответов или задать всплывающие предупреждения о нежелательном вводе. Узнайте больше о добавлении проверки данных в диапазоны уже сегодня.

Диаграммы

Еще один этап выпуска API диаграмм обеспечивает дополнительный программный контроль над элементами диаграммы. Теперь у вас есть расширенный доступ к условным обозначениям, осям, линии тренда и области построения.

События

Для диаграмм добавлены дополнительные события. Пусть ваша надстройка реагирует на взаимодействие пользователей с диаграммой. Вы также можете включать и отключать события, запускаемые во всей книге.

Список API

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

Класс	Поля	Описание
BasicDataValidation	formula1	Задает правый операнд, если свойству оператора присвоен двоичный оператор, например GreaterThan (левый операнд — это значение, которое пользователь пытается ввести в ячейке).
	формула 2	С помощью троиочных операторов Between и NotBetween задает операнд верхней границы.
	operator	Оператор, используемый для проверки данных.
Chart	categoryLabelLevel	Задает константу перечисления уровня меток категории диаграммы, ссылающуюся на уровень исходных меток категорий.
	displayBlanksAs	Указывает способ построения пустых ячеек на диаграмме.
	onActivated	Происходит при активации диаграммы.
	onDeactivated	Происходит при отключении диаграммы.
	plotArea	Представляет область диаграммы.
	plotBy	Определяет способ использования столбцов или строк в качестве рядов данных на диаграмме.
	plotVisibleOnly	True, если отображаются только видимые ячейки.
	seriesNameLevel	Указывает константу перечисления уровня имен рядов диаграммы, ссылающуюся на уровень имен исходных рядов.
	showDataLabelsOverMaximum	Указывает, следует ли отображать метки данных, если значение больше максимального значения на оси значений.
	style	Задает стиль диаграммы.
ChartActivatedEventArgs	chartId	Возвращает идентификатор активированной диаграммы.
	type	Получает тип события.
	worksheetId	Возвращает идентификатор листа, на котором активирована диаграмма.
ChartAddedEventArgs	chartId	Возвращает идентификатор диаграммы, добавленной на лист.
	источник	Получает источник события.
	type	Получает тип события.
	worksheetId	Возвращает идентификатор листа, на который добавляется диаграмма.
ChartAxis	Трассы	Задает выравнивание для указанной метки тика оси.
	isBetweenCategories	Указывает, пересекает ли ось значений ось категорий между категориями.
	Многоуровневый	Указывает, является ли ось многоуровневой.
	numberFormat	Задает код формата для метки такта оси.
	Смещение	Указывает расстояние между уровнями меток и расстояние между первым уровнем и линией оси.
	position	Указывает указанное положение оси, в котором пересекаются другие оси.
	positionAt	Указывает положение оси, в которой пересекаются другие оси.
	setPositionAt(value: number)	Задает указанное положение оси, в котором пересекаются другие оси.
	textOrientation	Указывает угол, на который текст ориентирован для метки тика оси диаграммы.
ChartAxisFormat	fill	Задает форматирование заливки диаграммы.
ChartAxisTitle	setFormula(formula: string)	Строковое значение, представляющее формулу заголовка оси диаграммы с использованием нотации стиля A1.
ChartAxisTitleFormat	граница	Задает формат границы заголовка оси диаграммы, который включает в себя цвет, стиль линии и вес.
	fill	Задает форматирование заливки заголовка оси диаграммы.
ChartBorder	clear()	Очищает формат границы элемента диаграммы.
ChartCollection	onActivated	Происходит при активации диаграммы.
	onAdded	Происходит при добавлении новой диаграммы на лист.
	onDeactivated	Происходит при отключении диаграммы.
	onDeleted	Происходит при удалении диаграммы.
ChartDataLabel	Автотекст	Указывает, создает ли метка данных соответствующий текст автоматически на основе контекста.
	format	Представляет формат метки данных диаграммы.
	formula	Строковое значение, представляющее формулу метки данных диаграммы с использованием нотации стиля A1.
	height	Возвращает высоту метки данных диаграммы (в пунктах).
	horizontalAlignment	Представляет горизонтальное выравнивание для метки данных диаграммы.
	left	Представляет расстояние от левого края метки данных диаграммы до левого края области диаграммы (в пунктах).
	numberFormat	Строковое значение, представляющее код формата для метки данных.
	text	Строка, представляющая текст метки данных на диаграмме.
	textOrientation	Представляет угол, на который текст ориентирован для метки данных диаграммы.
	top	Представляет расстояние от верхнего края метки данных диаграммы до верха области диаграммы (в пунктах).
	verticalAlignment	Представляет вертикальное выравнивание для метки данных диаграммы.
	width	Возвращает ширину метки данных диаграммы (в пунктах).
ChartDataLabelFormat	граница	Представляет формат границы, включающий цвет, тип линии и толщину.
ChartDataLabels	Автотекст	Указывает, будут ли метки данных автоматически создавать соответствующий текст на основе контекста.
	horizontalAlignment	Задает горизонтальное выравнивание метки данных диаграммы.
	numberFormat	Задает код формата для меток данных.
	textOrientation	Представляет угол, на который текст ориентирован для меток данных.
	verticalAlignment	Представляет вертикальное выравнивание для метки данных диаграммы.
ChartDeactivatedEventArgs	chartId	Возвращает идентификатор отключенной диаграммы.
	type	Получает тип события.
	worksheetId	Возвращает идентификатор листа, на котором отключена диаграмма.
ChartDeletedEventArgs	chartId	Возвращает идентификатор диаграммы, которая удаляется с листа.
	источник	Получает источник события.
	type	Получает тип события.
	worksheetId	Возвращает идентификатор листа, на котором удаляется диаграмма.
ChartLegendEntry	height	Указывает высоту записи условных обозначений в условных обозначениях диаграммы.
	index	Указывает индекс записи условных обозначений в условных обозначениях диаграммы.
	left	Задает левое значение записи условных обозначений диаграммы.
	top	Указывает начало записи условных обозначений диаграммы.
	width	Представляет ширину записи условных обозначений на диаграмме Условные обозначения.
ChartLegendFormat	граница	Представляет формат границы, включающий цвет, тип линии и толщину.
ChartPlotArea	format	Задает форматирование области диаграммы.
	height	Задает значение высоты области диаграммы.
	insideHeight	Задает значение внутренней высоты области диаграммы.
	insideLeft	Задает внутреннее левое значение области диаграммы.
	insideTop	Задает внутреннее верхнее значение области диаграммы.
	insideWidth	Задает значение внутренней ширины области диаграммы.
	left	Задает левое значение области диаграммы.
	position	Указывает положение области диаграммы.
	top	Задает максимальное значение области диаграммы.
	width	Задает значение ширины области диаграммы.
ChartPlotAreaFormat	граница	Задает атрибуты границы области диаграммы.
	fill	Задает формат заполнения объекта, который включает сведения о форматировании фона.
ChartSeries	axisGroup	Указывает группу для указанного ряда.
	dataLabels	Представляет коллекцию всех меток данных в ряде.
	Взрыв	Задает значение взрыва для круговой диаграммы или среза кольцевой диаграммы.
	firstSliceAngle	Задает угол первого среза круговой диаграммы или кольцевой диаграммы в градусах (по часовой стрелке по вертикали).
	invertIfNegative	Значение true, если Excel инвертирует шаблон в элементе, если он соответствует отрицательному числу.
	Перекрываются	Указывает на расположение строк и столбцов.
	secondplotSize	Задает размер дополнительного раздела круговой диаграммы или линейчатой круговой диаграммы в процентах от размера основного кругового круга.
	splitType	Указывает способ разделения двух разделов круговой диаграммы или линейчатой диаграммы.
	varyByCategories	Значение true, если Excel присваивает каждому маркеру данных другой цвет или узор.
ChartTrendline	backwardPeriod	Представляет число периодов, на которые линия тренда расширяется назад.
	forwardPeriod	Представляет число периодов, на которые линия тренда расширяется вперед.
	Метки	Представляет метку линии тренда диаграммы.
	showEquation	Значение true, если формула для линии тренда отображается на диаграмме.
	showRSquared	Значение true, если на диаграмме отображается значение в квадрате r для линии тренда.
ChartTrendlineLabel	Автотекст	Указывает, будет ли метка линии тренда автоматически создавать соответствующий текст на основе контекста.
	format	Формат метки линии тренда диаграммы.
	formula	Строковое значение, представляющее формулу метки линии тренда диаграммы с использованием нотации в стиле A1.
	height	Возвращает высоту подписи линии тренда диаграммы (в пунктах).
	horizontalAlignment	Представляет горизонтальное выравнивание метки линии тренда диаграммы.
	left	Представляет расстояние (в точках) от левого края метки линии тренда диаграммы до левого края области диаграммы.
	numberFormat	Строковое значение, представляющее код формата для метки линии тренда.
	text	Строка, представляющая текст подписи линии тренда на диаграмме.
	textOrientation	Представляет угол, на который текст ориентирован для метки линии тренда диаграммы.
	top	Представляет расстояние (в точках) от верхнего края метки линии тренда диаграммы до верхней части области диаграммы.
	verticalAlignment	Представляет вертикальное выравнивание метки линии тренда диаграммы.
	width	Возвращает ширину подписи линии тренда диаграммы (в пунктах).
ChartTrendlineLabelFormat	граница	Задает формат границы, который включает цвет, стиль линий и вес.
	fill	Задает формат заливки текущей метки линии тренда диаграммы.
	font	Указывает атрибуты шрифта (например, имя шрифта, размер шрифта и цвет) для метки линии тренда диаграммы.
CustomDataValidation	formula	Формула проверки настраиваемых данных.
DataPivotHierarchy	поле	Возвращает сводные поля, связанные с DataPivotHierarchy.
	id	Идентификатор DataPivotHierarchy.
	name	Имя DataPivotHierarchy.
	numberFormat	Числовой формат DataPivotHierarchy.
	position	Положение DataPivotHierarchy.
	setToDefault()	Сбрасывает DataPivotHierarchy до значений по умолчанию.
	showAs	Указывает, должны ли данные отображаться в виде определенного суммарного вычисления.
	summarizeBy	Указывает, отображаются ли все элементы DataPivotHierarchy.
DataPivotHierarchyCollection	add(pivotHierarchy: Excel.PivotHierarchy)	Добавляет PivotHierarchy к текущей оси.
	getCount()	Получает количество иерархий сводного объекта в коллекции.
	getItem(name: string)	Возвращает DataPivotHierarchy по имени или идентификатору.
	getItemOrNullObject(имя: строка)	Получает DataPivotHierarchy по имени.
	items	Получает загруженные дочерние элементы в этой коллекции.
	remove(DataPivotHierarchy: Excel.DataPivotHierarchy)	Удаляет PivotHierarchy из текущей оси.
DataValidation	clear()	Очищает проверку данных из текущего диапазона.
	errorAlert	Сообщение об ошибке, когда пользователь вводит недопустимые данные.
	ignoreBlanks	Указывает, будет ли выполняться проверка данных в пустых ячейках.
	сообщение	Запрашивать, когда пользователи выбирают ячейку.
	Правило	Правило проверки данных, содержащее различные типы критериев проверки данных.
	type	Тип проверки данных см `Excel.DataValidationType` . дополнительные сведения.
	Действительны	Указывает, являются ли все значения ячеек допустимыми в соответствии с правилами проверки данных.
DataValidationErrorAlert	message	Представляет сообщение об ошибке.
	showAlert	Указывает, следует ли отображать диалоговое окно оповещения об ошибке, когда пользователь вводит недопустимые данные.
	style	Тип оповещений о проверке данных см. в этой статье `Excel.DataValidationAlertStyle` .
	заголовок	Представляет заголовок диалогового окна оповещения об ошибке.
DataValidationPrompt	message	Указывает сообщение запроса.
	showPrompt	Указывает, отображается ли запрос, когда пользователь выбирает ячейку с проверкой данных.
	заголовок	Указывает заголовок запроса.
DataValidationRule	Пользовательские	Условия проверки настраиваемых данных.
	дата	Условия проверки данных даты.
	Десятичных	Условия проверки десятичных данных.
	list	Условия проверки данных списка.
	textLength	Критерии проверки данных длины текста.
	time	Условия проверки данных времени.
	wholeNumber	Условия проверки целочислимого числа данных.
DateTimeDataValidation	formula1	Задает правый операнд, если свойству оператора присвоен двоичный оператор, например GreaterThan (левый операнд — это значение, которое пользователь пытается ввести в ячейке).
	формула 2	С помощью троиочных операторов Between и NotBetween задает операнд верхней границы.
	operator	Оператор, используемый для проверки данных.
FilterPivotHierarchy	enableMultipleFilterItems	Определяет, следует ли разрешить несколько элементов фильтра.
	fields	Возвращает сводные поля, связанные с FilterPivotHierarchy.
	id	Идентификатор filterPivotHierarchy.
	name	Имя FilterPivotHierarchy.
	position	Положение FilterPivotHierarchy.
	setToDefault()	Сбрасывает FilterPivotHierarchy до значений по умолчанию.
FilterPivotHierarchyCollection	add(pivotHierarchy: Excel.PivotHierarchy)	Добавляет PivotHierarchy к текущей оси.
	getCount()	Получает количество иерархий сводного объекта в коллекции.
	getItem(name: string)	Возвращает фильтрPivotHierarchy по его имени или идентификатору.
	getItemOrNullObject(имя: строка)	Получает FilterPivotHierarchy по имени.
	items	Получает загруженные дочерние элементы в этой коллекции.
	remove(filterPivotHierarchy: Excel.FilterPivotHierarchy)	Удаляет PivotHierarchy из текущей оси.
ListDataValidation	inCellDropDown	Указывает, следует ли отображать список в раскрывающемся списке ячейки.
	source	Источник списка для проверки данных
PivotField	id	Идентификатор сводного поля.
	items	Возвращает PivotItems, связанные со сводным полем.
	name	Имя сводного поля.
	showAllItems	Определяет, следует ли отображать все элементы сводного поля.
	sortByLabels(sortBy: SortBy)	Сортирует сводное поле.
	subtotals	Промежуточные итоги сводного поля.
PivotFieldCollection	getCount()	Возвращает количество полей сводки в коллекции.
	getItem(name: string)	Возвращает сводное поле по его имени или идентификатору.
	getItemOrNullObject(имя: строка)	Возвращает сводное поле по имени.
	items	Получает загруженные дочерние элементы в этой коллекции.
PivotHierarchy	fields	Возвращает сводные поля, связанные с PivotHierarchy.
	id	Идентификатор сводной иерархии.
	name	Имя PivotHierarchy.
PivotHierarchyCollection	getCount()	Получает количество иерархий сводного объекта в коллекции.
	getItem(name: string)	Возвращает сводную иерархию по ее имени или идентификатору.
	getItemOrNullObject(имя: строка)	Получает PivotHierarchy по имени.
	items	Получает загруженные дочерние элементы в этой коллекции.
PivotItem	id	Идентификатор PivotItem.
	isExpanded	Определяет, развернут ли элемент для отображения дочерних элементов или же свернут, а дочерние элементы являются скрытыми.
	name	Имя элемента сводной таблицы.
	visible	Указывает, является ли PivotItem видимым.
PivotItemCollection	getCount()	Возвращает количество PivotItems в коллекции.
	getItem(name: string)	Возвращает PivotItem по его имени или идентификатору.
	getItemOrNullObject(имя: строка)	Возвращает PivotItem по имени.
	items	Получает загруженные дочерние элементы в этой коллекции.
PivotLayout	getColumnLabelRange()	Возвращает диапазон, где находятся названия столбцов сводной таблицы.
	getDataBodyRange()	Возвращает диапазон, где находятся значения данных сводной таблицы.
	getFilterAxisRange()	Возвращает диапазон области фильтра сводной таблицы.
	getRange()	Возвращает диапазон, в котором существует сводная таблица, за исключением области фильтра.
	getRowLabelRange()	Возвращает диапазон, где находятся названия строк сводной таблицы.
	layoutType	Это свойство указывает PivotLayoutType всех полей в сводной таблице.
	showColumnGrandTotals	Указывает, отображается ли в отчете сводной таблицы общие итоги для столбцов.
	showRowGrandTotals	Указывает, отображается ли в отчете сводной таблицы общие итоги для строк.
	subtotalLocation	Это свойство указывает на `SubtotalLocationType` все поля в сводной таблице.
PivotTable	columnHierarchies	Иерархии сводных столбцов сводной таблицы.
	dataHierarchies	Иерархии сводных данных сводной таблицы.
	delete()	Удаляет сводную таблицу.
	filterHierarchies	Иерархии сводных фильтров сводной таблицы.
	Иерархии	Иерархии сводного документа сводной таблицы.
	Макет	PivotLayout, описывающий макет и визуальную структуру сводной таблицы.
	rowHierarchies	Иерархии сводных строк сводной таблицы.
PivotTableCollection	add(name: string, source: Range \| string \| Таблица, назначение: \| диапазона string)	Добавьте сводную таблицу на основе указанных исходных данных и вставьте ее в левую верхнюю ячейку целевого диапазона.
Range	dataValidation	Возвращает объект проверки данных.
RowColumnPivotHierarchy	fields	Возвращает сводные поля, связанные с RowColumnPivotHierarchy.
	id	Идентификатор RowColumnPivotHierarchy.
	name	Имя RowColumnPivotHierarchy.
	position	Положение RowColumnPivotHierarchy.
	setToDefault()	Сбрасывает RowColumnPivotHierarchy до значений по умолчанию.
RowColumnPivotHierarchyCollection	add(pivotHierarchy: Excel.PivotHierarchy)	Добавляет PivotHierarchy к текущей оси.
	getCount()	Получает количество иерархий сводного объекта в коллекции.
	getItem(name: string)	Возвращает RowColumnPivotHierarchy по его имени или идентификатору.
	getItemOrNullObject(имя: строка)	Получает RowColumnPivotHierarchy по имени.
	items	Получает загруженные дочерние элементы в этой коллекции.
	remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy)	Удаляет PivotHierarchy из текущей оси.
Время выполнения	enableEvents	Переключение событий JavaScript в текущей области задач или контентной надстройке.
ShowAsRule	baseField	Сводное поле, на основе вычисления `ShowAs` , если применимо в соответствии с типом `ShowAsCalculation` , в противном случае `null`.
	baseItem	Элемент, на основе вычисления `ShowAs` , если применимо в соответствии с типом `ShowAsCalculation` , в противном случае `null`.
	Расчет	Вычисление `ShowAs` , используемое для сводного поля.
Style	autoIndent	Указывает, будет ли текст автоматически отступен, если выравнивание текста в ячейке установлено на равное распределение.
	textOrientation	Ориентация текста для стиля.
Subtotals	automatic	Если `Automatic` задано значение `true`, все остальные значения будут игнорироваться при задании `Subtotals`.
	Средняя
	count
	countNumbers
	Макс
	Мин
	Продукта
	standardDeviation
	standardDeviationP
	Сумма
	Отклонение
	отклонениеP
Table	legacyId	Возвращает числовой идентификатор.
TableChangedEventArgs	getRange(ctx: Excel.RequestContext)	Возвращает диапазон, представляющий измененную область таблицы на определенном листе.
	getRangeOrNullObject(ctx: Excel.RequestContext)	Возвращает диапазон, представляющий измененную область таблицы на определенном листе.
Workbook	readOnly	Возвращает значение `true` , если книга открыта в режиме только для чтения.
WorkbookCreated
Worksheet	onCalculated	Происходит при вычислении листа.
	showGridlines	Указывает, являются ли линии сетки видимыми для пользователя.
	showHeadings	Указывает, являются ли заголовки видимыми для пользователя.
WorksheetCalculatedEventArgs	type	Получает тип события.
	worksheetId	Возвращает идентификатор листа, на котором выполнялось вычисление.
WorksheetChangedEventArgs	getRange(ctx: Excel.RequestContext)	Получает диапазон, представляющий измененную область конкретного листа.
	getRangeOrNullObject(ctx: Excel.RequestContext)	Получает диапазон, представляющий измененную область конкретного листа.
WorksheetCollection	onCalculated	Происходит при вычислении любого листа в книге.