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

  • Статья

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

Настройка диаграмм

С помощью новых API диаграмм можно создавать дополнительные типы диаграмм, добавлять ряды данных в диаграмму, задавать заголовок диаграммы, добавлять заголовок оси, добавлять отображаемые единицы, добавлять линию тренда со скользящей средней, менять линию тренда на линейную и многое другое. Ниже приведены некоторые примеры.

  • Ось диаграммы — получайте, задавайте, форматируйте и удаляйте единицу измерения, метку и заголовок оси на диаграмме.
  • Ряды диаграммы — добавляйте, задавайте и удаляйте ряды на диаграмме. Изменяйте маркеры рядов, порядок и размер построения.
  • Линии трендов диаграммы — добавляйте, получайте и форматируйте линии тренда на диаграмме.
  • Условные обозначения диаграммы — форматируйте шрифт условных обозначений на диаграмме.
  • Точка диаграммы — задавайте цвет точки диаграммы.
  • Подстрока заголовка диаграммы — получение и установка подстроки заголовка для диаграммы.
  • Тип диаграммы — параметр для создания дополнительных типов диаграмм.

События

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

Настройка внешнего вида листов и диапазонов

С помощью новых интерфейсов API можно настроить внешний вид листов несколькими способами:

  • Закрепляйте области, чтобы отображать отдельные строки или столбцы при прокрутке листа. Например, если первая строка на вашем листе содержит заголовки, вы можете закрепить эту строку, чтобы заголовки столбцов оставались видимыми при прокрутке листа.
  • Изменяйте цвета вкладки листа.
  • Добавляйте заголовки листов.

Внешний вид диапазонов можно настроить несколькими способами:

  • Задавайте стиль ячейки для диапазона, чтобы обеспечить для всех ячеек в диапазоне единообразное форматирование. Стиль ячейки — определенный набор параметров форматирования, таких как шрифты и размеры шрифтов, форматы чисел, границы ячейки и заливка ячеек. Используйте любой из встроенных стилей ячеек Excel или создайте свой собственный стиль ячейки.
  • Настройте ориентацию текста для диапазона.
  • Добавляйте или изменяйте гиперссылку в диапазоне, ведущую в другое место в рабочей книге или на внешнее расположение.

Управление свойствами документа

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

Копирование листов

С помощью API копирования листа вы можете копировать данные и формат с одного листа на новый рабочий лист в пределах одной книги и уменьшить объем необходимой передачи данных.

Удобная обработка диапазонов

С помощью различных API-интерфейсов диапазона можно выполнять такие действия, как получение окружающей области, получение диапазона с измененными размерами и многое другое. Эти API позволят намного эффективнее выполнять задачи обработки и адресации диапазонов.

Дополнительно:

  • Параметры защиты книги и листа — используйте эти API для защиты данных на листе и в структуре книги.
  • Обновление именованного элемента — используйте этот API для обновления именованного элемента.
  • Получение активной ячейки — используйте этот API для получения активной ячейки книги.

Список API

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

