Набор обязательных требований 1.1 API JavaScript для Excel

  • Статья

API JavaScript для Excel 1.1 — это первая версия API. Это единственный набор требований для Excel, поддерживаемый Excel 2016.

Список API

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

Класс Поля Описание
Application calculate(calculationType: Excel.CalculationType) Пересчитывает данные во всех открытых в текущий момент книгах Excel.
calculationMode Возвращает режим вычисления, используемый в книге, как определено константами в Excel.CalculationMode.
Binding getRange() Возвращает представленный привязкой диапазон.
getTable() Возвращает представленную привязкой таблицу.
getText() Возвращает представленный привязкой текст.
id Представляет идентификатор привязки.
type Возвращает тип привязки.
BindingCollection count Возвращает число привязок в коллекции.
getItem(id: string) Возвращает объект привязки по идентификатору.
getItemAt(index: number) Возвращает объект привязки с учетом его положения в массиве элементов.
items Получает загруженные дочерние элементы в этой коллекции.
Chart Осей Представляет оси диаграммы.
dataLabels Представляет метки данных на диаграмме.
delete() Удаляет объект диаграммы.
format Инкапсулирует свойства формата для области диаграммы.
height Задает высоту объекта диаграммы (в точках).
left Расстояние в пунктах от левого края диаграммы до начала листа.
Легенда Представляет условные обозначения для диаграммы.
name Указывает имя объекта диаграммы.
series Представляет один ряд данных или коллекцию рядов данных в диаграмме.
setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy) Сбрасывает исходные данные для диаграммы.
setPosition(startCell: Range | string, endCell?: Range | string) Располагает диаграмму относительно ячеек на листе.
заголовок Представляет заголовок указанной диаграммы, включая его текст, видимость, положение и форматирование.
top Указывает расстояние (в точках) от верхнего края объекта до верхней строки 1 (на листе) или верхней части области диаграммы (на диаграмме).
width Задает ширину объекта диаграммы (в точках).
ChartAreaFormat fill Представляет формат заливки объекта, включая сведения о форматировании фона.
font Представляет атрибуты шрифта (имя шрифта, размер шрифта, цвет и т. д.) для текущего объекта.
ChartAxes categoryAxis Представляет ось категорий на диаграмме.
seriesAxis Представляет ось рядов трехмерной диаграммы.
valueAxis Представляет ось значений для оси.
ChartAxis format Представляет форматирование объекта диаграммы, в том числе форматирование линий и шрифта.
majorGridlines Возвращает объект , представляющий основные линии сетки для указанной оси.
majorUnit Обозначает интервал между двумя основными делениями.
maximum Представляет максимальное значение на оси значений.
minimum Представляет минимальное значение на оси значений.
minorGridlines Возвращает объект , представляющий дополнительные линии сетки для указанной оси.
minorUnit Представляет интервал между двумя промежуточными делениями.
заголовок Обозначает название оси.
ChartAxisFormat font Указывает атрибуты шрифта (имя шрифта, размер шрифта, цвет и т. д.) для элемента оси диаграммы.
line Задает форматирование линий диаграммы.
ChartAxisTitle format Задает форматирование заголовка оси диаграммы.
text Задает заголовок оси.
visible Указывает, отображается ли название оси.
ChartAxisTitleFormat font Указывает атрибуты шрифта заголовка оси диаграммы, такие как имя шрифта, размер шрифта или цвет объекта заголовка оси диаграммы.
ChartCollection add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy) Создает диаграмму.
count Возвращает количество диаграмм на листе.
getItem(name: string) Возвращает диаграмму по ее имени.
getItemAt(index: number) Возвращает диаграмму с учетом ее положения в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
ChartDataLabelFormat fill Представляет формат заливки для текущей метки данных диаграммы.
font Представляет атрибуты шрифта (например, имя шрифта, размер шрифта и цвет) для метки данных диаграммы.
ChartDataLabels format Задает формат меток данных диаграммы, включая форматирование заливки и шрифта.
position Значение, представляющее положение метки данных.
Разделитель Строка, представляющая разделитель, который используется для меток данных на диаграмме.
showBubbleSize Указывает, отображается ли размер пузырька метки данных.
showCategoryName Указывает, отображается ли имя категории метки данных.
showLegendKey Указывает, отображается ли ключ условных обозначений метки данных.
showPercentage Указывает, отображается ли процент метки данных.
showSeriesName Указывает, отображается ли имя ряда меток данных.
showValue Указывает, отображается ли значение метки данных.
ChartFill clear() Очищает цвет заливки элемента диаграммы.
setSolidColor(color: string) Устанавливает форматирование заливки элемента диаграммы на единый цвет.
ChartFont bold Указывает, является ли шрифт полужирным.
color Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).
italic Указывает, применяется ли курсив.
name Имя шрифта (например, "Calibri")
size Размер шрифта (например, 11)
underline Тип подчеркивания, применяемый для шрифта.
ChartGridlines format Представляет форматирование линий сетки диаграммы.
visible Указывает, видимы ли линии сетки оси.
ChartGridlinesFormat line Представляет форматирование линий диаграммы.
ChartLegend format Представляет форматирование легенды диаграммы, включая заливку и шрифт.
Наложения Указывает, должна ли легенда диаграммы перекрываться с main текст диаграммы.
position Указывает положение условных обозначений на диаграмме.
visible Указывает, отображается ли условный обозначения диаграммы.
ChartLegendFormat fill Представляет формат заливки объекта, включая сведения о форматировании фона.
font Представляет атрибуты шрифта, такие как имя шрифта, размер шрифта и цвет условных обозначений диаграммы.
ChartLineFormat clear() Очищает формат линий элемента диаграммы.
color HTML-код цвета, представляющий цвет линий в диаграмме.
ChartPoint format Инкапсулирует свойства формата точки диаграммы.
value Возвращает значение точки диаграммы.
ChartPointFormat fill Представляет формат заливки диаграммы, включающую сведения о форматировании фона.
ChartPointsCollection count Возвращает количество точек диаграммы в ряду.
getItemAt(index: number) Получение точки на основании ее положения в ряду.
items Получает загруженные дочерние элементы в этой коллекции.
ChartSeries format Представляет форматирование ряда диаграммы, включая формат заливки и линий.
name Указывает имя ряда на диаграмме.
Точки Возвращает коллекцию всех точек ряда.
ChartSeriesCollection count Возвращает количество рядов в коллекции.
getItemAt(index: number) Возвращает ряд в зависимости от его позиции в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
ChartSeriesFormat fill Представляет формат заливки ряда диаграммы, включая сведения о форматировании фона.
line Представляет форматирование линий.
ChartTitle format Представляет форматирование названия диаграммы, включая формат заливки и шрифта.
Наложения Указывает, будет ли заголовок диаграммы перекрывать диаграмму.
text Указывает текст заголовка диаграммы.
visible Указывает, отображается ли название диаграммы.
ChartTitleFormat fill Представляет формат заливки объекта, включая сведения о форматировании фона.
font Представляет атрибуты шрифта (например, имя шрифта, размер шрифта и цвет) для объекта.
NamedItem getRange() Возвращает объект Range, сопоставленный с именем.
name Имя объекта.
type Указывает тип значения, возвращаемого формулой имени.
value Представляет значение, вычисленное по формуле имени.
visible Указывает, является ли объект видимым.
NamedItemCollection getItem(name: string) Возвращает объект, NamedItem используя его имя.
items Получает загруженные дочерние элементы в этой коллекции.
Range address Указывает ссылку на диапазон в стиле A1.
addressLocal Представляет ссылку на диапазон для указанного диапазона на языке пользователя.
cellCount Указывает количество ячеек в диапазоне.
clear(applyTo?: Excel.ClearApplyTo) Очищает значения, формат, заливку, границу диапазона и т. д.
columnCount Задает общее количество столбцов в диапазоне.
columnIndex Задает номер столбца первой ячейки в диапазоне.
delete(shift: Excel.DeleteShiftDirection) Удаляет ячейки, связанные с диапазоном.
format Возвращает объект формата, в который включены шрифт, заливка, границы, выравнивание и другие свойства диапазона.
formulas Представляет формулу в формате A1.
formulasLocal Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом.
getBoundingRect(anotherRange: Range | string) Возвращает наименьший объект диапазона, включающий в себя заданные диапазоны.
getCell(row: number, column: number) Получает объект диапазона, содержащий одну ячейку, по номеру строки и столбца.
getColumn(column: number) Возвращает столбец в диапазоне.
getEntireColumn() Возвращает объект, представляющий весь столбец диапазона (например, если текущий диапазон представляет ячейки "B4:E11", он getEntireColumn представляет собой диапазон, представляющий столбцы "B:E").
getEntireRow() Возвращает объект, представляющий всю строку диапазона (например, если текущий диапазон представляет ячейки "B4:E11", он GetEntireRow представляет собой диапазон, представляющий строки "4:11").
getIntersection(anotherRange: Range | string) Возвращает объект диапазона, представляющий прямоугольное пересечение заданных диапазонов.
getLastCell() Возвращает последнюю ячейку в диапазоне.
getLastColumn() Возвращает последний столбец в диапазоне.
getLastRow() Возвращает последнюю строку в диапазоне.
getOffsetRange(rowOffset: number, columnOffset: number) Возвращает объект, представляющий диапазон, который смещен от указанного диапазона.
getRow(row: number) Возвращает строку из диапазона.
insert(shift: Excel.InsertShiftDirection) Вставляет ячейку или диапазон ячеек на лист вместо этого диапазона, а также сдвигает другие ячейки, чтобы освободить место.
numberFormat Представляет код числового формата Excel для заданного диапазона.
Rowcount Возвращает общее количество строк в диапазоне.
rowIndex Возвращает номер строки первой ячейки диапазона.
select() Выбирает указанный диапазон в пользовательском интерфейсе Excel.
text Текстовые значения указанного диапазона.
valueTypes Указывает тип данных в каждой ячейке.
values Представляет необработанные значения указанного диапазона.
worksheet Лист, содержащий текущий диапазон.
RangeBorder color Код цвета HTML, представляющий цвет линии границы в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
sideIndex Постоянное значение, указывающее определенную сторону границы.
style Одна из констант стиля линии, определяющая стиль линии границы.
weight Определяет толщину границы вокруг диапазона.
RangeBorderCollection count Количество объектов границы в коллекции.
getItem(index: Excel.BorderIndex) Возвращает объект границы по его имени.
getItemAt(index: number) Возвращает объект границы по его индексу.
items Получает загруженные дочерние элементы в этой коллекции.
RangeFill clear() Сброс фона диапазона.
color Код цвета HTML, представляющий цвет фона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый")
RangeFont bold Представляет состояние шрифта полужирным шрифтом.
color Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).
italic Указывает курсивное состояние шрифта.
name Имя шрифта (например, "Calibri").
size размер шрифта
underline Тип подчеркивания, применяемый для шрифта.
RangeFormat borders Коллекция объектов границ, которые применяются ко всему диапазону.
fill Возвращает объект заливки, определенный для всего диапазона.
font Возвращает объект шрифта, определенный для всего диапазона.
horizontalAlignment Представляет выравнивание по горизонтали для указанного объекта.
verticalAlignment Представляет выравнивание по вертикали для указанного объекта.
wrapText Указывает, будет ли Excel переносить текст в объект .
Table столбцы Представляет коллекцию всех столбцов в таблице.
delete() Удаляет таблицу.
getDataBodyRange() Получает объект диапазона, связанный с основными данными таблицы.
getHeaderRowRange() Получает объект диапазона, связанный со строкой заголовка таблицы.
getRange() Получает объект диапазона, связанный со всей таблицей.
getTotalRowRange() Получает объект диапазона, связанный со строкой итогов таблицы.
id Возвращает значение, однозначно идентифицирующее таблицу в данной книге.
name Имя таблицы.
строки Представляет коллекцию всех строк в таблице.
showHeaders Указывает, отображается ли строка заголовка.
showTotals Указывает, отображается ли итоговая строка.
style Значение константы, представляющее стиль таблицы.
TableCollection add(address: Range | string, hasHeaders: boolean) Создает таблицу.
count Возвращает количество таблиц в книге.
getItem(key: string) Получает таблицу по имени или ИД.
getItemAt(index: number) Получает таблицу на основании ее позиции в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
TableColumn delete() Удаляет столбец из таблицы.
getDataBodyRange() Получает объект диапазона, связанный с текстом данных столбца.
getHeaderRowRange() Получает объект диапазона, связанный со строкой заголовков столбца.
getRange() Получает объект диапазона, связанный со всем столбцом.
getTotalRowRange() Получает объект диапазона, связанный со строкой итогов столбца.
id Возвращает уникальный ключ, идентифицирующий столбец в таблице.
index Возвращает номер индекса столбца в коллекции столбцов таблицы.
name Указывает имя столбца таблицы.
values Представляет необработанные значения указанного диапазона.
TableColumnCollection add(index?: number, values?: Массив массива<<boolean | string | number>> | boolean | string | number, name?: string) Добавляет новый столбец в таблицу.
count Возвращает количество столбцов в таблице.
getItem(key: number | string) Возвращает объект столбца по имени или идентификатору.
getItemAt(index: number) Возвращает столбец на основании его позиции в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
TableRow delete() Удаляет строку из таблицы.
getRange() Получает объект диапазона, связанный со всей строкой.
index Возвращает номер индекса строки в коллекции строк таблицы.
values Представляет необработанные значения указанного диапазона.
TableRowCollection add(index?: number, values?: Array<Array Boolean<| string | number>> | boolean | string | number, alwaysInsert?: boolean) Добавляет одну или несколько строк в таблицу.
count Возвращает количество строк в таблице.
getItemAt(index: number) Получает строку на основании ее позиции в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
Workbook application Представляет экземпляр приложения Excel, содержащий эту книгу.
bindings Представляет коллекцию привязок, включенных в книгу.
getSelectedRange() Возвращает выбранный в данный момент один диапазон из книги.
Имена Представляет коллекцию именованных элементов с областью книги (именованные диапазоны и константы).
Таблицы Представляет коллекцию таблиц, сопоставленных с книгой.
Листов Представляет коллекцию листов, сопоставленных с книгой.
Worksheet activate() Активация листа в пользовательском интерфейсе Excel.
Диаграммы Возвращает коллекцию диаграмм, которые являются частью листа.
delete() Удаляет лист из книги.
getCell(row: number, column: number) Возвращает объект, Range содержащий одну ячейку на основе номеров строк и столбцов.
getRange(address?: string) Range Возвращает объект , представляющий один прямоугольный блок ячеек, заданный адресом или именем.
id Возвращает значение, однозначно идентифицирующее лист в данной книге.
name Отображаемое имя листа.
position Положение листа (начиная с нуля) в книге.
Таблицы Коллекция таблиц, имеющихся на листе.
Видимость Видимость листа.
WorksheetCollection add(name?: string) Добавляет новый лист в книгу.
getActiveWorksheet() Получает текущий активный лист в книге.
getItem(key: string) Получает объект листа по его имени или ИД.
items Получает загруженные дочерние элементы в этой коллекции.

См. также