Набор обязательных элементов API JavaScript для Excel 1,1Excel JavaScript API requirement set 1.1

API JavaScript для Excel 1,1 — это первая версия API.Excel JavaScript API 1.1 is the first version of the API. Это единственный набор обязательных элементов Excel, поддерживаемый Excel 2016.It is the only Excel-specific requirement set supported by Excel 2016.

Список APIAPI list

В следующей таблице перечислены API в наборе обязательных элементов API JavaScript для Excel 1,1.The following table lists the APIs in Excel JavaScript API requirement set 1.1. Чтобы просмотреть справочную документацию по API для всех API, поддерживаемых в наборе обязательных элементов API JavaScript для Excel 1,1, обратитесь к разделам API Excel в наборе требований 1,1.To view API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.1, see Excel APIs in requirement set 1.1.

КлассClass ПоляFields ОписаниеDescription
ApplicationApplication Calculate (Калкулатионтипе: Excel. Калкулатионтипе)calculate(calculationType: Excel.CalculationType) Пересчитывает данные во всех открытых в текущий момент книгах Excel.Recalculate all currently opened workbooks in Excel.
КалкулатионмодеcalculationMode Возвращает режим вычислений, используемый в книге в соответствии с константами в Excel. Калкулатионмоде.Returns the calculation mode used in the workbook, as defined by the constants in Excel.CalculationMode. Возможные значения: Automatic, где Excel управляет пересчетом; AutomaticExceptTables, где Excel контролирует пересчет, но игнорирует изменения в таблицах; Manual, где выполняется расчет, когда пользователь запрашивает его.Possible values are: Automatic, where Excel controls recalculation; AutomaticExceptTables, where Excel controls recalculation but ignores changes in tables; Manual, where calculation is done when the user requests it.
BindingBinding getRange()getRange() Возвращает представленный привязкой диапазон. Если тип привязки неправильный, выдается ошибка.Returns the range represented by the binding. Will throw an error if binding is not of the correct type.
getTable()getTable() Возвращает представленную привязкой таблицу. Если тип привязки неправильный, выдается ошибка.Returns the table represented by the binding. Will throw an error if binding is not of the correct type.
getText()getText() Возвращает представленный привязкой текст.Returns the text represented by the binding. Если тип привязки неправильный, выдается ошибка.Will throw an error if binding is not of the correct type.
idid Представляет идентификатор привязки.Represents binding identifier. Только для чтения.Read-only.
typetype Возвращает тип привязки.Returns the type of the binding. Дополнительные сведения см. в статье Excel. BindingType.See Excel.BindingType for details. Только для чтения.Read-only.
BindingCollectionBindingCollection getItem(id: string)getItem(id: string) Возвращает объект привязки по идентификатору.Gets a binding object by ID.
getItemAt(index: number)getItemAt(index: number) Возвращает объект привязки с учетом его положения в массиве элементов.Gets a binding object based on its position in the items array.
countcount Возвращает число привязок в коллекции.Returns the number of bindings in the collection. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
ChartChart delete()delete() Удаляет объект диаграммы.Deletes the chart object.
heightheight Обозначает высоту объекта диаграммы (в пунктах).Represents the height, in points, of the chart object.
leftleft Расстояние в пунктах от левого края диаграммы до начала листа.The distance, in points, from the left side of the chart to the worksheet origin.
namename Обозначает имя объекта диаграммы.Represents the name of a chart object.
Axesaxes Представляет оси диаграммы.Represents chart axes. Только для чтения.Read-only.
dataLabelsdataLabels Представляет метки данных на диаграмме.Represents the datalabels on the chart. Только для чтения.Read-only.
formatformat Инкапсулирует свойства формата для области диаграммы.Encapsulates the format properties for the chart area. Только для чтения.Read-only.
спискомlegend Представляет условные обозначения для диаграммы.Represents the legend for the chart. Только для чтения.Read-only.
seriesseries Представляет один ряд данных или коллекцию рядов данных в диаграмме.Represents either a single series or collection of series in the chart. Только для чтения.Read-only.
заголовокtitle Представляет заголовок указанной диаграммы, включая его текст, видимость, положение и форматирование.Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. Только для чтения.Read-only.
setData (sourceData: Range, seriesBy?: Excel. Чартсериесби)setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy) Сбрасывает исходные данные для диаграммы.Resets the source data for the chart.
setPosition (startCell: строка | диапазона, endCell?: строка | диапазона)setPosition(startCell: Range | string, endCell?: Range | string) Располагает диаграмму относительно ячеек на листе.Positions the chart relative to cells on the worksheet.
toptop Представляет расстояние в пунктах от верхнего края объекта до верхнего края первой строки (на листе) или до верхнего края области диаграммы (на диаграмме).Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).
widthwidth Представляет ширину объекта диаграммы (в пунктах).Represents the width, in points, of the chart object.
ChartAreaFormatChartAreaFormat fillfill Представляет формат заливки объекта, включая сведения о форматировании фона.Represents the fill format of an object, which includes background formatting information. Только для чтения.Read-only.
fontfont Представляет атрибуты шрифта (имя, размер шрифта, цвет и т. д.) для текущего объекта.Represents the font attributes (font name, font size, color, etc.) for the current object. Только для чтения.Read-only.
ChartAxesChartAxes КатегоряксисcategoryAxis Представляет ось категорий на диаграмме.Represents the category axis in a chart. Только для чтения.Read-only.
СериесаксисseriesAxis Представляет ось ряда данных для объемной диаграммы.Represents the series axis of a 3-dimensional chart. Только для чтения.Read-only.
valueAxisvalueAxis Представляет ось значений для оси.Represents the value axis in an axis. Только для чтения.Read-only.
ChartAxisChartAxis majorUnitmajorUnit Обозначает интервал между двумя основными делениями. Можно указать в виде числового значения или пустой строки. Возвращаемое значение всегда является числом.Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.
maximummaximum Представляет максимальное значение на оси значений. Можно указать в виде числового значения или пустой строки (для автоматически заданных значений оси). Возвращаемое значение всегда является числом.Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
minimumminimum Представляет минимальное значение на оси значений. Ему можно присвоить числовое значение или пустую строку (для автоматически заданных значений оси). Всегда возвращает числовое значение.Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
minorUnitminorUnit Представляет интервал между двумя промежуточными делениями.Represents the interval between two minor tick marks. Его можно указать в виде числового значения или пустой строки (для автоматически заданных значений оси).Can be set to a numeric value or an empty string (for automatic axis values). Возвращаемое значение всегда является числом.The returned value is always a number.
formatformat Представляет форматирование объекта диаграммы, в том числе форматирование линий и шрифта.Represents the formatting of a chart object, which includes line and font formatting. Только для чтения.Read-only.
majorGridlinesmajorGridlines Возвращает объект линии сетки, который представляет основные линии сетки для указанной оси.Returns a Gridlines object that represents the major gridlines for the specified axis. Только для чтения.Read-only.
minorGridlinesminorGridlines Возвращает объект Gridlines, который представляет вспомогательные линии сетки для указанной оси.Returns a Gridlines object that represents the minor gridlines for the specified axis. Только для чтения.Read-only.
заголовокtitle Обозначает название оси.Represents the axis title. Только для чтения.Read-only.
ChartAxisFormatChartAxisFormat fontfont Представляет атрибуты шрифта (имя, размер шрифта, цвет и т. д.) для элемента оси диаграммы.Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Только для чтения.Read-only.
lineline Представляет форматирование линий диаграммы.Represents chart line formatting. Только для чтения.Read-only.
ChartAxisTitleChartAxisTitle formatformat Представляет форматирование для названия оси диаграммы.Represents the formatting of chart axis title. Только для чтения.Read-only.
texttext Обозначает название оси.Represents the axis title.
visiblevisible Логическое значение, которое определяет видимость названия оси.A boolean that specifies the visibility of an axis title.
ChartAxisTitleFormatChartAxisTitleFormat fontfont Представляет атрибуты шрифта, такие как имя шрифта, размер шрифта, цвет и т. д. объект заголовка оси диаграммы.Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Только для чтения.Read-only.
ChartCollectionChartCollection Добавить (тип: Excel. ChartType, sourceData: Range, seriesBy?: Excel. Чартсериесби)add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy) Создает диаграмму.Creates a new chart.
getItem(name: string)getItem(name: string) Возвращает диаграмму по ее имени.Gets a chart using its name. Если одно и то же имя принадлежит нескольким диаграммам, будет возвращена первая из них.If there are multiple charts with the same name, the first one will be returned.
getItemAt(index: number)getItemAt(index: number) Возвращает диаграмму с учетом ее положения в коллекции.Gets a chart based on its position in the collection.
countcount Возвращает количество диаграмм на листе.Returns the number of charts in the worksheet. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
ChartDataLabelFormatChartDataLabelFormat fillfill Представляет формат заливки для текущей метки данных диаграммы.Represents the fill format of the current chart data label. Только для чтения.Read-only.
fontfont Представляет атрибуты шрифта (имя, размер шрифта, цвет и т. д.) для подписи данных диаграммы.Represents the font attributes (font name, font size, color, etc.) for a chart data label. Только для чтения.Read-only.
ChartDataLabelsChartDataLabels positionposition Значение DataLabelPosition, которое представляет положение метки данных.DataLabelPosition value that represents the position of the data label. Дополнительные сведения см. в статье Excel. Чартдаталабелпоситион.See Excel.ChartDataLabelPosition for details.
formatformat Представляет формат меток данных диаграммы, включая форматирование заливки и шрифтов.Represents the format of chart data labels, which includes fill and font formatting. Только для чтения.Read-only.
символseparator Строка, представляющая разделитель, который используется для меток данных на диаграмме.String representing the separator used for the data labels on a chart.
showBubbleSizeshowBubbleSize Логическое значение, которое указывает, отображается ли размер пузырьков с метками данных.Boolean value representing if the data label bubble size is visible or not.
showCategoryNameshowCategoryName Логическое значение, которое указывает, отображается ли имя для категории меток данных.Boolean value representing if the data label category name is visible or not.
showLegendKeyshowLegendKey Логическое значение, которое указывает, отображаются ли условные обозначения для меток данных.Boolean value representing if the data label legend key is visible or not.
showPercentageshowPercentage Логическое значение, которое указывает, отображается ли процентное соотношение меток данных.Boolean value representing if the data label percentage is visible or not.
showSeriesNameshowSeriesName Логическое значение, которое указывает, отображается ли имя ряда для меток данных.Boolean value representing if the data label series name is visible or not.
showValueshowValue Логическое значение, которое указывает, отображается ли значение метки данных.Boolean value representing if the data label value is visible or not.
ChartFillChartFill clear()clear() Очищает цвет заливки элемента диаграммы.Clear the fill color of a chart element.
setSolidColor(color: string)setSolidColor(color: string) Устанавливает форматирование заливки элемента диаграммы на единый цвет.Sets the fill formatting of a chart element to a uniform color.
ChartFontChartFont boldbold Указывает, является ли шрифт полужирным.Represents the bold status of font.
colorcolor HTML-код цвета текста.HTML color code representation of the text color. Например,E.g. #FF0000 обозначает красный.#FF0000 represents Red.
italicitalic Указывает, применяется ли курсив.Represents the italic status of the font.
namename Имя шрифта (например, Calibri)Font name (e.g. "Calibri")
sizesize Размер шрифта (например, 11)Size of the font (e.g. 11)
underlineunderline Тип подчеркивания, применяемый для шрифта.Type of underline applied to the font. Дополнительные сведения см. в статье Excel. Чартундерлинестиле.See Excel.ChartUnderlineStyle for details.
ChartGridlinesChartGridlines formatformat Представляет форматирование линий сетки диаграммы.Represents the formatting of chart gridlines. Только для чтения.Read-only.
visiblevisible Логическое значение, определяющее, отображаются ли линии сетки оси.Boolean value representing if the axis gridlines are visible or not.
ChartGridlinesFormatChartGridlinesFormat lineline Представляет форматирование линий диаграммы.Represents chart line formatting. Только для чтения.Read-only.
ChartLegendChartLegend накладывающиесяoverlay Логическое значение, определяющее, должна ли легенда диаграммы перекрываться с основной частью диаграммы.Boolean value for whether the chart legend should overlap with the main body of the chart.
positionposition Представляет расположение легенды на диаграмме.Represents the position of the legend on the chart. Дополнительные сведения см. в статье Excel. Чартлежендпоситион.See Excel.ChartLegendPosition for details.
formatformat Представляет форматирование легенды диаграммы, включая заливку и шрифт.Represents the formatting of a chart legend, which includes fill and font formatting. Только для чтения.Read-only.
visiblevisible Логическое значение, представляющее видимость объекта ChartLegend.A boolean value the represents the visibility of a ChartLegend object.
ChartLegendFormatChartLegendFormat fillfill Представляет формат заливки объекта, включая сведения о форматировании фона.Represents the fill format of an object, which includes background formatting information. Только для чтения.Read-only.
fontfont Представляет атрибуты шрифта, такие как имя шрифта, размер шрифта, цвет и т. д., в условных обозначениях диаграммы.Represents the font attributes such as font name, font size, color, etc. of a chart legend. Только для чтения.Read-only.
ChartLineFormatChartLineFormat clear()clear() Очищает формат линий элемента диаграммы.Clear the line format of a chart element.
colorcolor HTML-код цвета, представляющий цвет линий в диаграмме.HTML color code representing the color of lines in the chart.
ChartPointChartPoint formatformat Инкапсулирует свойства формата точки диаграммы.Encapsulates the format properties chart point. Только для чтения.Read-only.
valuevalue Возвращает значение точки диаграммы.Returns the value of a chart point. Только для чтения.Read-only.
ChartPointFormatChartPointFormat fillfill Представляет формат заливки диаграммы, включающий сведения о форматировании фона.Represents the fill format of a chart, which includes background formatting information. Только для чтения.Read-only.
ChartPointsCollectionChartPointsCollection getItemAt(index: number)getItemAt(index: number) Получение точки на основании ее положения в ряду.Retrieve a point based on its position within the series.
countcount Возвращает количество точек диаграммы в ряду.Returns the number of chart points in the series. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
ChartSeriesChartSeries namename Представляет имя ряда в диаграмме.Represents the name of a series in a chart.
formatformat Представляет форматирование ряда диаграммы, включая формат заливки и линий.Represents the formatting of a chart series, which includes fill and line formatting. Только для чтения.Read-only.
этапахpoints Представляет коллекцию всех точек в ряду.Represents a collection of all points in the series. Только для чтения.Read-only.
ChartSeriesCollectionChartSeriesCollection getItemAt(index: number)getItemAt(index: number) Возвращает ряд в зависимости от его позиции в коллекции.Retrieves a series based on its position in the collection.
countcount Возвращает число рядов в коллекции.Returns the number of series in the collection. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
ChartSeriesFormatChartSeriesFormat fillfill Представляет формат заливки ряда диаграммы, включая сведения о форматировании фона.Represents the fill format of a chart series, which includes background formatting information. Только для чтения.Read-only.
lineline Представляет форматирование линий.Represents line formatting. Только для чтения.Read-only.
ChartTitleChartTitle накладывающиесяoverlay Логическое значение, определяющее, отображается ли заголовок диаграммы поверх нее.Boolean value representing if the chart title will overlay the chart or not.
formatformat Представляет форматирование названия диаграммы, включая формат заливки и шрифта.Represents the formatting of a chart title, which includes fill and font formatting. Только для чтения.Read-only.
texttext Представляет текст заголовка диаграммы.Represents the title text of a chart.
visiblevisible Логическое значение, представляющее видимость объекта заголовка диаграммы.A boolean value the represents the visibility of a chart title object.
ChartTitleFormatChartTitleFormat fillfill Представляет формат заливки объекта, включая сведения о форматировании фона.Represents the fill format of an object, which includes background formatting information. Только для чтения.Read-only.
fontfont Представляет атрибуты шрифта (имя шрифта, размер шрифта, цвет и т. д.) для объекта.Represents the font attributes (font name, font size, color, etc.) for an object. Только для чтения.Read-only.
NamedItemNamedItem getRange()getRange() Возвращает объект диапазона, связанный с именем.Returns the range object that is associated with the name. Выдает ошибку, если именованный элемент не является диапазоном.Throws an error if the named item's type is not a range.
namename Имя объекта.The name of the object. Только для чтения.Read-only.
typetype Указывает тип значения, возвращаемый формулой имени.Indicates the type of the value returned by the name's formula. Дополнительные сведения см. в статье Excel. Намедитемтипе.See Excel.NamedItemType for details. Только для чтения.Read-only.
valuevalue Представляет значение, вычисленное по формуле имени.Represents the value computed by the name's formula. Если задан именованный диапазон, возвращается адрес диапазона.For a named range, will return the range address. Только для чтения.Read-only.
visiblevisible Определяет, является ли объект видимым.Specifies whether the object is visible or not.
NamedItemCollectionNamedItemCollection getItem(name: string)getItem(name: string) Возвращает объект NamedItem, используя его имя.Gets a NamedItem object using its name.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
RangeRange clear(applyTo?: Excel.ClearApplyTo)clear(applyTo?: Excel.ClearApplyTo) Очищает значения, формат, заливку, границу диапазона и т. д.Clear range values, format, fill, border, etc.
Delete (Shift: Excel. Делетешифтдиректион)delete(shift: Excel.DeleteShiftDirection) Удаляет ячейки, связанные с диапазоном.Deletes the cells associated with the range.
formulasformulas Представляет формулу в формате A1.Represents the formula in A1-style notation.
formulasLocalformulasLocal Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке.Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German.
getBoundingRect (anotherRange: строка | Range)getBoundingRect(anotherRange: Range | string) Возвращает наименьший объект диапазона, включающий в себя заданные диапазоны.Gets the smallest range object that encompasses the given ranges. Например, GetBoundingRect для "B2:C5" и "D10:E15" возвращает значение "B2:E15".For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E15".
getCell(row: number, column: number)getCell(row: number, column: number) Получает объект диапазона, содержащий одну ячейку, по номеру строки и столбца.Gets the range object containing the single cell based on row and column numbers. Ячейка может находиться вне границ родительского диапазона, пока она остается в сетке листа.The cell can be outside the bounds of its parent range, so long as it stays within the worksheet grid. Возвращаемая ячейка располагается относительно верхней левой ячейки диапазона.The returned cell is located relative to the top left cell of the range.
getColumn(column: number)getColumn(column: number) Возвращает столбец в диапазоне.Gets a column contained in the range.
getEntireColumn()getEntireColumn() Получает объект, представляющий весь столбец диапазона (например, если текущий диапазон представляет ячейки "B4: E11", а getEntireColumn — диапазон, представляющий столбцы "б:е").Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its getEntireColumn is a range that represents columns "B:E").
getEntireRow()getEntireRow() Получает объект, представляющий всю строку диапазона (например, если текущий диапазон представляет ячейки "B4: E11", а GetEntireRow — диапазон, представляющий строки "4:11").Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", its GetEntireRow is a range that represents rows "4:11").
пересечение (anotherRange: строка | Range)getIntersection(anotherRange: Range | string) Возвращает объект диапазона, представляющий собой прямоугольное пересечение заданных диапазонов.Gets the range object that represents the rectangular intersection of the given ranges.
Жетластцелл ()getLastCell() Возвращает последнюю ячейку в диапазоне. Например, последняя ячейка диапазона B2:D5 — D5.Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5".
Жетластколумн ()getLastColumn() Возвращает последний столбец в диапазоне. Например, последний столбец диапазона B2:D5 — D2:D5.Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5".
Жетластров ()getLastRow() Возвращает последнюю строку в диапазоне. Например, последняя строка в диапазоне "B2:D5" — "B5:D5".Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5".
getOffsetRange(rowOffset: number, columnOffset: number)getOffsetRange(rowOffset: number, columnOffset: number) Возвращает объект, представляющий диапазон, который смещен от указанного диапазона. Измерение возвращаемого диапазона будет соответствовать этому диапазону. Если результирующий диапазон выходит за пределы таблицы листа, возникнет ошибка.Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an error will be thrown.
getRow(row: number)getRow(row: number) Возвращает строку из диапазона.Gets a row contained in the range.
INSERT (Shift: Excel. Инсертшифтдиректион)insert(shift: Excel.InsertShiftDirection) Вставляет ячейку или диапазон ячеек на лист вместо этого диапазона, а также сдвигает другие ячейки, чтобы освободить место. Возвращает новый объект Range в пустом месте.Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space.
numberFormatnumberFormat Представляет код числового формата Excel для заданного диапазона.Represents Excel's number format code for the given range.
addressaddress Представляет ссылку на диапазон в стиле A1.Represents the range reference in A1-style. Значение Address будет содержать ссылку на лист (например, "Лист1! A1: B4).Address value will contain the Sheet reference (e.g. "Sheet1!A1:B4"). Только для чтения.Read-only.
addressLocaladdressLocal Представляет ссылку на указанный диапазон на языке пользователя.Represents range reference for the specified range in the language of the user. Только для чтения.Read-only.
cellCountcellCount Количество ячеек в диапазоне.Number of cells in the range. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). Только для чтения.Read-only.
ЧислоcolumnCount Представляет общее количество столбцов в диапазоне.Represents the total number of columns in the range. Только для чтения.Read-only.
columnIndexcolumnIndex Представляет номер столбца первой ячейки диапазона.Represents the column number of the first cell in the range. Используется нулевой индекс.Zero-indexed. Только для чтения.Read-only.
formatformat Возвращает объект формата, в который включены шрифт, заливка, границы, выравнивание и другие свойства диапазона.Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Только для чтения.Read-only.
СтроrowCount Возвращает общее количество строк в диапазоне.Returns the total number of rows in the range. Только для чтения.Read-only.
rowIndexrowIndex Возвращает номер строки первой ячейки диапазона.Returns the row number of the first cell in the range. Используется нулевой индекс.Zero-indexed. Только для чтения.Read-only.
texttext Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API. Только для чтения.Text values of the specified range. The Text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. Read-only.
valueTypesvalueTypes Представляет тип данных каждой ячейки.Represents the type of data of each cell. Только для чтения.Read-only.
worksheetworksheet Лист, содержащий текущий диапазон.The worksheet containing the current range. Только для чтения.Read-only.
select()select() Выбирает указанный диапазон в пользовательском интерфейсе Excel.Selects the specified range in the Excel UI.
valuesvalues Представляет необработанные значения указанного диапазона.Represents the raw values of the specified range. Могут возвращаться строковые и числовые данные, а также логические значения.The data returned could be of type string, number, or a boolean. Ячейки, содержащие ошибку, вернут строку ошибки.Cells that contain an error will return the error string.
RangeBorderRangeBorder colorcolor HTML-код, представляющий цвет линии границы в виде #RRGGBB (например, FFA500) или в виде ключевого слова (например, orange).HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
СидеиндексsideIndex Постоянное значение, указывающее определенную сторону границы.Constant value that indicates the specific side of the border. Дополнительные сведения см. в статье Excel. Бордериндекс.See Excel.BorderIndex for details. Только для чтения.Read-only.
stylestyle Одна из констант стиля линии, определяющая стиль линии границы.One of the constants of line style specifying the line style for the border. Дополнительные сведения см. в статье Excel. Бордерлинестиле.See Excel.BorderLineStyle for details.
weightweight Определяет толщину границы вокруг диапазона.Specifies the weight of the border around a range. Дополнительные сведения см. в статье Excel. Бордервеигхт.See Excel.BorderWeight for details.
RangeBorderCollectionRangeBorderCollection GetItem (index: Excel. Бордериндекс)getItem(index: Excel.BorderIndex) Возвращает объект границы по его имени.Gets a border object using its name.
getItemAt(index: number)getItemAt(index: number) Возвращает объект границы по его индексу.Gets a border object using its index.
countcount Количество объектов границы в коллекции.Number of border objects in the collection. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
RangeFillRangeFill clear()clear() Сброс фона диапазона.Resets the range background.
colorcolor HTML-код, представляющий цвет линии границы в виде #RRGGBB (например, FFA500) или в виде ключевого слова в HTML (например, orange).HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")
RangeFontRangeFont boldbold Указывает, является ли шрифт полужирным.Represents the bold status of font.
colorcolor HTML-код цвета текста.HTML color code representation of the text color. Например,E.g. #FF0000 обозначает красный.#FF0000 represents Red.
italicitalic Указывает, применяется ли курсив.Represents the italic status of the font.
namename Имя шрифта (например, Calibri)Font name (e.g. "Calibri")
sizesize размер шрифтаFont size.
underlineunderline Тип подчеркивания, применяемый для шрифта.Type of underline applied to the font. Дополнительные сведения см. в статье Excel. Ранжеундерлинестиле.See Excel.RangeUnderlineStyle for details.
RangeFormatRangeFormat horizontalAlignmenthorizontalAlignment Представляет выравнивание по горизонтали для указанного объекта.Represents the horizontal alignment for the specified object. Дополнительные сведения см. в статье Excel. HorizontalAlignment.See Excel.HorizontalAlignment for details.
bordersborders Коллекция объектов границ, которые применяются ко всему диапазону.Collection of border objects that apply to the overall range. Только для чтения.Read-only.
fillfill Возвращает объект заливки, определенный для всего диапазона.Returns the fill object defined on the overall range. Только для чтения.Read-only.
fontfont Возвращает объект шрифта, определенный для всего диапазона.Returns the font object defined on the overall range. Только для чтения.Read-only.
verticalAlignmentverticalAlignment Представляет выравнивание по вертикали для указанного объекта.Represents the vertical alignment for the specified object. Дополнительные сведения см. в статье Excel. VerticalAlignment.See Excel.VerticalAlignment for details.
wrapTextwrapText Указывает, использует ли Excel обтекание текстом для объекта.Indicates if Excel wraps the text in the object. Значение null указывает, что для диапазона в целом не применяется согласованный параметр обтекания.A null value indicates that the entire range doesn't have uniform wrap setting
TableTable delete()delete() Удаляет таблицу.Deletes the table.
Жетдатабодиранже ()getDataBodyRange() Получает объект диапазона, связанный с телом данных таблицы.Gets the range object associated with the data body of the table.
Жесеадерровранже ()getHeaderRowRange() Получает объект диапазона, связанный со строкой заголовков таблицы.Gets the range object associated with header row of the table.
getRange()getRange() Получает объект диапазона, связанный со всей таблицей.Gets the range object associated with the entire table.
Жеттоталровранже ()getTotalRowRange() Получает объект диапазона, связанный со строкой итогов таблицы.Gets the range object associated with totals row of the table.
namename Имя таблицы.Name of the table.
столбцыcolumns Представляет коллекцию всех столбцов в таблице.Represents a collection of all the columns in the table. Только для чтения.Read-only.
idid Возвращает значение, однозначно идентифицирующее таблицу в данной книге. Значение идентификатора остается прежним, даже если переименовать таблицу. Только для чтения.Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. Read-only.
строкиrows Представляет коллекцию всех строк в таблице.Represents a collection of all the rows in the table. Только для чтения.Read-only.
ШовхеадерсshowHeaders Указывает, отображается ли строка заголовков.Indicates whether the header row is visible or not. Можно задать это значение, чтобы отобразить или скрыть строку заголовков.This value can be set to show or remove the header row.
ШовтоталсshowTotals Указывает, отображается ли строка итогов.Indicates whether the total row is visible or not. Можно задать это значение, чтобы отобразить или скрыть строку итогов.This value can be set to show or remove the total row.
stylestyle Постоянное значение, представляющее стиль таблицы. Возможные значения: от TableStyleLight1 до TableStyleLight21, от TableStyleMedium1 до TableStyleMedium28, от TableStyleStyleDark1 до TableStyleStyleDark11. Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.
TableCollectionTableCollection Add (Address: строка | диапазона, hasHeaders: Boolean)add(address: Range | string, hasHeaders: boolean) Создание таблицы. Объект или исходный адрес диапазона определяет лист, на который будет добавлена таблица. Если добавить таблицу не удается (например, если адрес недействителен или одна таблица будет перекрываться другой), выводится сообщение об ошибке.Create a new table. The range object or source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown.
getItem(key: string)getItem(key: string) Получает таблицу по имени или идентификатору.Gets a table by Name or ID.
getItemAt(index: number)getItemAt(index: number) Получает таблицу на основании ее позиции в коллекции.Gets a table based on its position in the collection.
countcount Возвращает количество таблиц в книге.Returns the number of tables in the workbook. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
TableColumnTableColumn delete()delete() Удаляет столбец из таблицы.Deletes the column from the table.
Жетдатабодиранже ()getDataBodyRange() Получает объект диапазона, связанный с текстом данных столбца.Gets the range object associated with the data body of the column.
Жесеадерровранже ()getHeaderRowRange() Получает объект диапазона, связанный со строкой заголовков столбца.Gets the range object associated with the header row of the column.
getRange()getRange() Получает объект диапазона, связанный со всем столбцом.Gets the range object associated with the entire column.
Жеттоталровранже ()getTotalRowRange() Получает объект диапазона, связанный со строкой итогов столбца.Gets the range object associated with the totals row of the column.
namename Представляет имя столбца таблицы.Represents the name of the table column.
idid Возвращает уникальный ключ, идентифицирующий столбец в таблице.Returns a unique key that identifies the column within the table. Только для чтения.Read-only.
индексindex Возвращает номер индекса столбца в коллекции столбцов таблицы.Returns the index number of the column within the columns collection of the table. Используется нулевой индекс.Zero-indexed. Только для чтения.Read-only.
valuesvalues Представляет необработанные значения указанного диапазона.Represents the raw values of the specified range. Могут возвращаться строковые и числовые данные, а также логические значения.The data returned could be of type string, number, or a boolean. Ячейки, содержащие ошибку, вернут строку ошибки.Cells that contain an error will return the error string.
TableColumnCollectionTableColumnCollection Add (index?: число, Values?: массив<массив<логический | номер | строки>> | логический | номер | строки, Name?: строка)add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string) Добавляет новый столбец в таблицу.Adds a new column to the table.
GetItem (ключ: число | строка)getItem(key: number | string) Возвращает объект column по имени или идентификатору.Gets a column object by Name or ID.
getItemAt(index: number)getItemAt(index: number) Возвращает столбец на основании его позиции в коллекции.Gets a column based on its position in the collection.
countcount Возвращает количество столбцов в таблице.Returns the number of columns in the table. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
TableRowTableRow delete()delete() Удаляет строку из таблицы.Deletes the row from the table.
getRange()getRange() Получает объект диапазона, связанный со всей строкой.Returns the range object associated with the entire row.
индексindex Возвращает номер индекса строки в коллекции строк таблицы.Returns the index number of the row within the rows collection of the table. Используется нулевой индекс.Zero-indexed. Только для чтения.Read-only.
valuesvalues Представляет необработанные значения указанного диапазона.Represents the raw values of the specified range. Могут возвращаться строковые и числовые данные, а также логические значения.The data returned could be of type string, number, or a boolean. Ячейки, содержащие ошибку, вернут строку ошибки.Cells that contain an error will return the error string.
TableRowCollectionTableRowCollection Add (index?: число, Values?: массив<массив<логический | номер | строки>> | логический | номер | строки)add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number) Добавляет одну или несколько строк в таблицу.Adds one or more rows to the table. Возвращается объект, находящийся над новыми строками.The return object will be the top of the newly added row(s).
getItemAt(index: number)getItemAt(index: number) Получает строку на основании ее позиции в коллекции.Gets a row based on its position in the collection.
countcount Возвращает количество строк в таблице.Returns the number of rows in the table. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
WorkbookWorkbook Функцией getselectedrange ()getSelectedRange() Получает текущий выделенный диапазон из книги.Gets the currently selected single range from the workbook. Если выбрано несколько диапазонов, этот метод выдаст ошибку.If there are multiple ranges selected, this method will throw an error.
applicationapplication Представляет экземпляр приложения Excel, который содержит эту книгу.Represents the Excel application instance that contains this workbook. Только для чтения.Read-only.
bindingsbindings Представляет коллекцию привязок, включенных в книгу.Represents a collection of bindings that are part of the workbook. Только для чтения.Read-only.
namesnames Представляет коллекцию именованных элементов в книге (именованные диапазоны и константы).Represents a collection of workbook scoped named items (named ranges and constants). Только для чтения.Read-only.
Tabletables Представляет коллекцию таблиц, сопоставленных с книгой.Represents a collection of tables associated with the workbook. Только для чтения.Read-only.
листовworksheets Представляет коллекцию листов, сопоставленных с книгой.Represents a collection of worksheets associated with the workbook. Только для чтения.Read-only.
WorksheetWorksheet activate()activate() Активация листа в пользовательском интерфейсе Excel.Activate the worksheet in the Excel UI.
delete()delete() Удаляет лист из книги.Deletes the worksheet from the workbook. Обратите внимание, что если для отображения листа задано значение "Верихидден", операция удаления завершится с помощью GeneralException.Note that if the worksheet's visibility is set to "VeryHidden", the delete operation will fail with a GeneralException.
getCell(row: number, column: number)getCell(row: number, column: number) Получает объект диапазона, содержащий одну ячейку, по номеру строки и столбца.Gets the range object containing the single cell based on row and column numbers. Ячейка может находиться вне границ родительского диапазона, пока она остается в сетке листа.The cell can be outside the bounds of its parent range, so long as it stays within the worksheet grid.
GetString (Address?: строка)getRange(address?: string) Получает объект Range, представляющий отдельный прямоугольный блок ячеек, заданный по адресу или имени.Gets the range object, representing a single rectangular block of cells, specified by the address or name.
namename Отображаемое имя листа.The display name of the worksheet.
positionposition Положение листа (начиная с нуля) в книге.The zero-based position of the worksheet within the workbook.
темпcharts Возвращает коллекцию диаграмм, имеющихся на листе.Returns collection of charts that are part of the worksheet. Только для чтения.Read-only.
idid Возвращает значение, однозначно идентифицирующее лист в данной книге. Значение идентификатора остается прежним, даже если переименовать или переместить лист. Только для чтения.Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only.
Tabletables Коллекция таблиц, имеющихся на листе.Collection of tables that are part of the worksheet. Только для чтения.Read-only.
доступностиvisibility Видимость листа.The Visibility of the worksheet.
WorksheetCollectionWorksheetCollection Добавить (имя?: строка)add(name?: string) Добавляет новый лист в книгу. Лист будет добавлен в конец набора имеющихся листов. Если вы хотите активировать только что добавленный лист, вызовите команду .activate().Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call ".activate() on it.
Жетактивеворкшит ()getActiveWorksheet() Получает текущий активный лист в книге.Gets the currently active worksheet in the workbook.
getItem(key: string)getItem(key: string) Получает объект листа по его имени или ИД.Gets a worksheet object using its Name or ID.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.

См. такжеSee also