Класс Поля Описание
Chart chartType Указывает тип диаграммы.
id Уникальный идентификатор диаграммы.
showAllFieldButtons Указывает, должны ли отображаться все кнопки полей в сводной диаграмме.
ChartAreaFormat граница Представляет формат границы области диаграммы, включающую цвет, стиль линий и вес.
ChartAxes getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup) Возвращает указанную ось, определенную по типу и группе.
ChartAxis axisGroup Указывает группу для указанной оси.
baseTimeUnit Указывает базовую единицу для указанной оси категорий.
categoryType Указывает тип оси категории.
customDisplayUnit Задает значение единицы отображения пользовательской оси.
displayUnit Представляет отображаемую единицу измерения оси.
height Указывает высоту (в точках) оси диаграммы.
left Указывает расстояние (в точках) от левого края оси до левого края области диаграммы.
logBase Задает основание логарифма при использовании логарифмических шкал.
majorTickMark Указывает тип основной отметки для указанной оси.
majorTimeUnitScale Задает значение шкалы основной единицы для оси категорий, если свойству categoryType присвоено значение dateAxis.
minorTickMark Указывает тип дополнительной отметки для указанной оси.
minorTimeUnitScale Указывает дополнительное значение шкалы единицы для оси категорий, если categoryType свойство имеет значение dateAxis.
reversePlotOrder Указывает, отображает ли Excel точки данных от последней до первой.
scaleType Указывает тип масштабирования оси значений.
setCategoryNames(sourceData: Range) Устанавливает все имена категорий для указанной оси.
setCustomDisplayUnit(value: number) Задает отображаемую единицу измерения оси в виде настраиваемого значения.
showDisplayUnitLabel Указывает, отображается ли метка единицы отображения оси.
tickLabelPosition Указывает положение меток галочки на указанной оси.
tickLabelSpacing Указывает количество категорий или рядов между метками.
tickMarkSpacing Указывает количество категорий или рядов между метками.
top Указывает расстояние (в точках) от верхнего края оси до верхней части области диаграммы.
type Указывает тип оси.
visible Указывает, видна ли ось.
width Задает ширину (в точках) оси диаграммы.
ChartBorder color HTML-код цвета, представляющий цвет границ в диаграмме.
lineStyle Представляет тип линии границы.
weight Представляет толщину границы (в пунктах).
ChartDataLabel position Значение, представляющее положение метки данных.
Разделитель Строка, представляющая разделитель для метки данных на диаграмме.
showBubbleSize Указывает, отображается ли размер пузырька метки данных.
showCategoryName Указывает, отображается ли имя категории метки данных.
showLegendKey Указывает, отображается ли ключ условных обозначений метки данных.
showPercentage Указывает, отображается ли процент метки данных.
showSeriesName Указывает, отображается ли имя ряда меток данных.
showValue Указывает, отображается ли значение метки данных.
ChartFormatString font Представляет атрибуты шрифта, такие как имя шрифта, размер шрифта и цвет объекта символов диаграммы.
ChartLegend height Указывает высоту (в точках) условных обозначений на диаграмме.
left Указывает левое значение (в пунктах) условных обозначений на диаграмме.
legendEntries Представляет коллекцию объектов legendEntries в условных обозначениях.
showShadow Указывает, имеет ли условный обозначения тень на диаграмме.
top Указывает верхнюю часть условных обозначений диаграммы.
width Задает ширину (в точках) условных обозначений на диаграмме.
ChartLegendEntry visible Представляет видимость записи условных обозначений диаграммы.
ChartLegendEntryCollection getCount() Возвращает количество записей условных обозначений в коллекции.
getItemAt(index: number) Возвращает запись легенды по заданному индексу.
items Получает загруженные дочерние элементы в этой коллекции.
ChartLineFormat lineStyle Представляет стиль линии.
weight Представляет толщину линии (в пунктах).
ChartPoint dataLabel Возвращает метку данных точки диаграммы.
hasDataLabel Указывает, имеет ли точка данных метку данных.
markerBackgroundColor Html-код цветов представляет цвет фона маркера точки данных (например, #FF0000 представляет красный цвет).
markerForegroundColor Html-код цветового кода представляет цвет переднего плана маркера точки данных (например, #FF0000 представляет красный цвет).
markerSize Представляет размер маркера точки данных.
markerStyle Представляет стиль маркера точки данных диаграммы.
ChartPointFormat граница Представляет формат границы точки данных диаграммы, которая включает сведения о цвете, стиле и весе.
ChartSeries chartType Представляет тип диаграммы для ряда.
delete() Удаляет ряд диаграммы.
doughnutHoleSize Представляет размер отверстия ряда кольцевой диаграммы.
Фильтруется Указывает, фильтруется ли ряд.
gapWidth Представляет ширину разрывов рядов диаграммы.
hasDataLabels Указывает, имеет ли ряд метки данных.
markerBackgroundColor Задает цвет фона маркера ряда диаграммы.
markerForegroundColor Задает цвет маркера переднего плана ряда диаграммы.
markerSize Задает размер маркера ряда диаграммы.
markerStyle Задает стиль маркера ряда диаграммы.
plotOrder Задает порядок построения ряда диаграммы в группе диаграмм.
setBubbleSizes(sourceData: Range) Задает размеры пузырьков для ряда диаграмм.
setValues(sourceData: Range) Задает значения для ряда диаграммы.
setXAxisValues(sourceData: Range) Задает значения оси X для ряда диаграммы.
showShadow Указывает, имеет ли ряд тень.
Гладкой Указывает, является ли ряд гладким.
линии тренда Коллекция линий тренда в серии.
ChartSeriesCollection add(name?: string, index?: number) Добавляет новый ряд в коллекцию.
ChartTitle getSubstring(start: number, length: number) Получение подстроки заголовка диаграммы.
height Возвращает высоту заголовка диаграммы (в пунктах).
horizontalAlignment Задает горизонтальное выравнивание заголовка диаграммы.
left Указывает расстояние (в точках) от левого края заголовка диаграммы до левого края области диаграммы.
position Представляет положение заголовка диаграммы.
setFormula(formula: string) Задает строковое значение, представляющее формулу заголовка диаграммы с использованием нотации стиля A1.
showShadow Представляет логическое значение, которое определяет, имеет ли заголовок диаграммы тень.
textOrientation Указывает угол, на который текст ориентирован для заголовка диаграммы.
top Указывает расстояние (в точках) от верхнего края заголовка диаграммы до верхней части области диаграммы.
verticalAlignment Задает вертикальное выравнивание заголовка диаграммы.
width Задает ширину (в точках) заголовка диаграммы.
ChartTitleFormat граница Представляет формат границы заголовка диаграммы, который включает цвет, стиль линий и вес.
ChartTrendline delete() Удаляет объект линии тренда.
format Представляет форматирование линии тренда диаграммы.
Перехватить Представляет значение отсекаемого отрезка линии тренда.
movingAveragePeriod Представляет период линии тренда диаграммы.
name Представляет имя линии тренда.
polynomialOrder Представляет порядок линии тренда диаграммы.
type Представляет тип линии тренда диаграммы.
ChartTrendlineCollection add(type?: Excel.ChartTrendlineType) Добавляет новую линию тренда в коллекцию линий тренда.
getCount() Возвращает количество линий тренда в коллекции.
getItem(index: number) Возвращает объект линии тренда по индексу, который является порядком вставки в массиве элементов.
items Получает загруженные дочерние элементы в этой коллекции.
ChartTrendlineFormat line Представляет форматирование линий диаграммы.
CustomProperty delete() Удаляет настраиваемое свойство.
key Ключ настраиваемого свойства.
type Тип значения, используемого для настраиваемого свойства.
value Значение настраиваемого свойства.
CustomPropertyCollection add(key: string, value: any) Создает или задает настраиваемое свойство.
deleteAll() Удаляет все настраиваемые свойства в коллекции.
getCount() Получает количество настраиваемых свойств.
getItem(key: string) Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра.
getItemOrNullObject(key: string) Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра.
items Получает загруженные дочерние элементы в этой коллекции.
DataConnectionCollection refreshAll() Обновляет подключения к данным в коллекции, например из сводной таблицы к набору данных Power BI или из модели данных в таблицу или диапазон в той же книге.
DocumentProperties Автор Автор книги.
Категории Категория книги.
comments Комментарии книги.
company Компания книги.
creationDate Получает дату создания книги.
Пользовательские Получает коллекцию настраиваемых свойств книги.
Ключевые слова Ключевые слова книги.
lastAuthor Получает последнего автора книги.
manager Диспетчер книги.
revisionNumber Получает номер редакции книги.
subject Тема книги.
заголовок Название книги.
NamedItem arrayValues Возвращает объект, содержащий значения и типы именованного элемента.
formula Формула именованного элемента.
NamedItemArrayValues types Представляет типы для каждого элемента в массиве именованных элементов.
values Представляет значения каждого элемента в массиве именованных элементов.
Range getAbsoluteResizedRange(numRows: number, numColumns: number) Range Возвращает объект с той же левой верхней ячейкой, что и текущий Range объект, но с указанным числом строк и столбцов.
getImage() Отрисовывает диапазон в виде изображения PNG в кодировке Base64.
getSurroundingRegion() Range Возвращает объект , представляющий окружающую область для левой верхней ячейки в этом диапазоне.
hyperlink Представляет гиперссылку для текущего диапазона.
isEntireColumn Указывает, является ли текущий диапазон целым столбцом.
isEntireRow Указывает, является ли текущий диапазон целой строкой.
numberFormatLocal Представляет код числового формата Excel для заданного диапазона на основе языковых параметров пользователя.
showCard() Отображает карточку для активной ячейки, если она имеет содержимое c форматированным значением.
style Представляет стиль текущего диапазона.
RangeFormat textOrientation Ориентация текста всех ячеек в диапазоне.
useStandardHeight Определяет, равна ли высота Range строки объекта стандартной высоте листа.
useStandardWidth Указывает, соответствует ли ширина столбца Range объекта стандартной ширине листа.
RangeHyperlink address Представляет целевой URL-адрес гиперссылки.
DocumentReference Представляет целевой объект ссылки на документ для гиперссылки.
Подсказка Представляет строку, отображаемую при наведении указателя на гиперссылку.
textToDisplay Представляет строку, отображаемую в верхней левой ячейке диапазона.
Style borders Коллекция из четырех объектов границ, представляющих стиль четырех границ.
Builtin Указывает, является ли стиль встроенным.
delete() Удаляет этот стиль.
fill Заливка стиля.
font Объект Font , представляющий шрифт стиля.
formulaHidden Указывает, будет ли формула скрыта при защите листа.
horizontalAlignment Представляет горизонтальное выравнивание для стиля.
includeAlignment Указывает, включает ли стиль свойства автоматического отступа, горизонтального выравнивания, выравнивания по вертикали, обтекаемого текста, уровня отступа и ориентации текста.
includeBorder Указывает, включает ли стиль цвет, индекс цвета, стиль линии и свойства границы веса.
includeFont Указывает, включает ли стиль фон, полужирный шрифт, цвет, индекс цвета, стиль шрифта, курсив, имя, размер, зачеркивку, подстрочный, надстрочный и подчеркивающий шрифт.
includeNumber Указывает, включает ли стиль свойство числового формата.
includePatterns Указывает, включает ли стиль цвет, индекс цвета, инвертировать , если отрицательный, шаблон, цвет узора и внутренние свойства индекса цвета узора.
includeProtection Указывает, включает ли стиль скрытые и заблокированные свойства защиты формулы.
indentLevel Целое число от 0 до 250, указывающее уровень отступа для стиля.
locked Указывает, заблокирован ли объект при защите листа.
name Имя стиля.
numberFormat Код числового формата для стиля.
numberFormatLocal Локализованный код числового формата для стиля.
readingOrder Направление чтения для стиля.
shrinkToFit Указывает, будет ли текст автоматически сжиматься в соответствии с доступной шириной столбца.
verticalAlignment Задает вертикальное выравнивание стиля.
wrapText Указывает, будет ли Excel переносить текст в объект .
StyleCollection add(name: string) Добавляет новый стиль в коллекцию.
getItem(name: string) Возвращает по Style имени.
items Получает загруженные дочерние элементы в этой коллекции.
Table onChanged Происходит при изменении данных в ячейках в определенной таблице.
onSelectionChanged Происходит при изменении выделения в определенной таблице.
TableChangedEventArgs address Получает адрес, представляющий измененную область таблицы на конкретном листе.
changeType Возвращает тип изменения, представляющий способ активации события изменения.
источник Получает источник события.
tableId Возвращает идентификатор таблицы, в которой были изменены данные.
type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором были изменены данные.
TableCollection onChanged Происходит при изменении данных в любой таблице в книге или листе.
TableSelectionChangedEventArgs address Получает адрес диапазона, представляющий выбранную область таблицы на конкретном листе.
isInsideTable Указывает, находится ли выделенный фрагмент внутри таблицы.
tableId Возвращает идентификатор таблицы, в которой был изменен выделенный фрагмент.
type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором изменено выделение.
Workbook dataConnections Представляет все подключения к данным в книге.
getActiveCell() Получает текущую активную ячейку из книги.
name Получает имя книги.
properties Получает свойства книги.
protection Возвращает объект защиты для книги.
Стили Представляет коллекцию стилей, связанных с книгой.
WorkbookProtection protect(password?: string) Защищает книгу.
Защищены Указывает, защищена ли книга.
unprotect(password?: string) Снимает защиту с книги.
Worksheet copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet) Копирует лист и помещает его в указанное положение.
freezePanes Возвращает объект, который можно использовать для управления замороженными панелями на листе.
getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number) Возвращает объект, Range начинающийся с определенного индекса строки и индекса столбца, охватывающий определенное количество строк и столбцов.
onActivated Происходит при активации листа.
onChanged Происходит при изменении данных на определенном листе.
onDeactivated Происходит при отключении листа.
onSelectionChanged Происходит при изменении выделения на определенном листе.
standardHeight Возвращает стандартную (по умолчанию) высоту всех строк на листе (в пунктах).
standardWidth Задает стандартную (по умолчанию) ширину всех столбцов на листе.
tabColor Цвет вкладки листа.
WorksheetActivatedEventArgs type Получает тип события.
worksheetId Возвращает идентификатор активированного листа.
WorksheetAddedEventArgs источник Получает источник события.
type Получает тип события.
worksheetId Возвращает идентификатор листа, добавляемого в книгу.
WorksheetChangedEventArgs address Получает адрес диапазона, представляющий измененную область конкретного листа.
changeType Возвращает тип изменения, представляющий способ активации события изменения.
источник Получает источник события.
type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором были изменены данные.
WorksheetCollection onActivated Происходит при активации любого листа в книге.
onAdded Происходит при добавлении в книгу нового листа.
onDeactivated Происходит при отключении любого листа в книге.
onDeleted Происходит при удалении листа из книги.
WorksheetDeactivatedEventArgs type Получает тип события.
worksheetId Возвращает идентификатор деактивированного листа.
WorksheetDeletedEventArgs источник Получает источник события.
type Получает тип события.
worksheetId Возвращает идентификатор листа, удаленного из книги.
WorksheetFreezePanes freezeAt(frozenRange: range | string) Задает закрепленные ячейки в представлении активного листа.
freezeColumns(count?: number) Закважи первый столбец или столбцы листа на месте.
freezeRows(count?: number) Зафиксируете верхнюю строку или строки листа на месте.
getLocation() Получает диапазон, описывающий закрепленные ячейки в представлении активного листа.
getLocationOrNullObject() Получает диапазон, описывающий закрепленные ячейки в представлении активного листа.
unfreeze() Удаляет все закрепленные области в листе.
WorksheetProtection unprotect(password?: string) Снимает защиту с листа.
WorksheetProtectionOptions allowEditObjects Представляет параметр защиты листа, разрешающий редактирование объектов.
allowEditScenarios Представляет параметр защиты листа, позволяющий редактировать сценарии.
selectionMode Представляет параметр защиты рабочего листа для режима выделения.
WorksheetSelectionChangedEventArgs address Получает адрес диапазона, представляющий выделенную область конкретного листа.
type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором изменено выделение.

См. также