Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы
Редакторы
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
Команда
Команда
Мобильные редакторы
Мобильные редакторы
Облачный офис
Облачный офис
Почта
Почта
Органайзер
Органайзер
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

Справочник методов класса Api таблиц

Обновлено: 17.12.25

new Api()

Базовый класс.

Настройки

Название Тип Описание
Sheets Array Возвращает коллекцию листов, представляющую все листы активной книги.
ActiveSheet ApiWorksheet Возвращает объект, представляющий активный лист.
Selection ApiRange Возвращает объект, представляющий выбранный диапазон.
Comments Array. Возвращает массив объектов ApiComment.

Методы

Название Описание
AddDefName ↗ Добавляет новое имя в диапазон ячеек.
AddSheet ↗ Создает новый рабочий лист. Новый рабочий лист становится активным.
attachEvent ↗ Подписывается на указанное событие и вызывает функцию обратного вызова при возникновении события.
CreateBlipFill ↗ Создает заливку для применения к объекту, используя выбранное изображение в качестве фона объекта.
CreateBullet ↗ Создает маркер для абзаца с символом, указанным в параметре sSymbol.
CreateColorByName ↗ Создает цвет, выбирая его из одной из доступных цветовых настроек.
CreateColorFromRGB ↗ Создает цвет RGB, устанавливая соответствующие значения для компонентов красного, зеленого и синего цвета.
CreateGradientStop ↗ Создает ограничитель градиента, используемый для различных типов градиентов.
CreateLinearGradientFill ↗ Создает заливку линейным градиентом для применения к объекту, используя выбранный линейный градиент в качестве фона объекта.
CreateNewHistoryPoint ↗ Создает новую точку истории.
CreateNoFill ↗ Не создает заливку и удаляет заливку из элемента.
CreateNumbering ↗ Создает маркер для абзаца с символом или символом нумерации, указанным в параметре sType.
CreateParagraph ↗ Создает новый абзац.
CreatePatternFill ↗ Создает заливку узором для применения к объекту, используя выбранный узор в качестве фона объекта.
CreatePresetColor ↗ Создает цвет, выбирая его из одной из доступных цветовых настроек.
CreateRadialGradientFill ↗ Создает заливку радиальным градиентом для применения к объекту, используя выбранный радиальный градиент в качестве фона объекта.
CreateRGBColor ↗ Создает цвет RGB, устанавливая соответствующие значения для компонентов красного, зеленого и синего цвета.
CreateRun ↗ Создает новый текстовый блок меньшего размера для вставки в текущий абзац или таблицу.
CreateSchemeColor ↗ Создает сложную цветовую схему, выбирая одну из доступных схем.
CreateSolidFill ↗ Создает сплошную заливку для применения к объекту с использованием выбранного сплошного цвета в качестве фона объекта.
CreateStroke ↗ Создает обводку, добавляющую тени к элементу.
CreateTextPr ↗ Создает пустые текстовые свойства.
detachEvent ↗ Отменяет подписку на указанное событие.
Format ↗ Возвращает класс, отформатированный в соответствии с инструкциями, содержащимися в выражении формата.
GetActiveSheet ↗ Возвращает объект, представляющий активный лист.
GetComments ↗ Возвращает массив объектов ApiComment ↗.
GetDefName ↗ Возвращает объект ApiName по имени диапазона.
GetFullName ↗ Возвращает полное имя открытого в данный момент файла.
GetLocale ↗ Возвращает текущий идентификатор локали.
GetMailMergeData ↗ Возвращает данные слияния почты.
GetRange ↗ Возвращает объект ApiRange по ссылке на диапазон.
GetRangeByNumber ↗ Возвращает объект, который представляет диапазон указанного листа, используя максимальные и минимальные координаты строки/столбца.
GetSelection ↗ Возвращает объект, представляющий выбранный диапазон.
GetSheet ↗ Возвращает объект, представляющий лист.
GetSheets ↗ Возвращает коллекцию листов, представляющую все листы активной книги.
GetThemesColors ↗ Возвращает список всех доступных цветов темы для электронной таблицы.
Intersect ↗ Возвращает объект ApiRange, представляющий прямоугольное пересечение двух или более диапазонов. Если указаны один или несколько диапазонов из другого листа, будет возвращена ошибка.
RecalculateAllFormulas ↗ Пересчитывает все формулы в активной книге.
ReplaceTextSmart ↗ Заменяет каждый абзац (или текст в ячейке) в выделенном фрагменте соответствующим текстом из массива строк.
Save ↗ Сохраняет изменения в указанном документе.
SetLocale ↗ Устанавливает локаль для документа.
SetThemeColors ↗ Устанавливает цвета темы для текущей электронной таблицы.

События

Название Описание
onWorksheetChange ↗ Функция обратного вызова, которая вызывается при изменении указанного диапазона текущего листа.
Обратите внимание, что событие не вызывается для операций отмены/повтора.

Пример

builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFillColor = Api.CreateColorFromRGB(201, 222, 255);
oWorksheet.GetRange("A1:M6").SetFillColor(oFillColor);
oWorksheet.GetRange("A1:M6").SetBold(true);
oWorksheet.GetRange("A7:A11").SetBold(true);
oWorksheet.GetRange("A21:M22").SetFillColor(oFillColor);

oFillColor = Api.CreateColorFromRGB(232, 240, 252);
oWorksheet.GetRange("A1").SetColumnWidth(14);
oWorksheet.GetRange("B1:M1").SetColumnWidth(7);
oWorksheet.GetRange("A1:A4").SetRowHeight(27);
var oImage = oWorksheet.AddImage("https://TEST_URL/examples/api-cell.png", 28 * 36000, 28 * 36000, 5, 0, 0, 0);

var oRange = oWorksheet.GetRange("C4:J4");
oRange.Merge(false);
oRange.SetValue("Annual Results");
oRange.SetFontSize(24);
oRange = oWorksheet.GetRange("C5:J5");
oRange.Merge(false);
oRange.SetValue("(in thousands of USD)");
oRange.SetFontSize(12);
oRange = oWorksheet.GetRange("C4:J5");
oRange.SetAlignHorizontal("center");
oRange.SetFontColor(Api.CreateColorFromRGB(64, 135, 247));
oRange.SetBorders("Top", "Thick", Api.CreateColorFromRGB(64, 135, 247));
oWorksheet.GetRange("A4:M5").SetBorders("Bottom", "Thick", Api.CreateColorFromRGB(64, 135, 247));

for (var i = 8; i <= 10; i++) {
if (i%2 === 0) {
oRange = oWorksheet.GetRange(`A${i}:M${i}`);
oRange.SetFillColor(oFillColor);
}
}

oWorksheet.GetRange("A6:M10").SetValue([
["City/Month", "Jan", "Feb", "Mar", "Apr", "May", "June", "July", "Aug", "Sept", "Oct", "Nov", "Dec"],
["Beijing", 361.06, 484.37, 318.96, 230.41, 219.15, 229.92, 431.04, 224.24, 396.48, 373.76, 361.06, 419.46],
["Jinan", 382.77, 375.40, 439.87, 238.76, 138.84, 240.92, 388.12, 299.67, 326.89, 379.88, 382.77, 481.45],
["Haujou", 348.05, 399.41, 303.55, 311.43, 148.70, 219.52, 450.96, 270.40, 371.74, 378.89, 348.05, 501.98],
["Macau", 354.52, 366.52, 342.87, 382.48, 222.50, 304.50, 388.09, 233.51, 346.43, 392.74, 354.52, 468.08],
]);

oWorksheet.GetRange("B6:M10").SetAlignHorizontal("center");
oWorksheet.GetRange("B6:M10").SetNumberFormat("$#,##0");

oWorksheet.GetRange("G11:I15").SetValue([
["","=B6","=M6"],
["=A7","=B7","=M7"],
["=A8","=B8","=M8"],
["=A9","=B9","=M9"],
["=A10","=B10","=M10"]
]);

var sheetName = oWorksheet.GetName();
oWorksheet.GetRange("G11:I15").SetNumberFormat("$#,##0");
var oChart = oWorksheet.AddChart(`'${sheetName}'!$A$6:$M$10`, true, "lineNormal", 1, 100 * 36000, 50 * 36000, 0, 0, 10, 0);
oChart.SetTitle("Financial Overview (in thousands of USD)", 10);
oChart.SetLegendPos("left");

oChart = oWorksheet.AddChart(`'${sheetName}'!$G$11:$I$15`, true, "bar", 2, 100 * 36000, 50 * 36000, 6, 0, 10, 0);
oChart.SetTitle("Year start VS Year End (in thousands of USD)", 10);
oChart.SetLegendPos("left");
Api.Save();
builder.SaveFile("xlsx", "Api.xlsx");
builder.CloseFile();