Новые возможности API JavaScript 1.9 для Excel
С набором обязательных элементов 1.9 добавлено более 500 новых API Excel. В первой таблице представлен краткий обзор API, а в последующей таблице приведен подробный список.
Функциональная область | Описание | Соответствующие объекты |
---|---|---|
Фигуры | Вставка, размещение и форматирование изображений, геометрических фигур и текстовых полей. | ShapeCollectionShapeGeometricShapeImage |
Автофильтр | Добавление фильтров к диапазонам. | AutoFilter |
Области | Поддержка несплошных диапазонов. | RangeAreas |
Специальные ячейки | Получение ячеек, содержащих даты, примечания или формулы в диапазоне. | Range |
Поиск | Поиск значений или формул в диапазоне или листе. | RangeWorksheet |
Копирование и вставка | Копирование значений, форматов и формул из одного диапазона в другой. | Range |
Вычисление | Улучшенное управление модулем вычислений Excel. | Application |
Новые диаграммы | Познакомьтесь с новыми поддерживаемыми типами диаграмм: с картами, ящик с усами, каскадная, солнечные лучи, диаграмма Парето и воронка. | Chart |
Формат диапазона | Новые возможности для форматирования диапазонов. | Range |
Список API
В следующей таблице перечислены API в наборе обязательных api JavaScript для Excel 1.9. Справочную документацию по API для всех API, поддерживаемых набором обязательных api JavaScript для Excel 1.9 или более ранней версии, см. в статье Api Excel в наборе требований 1.9 или более ранней версии.
Класс | Поля | Описание |
---|---|---|
Application | calculationEngineVersion | Возвращает версию модуля вычислений Excel, использованного для последнего полного пересчета. |
calculationState | Возвращает состояние вычисления приложения. | |
iterativeCalculation | Возвращает параметры итеративного вычисления. | |
suspendScreenUpdatingUntilNextSync() | Приостанавливает обновление экрана до вызова следующего context.sync() . |
|
AutoFilter | apply(range: Range | string, columnIndex?: number, criteria?: Excel.FilterCriteria) | Применяет автофильтр к диапазону. |
clearCriteria() | Очищает критерии фильтра и состояние сортировки автофильтра. | |
criteria | Массив, содержащий все условия фильтрации в диапазоне с примененным автофильтром. | |
enabled | Указывает, включен ли автофильтр. | |
getRange() |
Range Возвращает объект , представляющий диапазон, к которому применяется автофильтр. |
|
getRangeOrNullObject() |
Range Возвращает объект , представляющий диапазон, к которому применяется автофильтр. |
|
isDataFiltered | Указывает, имеет ли автофильтр критерии фильтра. | |
reapply() | Применяет указанный объект AutoFilter в данный момент к диапазону. | |
remove() | Удаляет автофильтр из диапазона. | |
CellBorder | color | Представляет свойство color одинарной границы. |
style | Представляет свойство style одинарной границы. |
|
tintAndShade | Представляет свойство tintAndShade одинарной границы. |
|
weight | Представляет свойство weight одинарной границы. |
|
CellBorderCollection | bottom | Представляет свойство format.borders.bottom . |
diagonalDown | Представляет свойство format.borders.diagonalDown . |
|
diagonalUp | Представляет свойство format.borders.diagonalUp . |
|
horizontal | Представляет свойство format.borders.horizontal . |
|
left | Представляет свойство format.borders.left . |
|
right | Представляет свойство format.borders.right . |
|
top | Представляет свойство format.borders.top . |
|
vertical | Представляет свойство format.borders.vertical . |
|
CellProperties | address | Представляет свойство address . |
addressLocal | Представляет свойство addressLocal . |
|
hidden | Представляет свойство hidden . |
|
CellPropertiesFill | color | Представляет свойство format.fill.color . |
pattern | Представляет свойство format.fill.pattern . |
|
patternColor | Представляет свойство format.fill.patternColor . |
|
patternTintAndShade | Представляет свойство format.fill.patternTintAndShade . |
|
tintAndShade | Представляет свойство format.fill.tintAndShade . |
|
CellPropertiesFont | bold | Представляет свойство format.font.bold . |
color | Представляет свойство format.font.color . |
|
italic | Представляет свойство format.font.italic . |
|
name | Представляет свойство format.font.name . |
|
size | Представляет свойство format.font.size . |
|
strikethrough | Представляет свойство format.font.strikethrough . |
|
subscript | Представляет свойство format.font.subscript . |
|
superscript | Представляет свойство format.font.superscript . |
|
tintAndShade | Представляет свойство format.font.tintAndShade . |
|
underline | Представляет свойство format.font.underline . |
|
CellPropertiesFormat | autoIndent | Представляет свойство autoIndent . |
borders | Представляет свойство borders . |
|
fill | Представляет свойство fill . |
|
font | Представляет свойство font . |
|
horizontalAlignment | Представляет свойство horizontalAlignment . |
|
indentLevel | Представляет свойство indentLevel . |
|
protection | Представляет свойство protection . |
|
readingOrder | Представляет свойство readingOrder . |
|
shrinkToFit | Представляет свойство shrinkToFit . |
|
textOrientation | Представляет свойство textOrientation . |
|
useStandardHeight | Представляет свойство useStandardHeight . |
|
useStandardWidth | Представляет свойство useStandardWidth . |
|
verticalAlignment | Представляет свойство verticalAlignment . |
|
wrapText | Представляет свойство wrapText . |
|
CellPropertiesProtection | formulaHidden | Представляет свойство format.protection.formulaHidden . |
locked | Представляет свойство format.protection.locked . |
|
ChangedEventDetail | valueAfter | Представляет значение после изменения. |
valueBefore | Представляет значение перед изменением. | |
valueTypeAfter | Представляет тип значения после изменения. | |
valueTypeBefore | Представляет тип значения перед изменением. | |
Chart | activate() | Активирует диаграмму в пользовательском интерфейсе Excel. |
pivotOptions | Объединяет параметры для сводной диаграммы. | |
ChartAreaFormat | colorScheme | Задает цветовую схему диаграммы. |
roundedCorners | Указывает, имеет ли область диаграммы скругленные углы. | |
ChartAxis | linkNumberFormat | Указывает, связан ли числовой формат с ячейками. |
ChartBinOptions | allowOverflow | Указывает, включено ли переполнение ячейки в гистограмме или диаграмме парето. |
allowUnderflow | Указывает, включен ли в гистограмме или диаграмме парето недополук ячейки. | |
count | Указывает количество ячеек гистограммы или диаграммы парето. | |
overflowValue | Задает значение переполнения ячейки гистограммы или диаграммы парето. | |
type | Указывает тип ячейки для гистограммы или диаграммы парето. | |
underflowValue | Задает значение нижнего потока ячейки гистограммы или диаграммы парето. | |
width | Задает значение ширины ячейки гистограммы или диаграммы парето. | |
ChartBoxwhiskerOptions | quartileCalculation | Указывает, является ли тип вычисления квартиль диаграммы с усами. |
showInnerPoints | Указывает, отображаются ли внутренние точки в прямоугольнике и диаграмме усов. | |
showMeanLine | Указывает, отображается ли средняя линия в прямоугольнике и диаграмме усов. | |
showMeanMarker | Указывает, отображается ли средний маркер в прямоугольнике и диаграмме усов. | |
showOutlierPoints | Указывает, отображаются ли точки выброса в прямоугольнике и диаграмме усов. | |
ChartDataLabel | linkNumberFormat | Указывает, связан ли числовой формат с ячейками (таким образом, числовой формат изменяется в метках при его изменении в ячейках). |
ChartDataLabels | linkNumberFormat | Указывает, связан ли числовой формат с ячейками. |
ChartErrorBars | endStyleCap | Указывает, имеют ли панели ошибок конечный заголовок стиля. |
format | Указывает тип форматирования планок погрешностей. | |
include | Указывает, какие части планок погрешностей нужно включить. | |
type | Тип диапазона, помеченного планками погрешностей. | |
visible | Указывает, отображаются ли полосы ошибок. | |
ChartErrorBarsFormat | line | Представляет форматирование линий диаграммы. |
ChartMapOptions | labelStrategy | Задает стратегию меток последовательной карты для диаграммы карты регионов. |
level | Задает уровень сопоставления рядов диаграммы карты регионов. | |
projectionType | Указывает тип проекции ряда диаграммы карты регионов. | |
ChartPivotOptions | showAxisFieldButtons | Указывает, должны ли отображаться кнопки поля оси на сводной диаграмме. |
showLegendFieldButtons | Указывает, должны ли отображаться кнопки поля легенды в сводной диаграмме. | |
showReportFilterFieldButtons | Указывает, должны ли отображаться кнопки поля фильтра отчета в сводной диаграмме. | |
showValueFieldButtons | Указывает, должны ли отображаться кнопки поля отображения значения в сводной диаграмме. | |
ChartSeries | binOptions | Объединяет параметры интервалов для гистограмм и диаграмм Парето. |
boxwhiskerOptions | Объединяет параметры для диаграмм "ящик с усами" | |
bubbleScale | Может быть целым числом от 0 (нуля) до 300, представляющим процентное значение от размера по умолчанию. | |
gradientMaximumColor | Задает цвет для максимального значения ряда диаграммы карты регионов. | |
gradientMaximumType | Задает тип максимального значения ряда диаграммы карты регионов. | |
gradientMaximumValue | Задает максимальное значение ряда диаграммы карты регионов. | |
gradientMidpointColor | Задает цвет для среднего значения ряда диаграмм карты регионов. | |
gradientMidpointType | Задает тип для среднего значения ряда диаграммы карты регионов. | |
gradientMidpointValue | Задает значение в середине ряда диаграммы карты регионов. | |
gradientMinimumColor | Задает цвет для минимального значения ряда диаграммы карты регионов. | |
gradientMinimumType | Указывает тип минимального значения ряда диаграмм карты региона. | |
gradientMinimumValue | Задает минимальное значение ряда диаграммы карты регионов. | |
gradientStyle | Задает стиль градиента ряда диаграммы карты регионов. | |
invertColor | Задает цвет заливки для отрицательных точек данных в ряде. | |
mapOptions | Объединяет параметры для диаграммы с картой региона. | |
parentLabelStrategy | Задает область стратегии родительской метки ряда для диаграммы дерева. | |
showConnectorLines | Указывает, отображаются ли линии соединителя в каскадных диаграммах. | |
showLeaderLines | Указывает, отображаются ли линии-лидеры для каждой метки данных в ряде. | |
splitValue | Задает пороговое значение, разделяющее две части круговой диаграммы или линейчатой диаграммы. | |
xErrorBars | Представляет объект планки погрешностей для ряда диаграммы. | |
yErrorBars | Представляет объект планки погрешностей для ряда диаграммы. | |
ChartTrendlineLabel | linkNumberFormat | Указывает, связан ли числовой формат с ячейками (таким образом, числовой формат изменяется в метках при его изменении в ячейках). |
ColumnProperties | address | Представляет свойство address . |
addressLocal | Представляет свойство addressLocal . |
|
columnIndex | Представляет свойство columnIndex . |
|
ConditionalFormat | getRanges() | Возвращает значение , состоящее RangeAreas из одного или нескольких прямоугольных диапазонов, к которым применяется кондитональный формат. |
DataValidation | getInvalidCells() | Возвращает объект, состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, с недопустимыми значениями ячеек. |
getInvalidCellsOrNullObject() | Возвращает объект, состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, с недопустимыми значениями ячеек. |
|
FilterCriteria | subField | Свойство, используемое фильтром для выполнения полнофункционированного фильтра по расширенным значениям. |
GeometricShape | id | Возвращает идентификатор фигуры. |
shape |
Shape Возвращает объект для геометрической фигуры. |
|
GroupShapeCollection | getCount() | Возвращает количество фигур в группе фигур. |
getItem(key: string) | Возвращает фигуру, используя ее имя или идентификатор. | |
getItemAt(index: number) | Получает фигуру на основе ее позиции в коллекции. | |
items | Получает загруженные дочерние элементы в этой коллекции. | |
HeaderFooter | centerFooter | Центральный нижний колонтитул листа. |
centerHeader | Центральный заголовок листа. | |
leftFooter | Левый нижний колонтитул листа. | |
leftHeader | Левый заголовок листа. | |
rightFooter | Правый нижний колонтитул листа. | |
rightHeader | Правый заголовок листа. | |
HeaderFooterGroup | defaultForAllPages | Общий колонтитул, используемый для всех страниц, если не указан колонтитул четных и нечетных страниц или первой страницы. |
evenPages | Колонтитул для четных страниц, для нечетных страниц нужно указывать отдельный колонтитул. | |
firstPage | Колонтитул первой страницы, для остальных страниц используется общий или четный и нечетный колонтитулы. | |
oddPages | Колонтитул для нечетных страниц, для четных страниц нужно указывать отдельный колонтитул. | |
state | Состояние, по которому задаются колонтитулы. | |
useSheetMargins | Получает или задает отметку, которая указывает, выровнены ли колонтитулы относительно полей страницы, установленных в параметрах макета страницы для листа. | |
useSheetScale | Получает или задает отметку, которая указывает, нужно ли масштабировать колонтитулы с помощью процентных значений, установленных в параметрах макета страницы для листа. | |
Image | format | Возвращает формат изображения. |
id | Задает идентификатор фигуры для объекта image. | |
shape | Возвращает объект, Shape связанный с изображением. |
|
IterativeCalculation | enabled | Значение true, если в Excel используется итерация для разрешения циклических ссылок. |
maxChange | Указывает максимальный объем изменений между каждой итерацией, так как Excel разрешает циклические ссылки. | |
maxIteration | Указывает максимальное количество итераций, которые Excel может использовать для разрешения циклической ссылки. | |
Line | beginArrowheadLength | Представляет длину наконечника в начале указанной линии. |
beginArrowheadStyle | Представляет стиль наконечника в начале указанной линии. | |
beginArrowheadWidth | Представляет ширину наконечника в начале указанной линии. | |
beginConnectedShape | Представляет фигуру, к которой привязано начало указанной линии. | |
beginConnectedSite | Представляет точку соединения, к которой привязано начало соединительной линии. | |
connectBeginShape(shape: Excel.Shape, connectionSite: number) | Привязывает начало указанного соединителя к указанной фигуре. | |
connectEndShape(shape: Excel.Shape, connectionSite: number) | Привязывает конец указанного соединителя к указанной фигуре. | |
connectorType | Представляет тип соединительной линии. | |
disconnectBeginShape() | Отвязывает начало указанного соединителя от фигуры. | |
disconnectEndShape() | Отвязывает конец указанного соединителя от фигуры. | |
endArrowheadLength | Представляет длину наконечника в конце указанной линии. | |
endArrowheadStyle | Представляет стиль наконечника в конце указанной линии. | |
endArrowheadWidth | Представляет ширину наконечника в конце указанной линии. | |
endConnectedShape | Представляет фигуру, к которой привязан конец указанной линии. | |
endConnectedSite | Представляет точку соединения, к которой привязан конец соединительной линии. | |
id | Указывает идентификатор фигуры. | |
isBeginConnected | Указывает, соединено ли начало указанной линии с фигурой. | |
isEndConnected | Указывает, связан ли конец указанной линии с фигурой. | |
shape | Возвращает объект, Shape связанный со строкой. |
|
PageBreak | columnIndex | Задает индекс столбца для разрыва страницы. |
delete() | Удаляет объект разрыва страницы. | |
getCellAfterBreak() | Получает первую ячейку после разрыва страницы. | |
rowIndex | Задает индекс строки для разрыва страницы. | |
PageBreakCollection | add(pageBreakRange: Range | string) | Добавляет разрыв страницы перед левой верхней ячейкой указанного диапазона. |
getCount() | Получает количество разрывов страниц в коллекции. | |
getItem(index: number) | Получает объект разрыва страницы по индексу. | |
items | Получает загруженные дочерние элементы в этой коллекции. | |
removePageBreaks() | Сбрасывает все добавленные вручную разрывы страниц в коллекции. | |
PageLayout | blackAndWhite | Параметр черно-белой печати листа. |
bottomMargin | Нижнее поле страницы листа, используемое для печати в точках. | |
centerHorizontally | Центр листа по горизонтали. | |
centerVertically | По центру листа по вертикали. | |
draftMode | Параметр режима черновика листа. | |
firstPageNumber | Номер первой страницы листа для печати. | |
footerMargin | Поле нижнего колонтитула листа (в пунктах) для использования при печати. | |
getPrintArea() | Возвращает объект , состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, который представляет область печати для листа. |
|
getPrintAreaOrNullObject() | Возвращает объект , состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, который представляет область печати для листа. |
|
getPrintTitleColumns() | Получает объект range, представляющий столбцы заголовков. | |
getPrintTitleColumnsOrNullObject() | Получает объект range, представляющий столбцы заголовков. | |
getPrintTitleRows() | Получает объект range, представляющий строки заголовков. | |
getPrintTitleRowsOrNullObject() | Получает объект range, представляющий строки заголовков. | |
headerMargin | Поле заголовка листа (в пунктах) для использования при печати. | |
headersFooters | Настройка колонтитулов для листа. | |
leftMargin | Левое поле листа (в пунктах) для использования при печати. | |
orientation | Ориентация листа страницы. | |
paperSize | Размер бумаги листа страницы. | |
printComments | Указывает, должны ли примечания листа отображаться при печати. | |
printErrors | Параметр ошибок печати листа. | |
printGridlines | Указывает, будут ли печататься линии сетки листа. | |
printHeadings | Указывает, будут ли печататься заголовки листа. | |
printOrder | Параметр порядка печати страницы листа. | |
rightMargin | Правое поле листа (в пунктах) для использования при печати. | |
setPrintArea(printArea: Range | RangeAreas | string) | Задает область печати листа. | |
setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions) | Задает поля страницы с единицами измерения для листа. | |
setPrintTitleColumns(printTitleColumns: Range | string) | Задает столбцы, содержащие ячейки, которые должны повторяться слева на каждой странице при печати листа. | |
setPrintTitleRows(printTitleRows: Range | string) | Задает строки, содержащие ячейки, которые должны повторяться сверху каждой страницы при печати листа. | |
topMargin | Верхнее поле листа (в пунктах) для использования при печати. | |
zoom | Параметры масштабирования листа. | |
PageLayoutMarginOptions | bottom | Задает нижнее поле макета страницы в единице, указанной для печати. |
footer | Задает поле нижнего колонтитула макета страницы в единице, указанной для печати. | |
header | Указывает поле заголовка макета страницы в единице, указанной для печати. | |
left | Задает левое поле макета страницы в единице, указанной для печати. | |
right | Задает правое поле макета страницы в единице, указанной для печати. | |
top | Задает верхнее поле макета страницы в единице, указанной для печати. | |
PageLayoutZoomOptions | horizontalFitToPages | Количество страниц, размещаемых по горизонтали. |
scale | Значение масштаба печатной страницы может быть равным от 10 до 400. | |
verticalFitToPages | Количество страниц, размещаемых по вертикали. | |
PivotField | sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>) | Сортирует сводную таблицу по указанным значениям в определенной области. |
PivotLayout | autoFormat | Указывает, будет ли форматирование автоматически отформатировано при обновлении или при перемещении полей. |
getDataHierarchy(cell: Range | string) | Получает объект DataHierarchy, использующийся для вычисления значения в указанном диапазоне сводной таблицы. | |
getPivotItems(axis: Excel.PivotAxis, cell: Range | string) | Получает объекты PivotItem с оси, образующие значение в указанном диапазоне сводной таблицы. | |
preserveFormatting | Указывает, сохраняется ли форматирование при обновлении или пересчете отчета с помощью таких операций, как сводка, сортировка или изменение элементов полей страницы. | |
setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy) | Задает для сводной таблицы автоматическую сортировку, используя указанную ячейку, чтобы автоматически выбрать все необходимые условия и контекст. | |
PivotTable | enableDataValueEditing | Указывает, позволяет ли сводная таблица изменять значения в тексте данных пользователем. |
useCustomSortLists | Указывает, использует ли сводная таблица настраиваемые списки при сортировке. | |
Range | autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType) | Заполняет диапазон от текущего до целевого диапазона с помощью указанной логики автозаполнения. |
convertDataTypeToText() | Преобразует ячейки диапазона с типами данных в текст. | |
convertToLinkedDataType(serviceID: number, languageCulture: string) | Преобразует ячейки диапазона в связанные типы данных на листе. | |
copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean) | Копирует данные ячейки или форматирование из исходного диапазона или RangeAreas в текущий диапазон. |
|
find(text: string, criteria: Excel.SearchCriteria) | Находит определенную строку на основе указанных условий. | |
findOrNullObject(text: string, criteria: Excel.SearchCriteria) | Находит определенную строку на основе указанных условий. | |
flashFill() | Выполняется заполнение флэш-памяти в текущем диапазоне. | |
getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions) | Возвращает двумерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждой ячейки. | |
getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions) | Возвращает одномерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждого столбца. | |
getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions) | Возвращает одномерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждой строки. | |
getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) | Возвращает объект , состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, который представляет все ячейки, соответствующие указанному типу и значению. |
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) | Возвращает объект , состоящий RangeAreas из одного или нескольких диапазонов, который представляет все ячейки, соответствующие указанному типу и значению. |
|
getTables(fullyContained?: boolean) | Получает коллекцию таблиц с заданной областью, перекрывающую диапазон. | |
linkedDataTypeState | Представляет состояние типа данных каждой ячейки. | |
removeDuplicates(columns: number[], includesHeader: boolean) | Удаляет повторяющиеся значения из диапазона, заданного столбцами. | |
replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria) | Находит и заменяет определенную строку на основе условий, указанных в текущем диапазоне. | |
setCellProperties(cellPropertiesData: SettableCellProperties[][]) | Обновления диапазон на основе двухмерного массива свойств ячейки, инкапсулирующего такие элементы, как шрифт, заливка, границы и выравнивание. | |
setColumnProperties(columnPropertiesData: SettableColumnProperties[]) | Обновления диапазон на основе одномерного массива свойств столбца, инкапсулирующего такие элементы, как шрифт, заливка, границы и выравнивание. | |
setDirty() | Устанавливает диапазон, предназначенный для пересчета при выполнении следующего пересчета. | |
setRowProperties(rowPropertiesData: SettableRowProperties[]) | Обновления диапазон на основе одномерного массива свойств строки, инкапсулирующего такие элементы, как шрифт, заливка, границы и выравнивание. | |
RangeAreas | address | Возвращает ссылку RangeAreas в стиле A1. |
addressLocal | Возвращает ссылку RangeAreas в языковом стандарте пользователя. |
|
areaCount | Возвращает количество прямоугольных диапазонов, составляющих этот RangeAreas объект. |
|
areas | Возвращает коллекцию прямоугольных диапазонов, составляющих этот RangeAreas объект. |
|
calculate() | Вычисляет все ячейки RangeAreas в . |
|
cellCount | Возвращает количество ячеек в объекте RangeAreas , суммируя количество ячеек всех отдельных прямоугольных диапазонов. |
|
clear(applyTo?: Excel.ClearApplyTo) | Очищает значения, формат, заливку, границу и другие свойства в каждой из областей, составляющих этот RangeAreas объект. |
|
conditionalFormats | Возвращает коллекцию условных форматов, пересекающихся с любыми ячейками в этом RangeAreas объекте. |
|
convertDataTypeToText() | Преобразует все ячейки в RangeAreas с типами данных в текст. |
|
convertToLinkedDataType(serviceID: number, languageCulture: string) | Преобразует все ячейки в в RangeAreas связанные типы данных. |
|
copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean) | Копирует данные ячейки или форматирование из исходного диапазона или RangeAreas в текущий RangeAreas . |
|
dataValidation | Возвращает объект проверки данных для всех диапазонов в RangeAreas . |
|
format |
RangeFormat Возвращает объект , инкапсулирующий шрифт, заливку, границы, выравнивание и другие свойства для всех диапазонов в объекте RangeAreas . |
|
getEntireColumn() |
RangeAreas Возвращает объект , представляющий все столбцы RangeAreas объекта (например, если текущий RangeAreas представляет ячейки "B4:E11, H2", он возвращает RangeAreas объект , представляющий столбцы "B:E, H:H"). |
|
getEntireRow() |
RangeAreas Возвращает объект , представляющий все строки RangeAreas объекта (например, если текущий RangeAreas представляет ячейки "B4:E11", он возвращает RangeAreas объект , представляющий строки "4:11"). |
|
getIntersection(anotherRange: Range | RangeAreas | string) |
RangeAreas Возвращает объект , представляющий пересечение заданных диапазонов или RangeAreas . |
|
getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string) |
RangeAreas Возвращает объект , представляющий пересечение заданных диапазонов или RangeAreas . |
|
getOffsetRangeAreas(rowOffset: number, columnOffset: number) |
RangeAreas Возвращает объект, смещенный на определенное смещение строк и столбцов. |
|
getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) |
RangeAreas Возвращает объект , представляющий все ячейки, соответствующие указанному типу и значению. |
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) |
RangeAreas Возвращает объект , представляющий все ячейки, соответствующие указанному типу и значению. |
|
getTables(fullyContained?: boolean) | Возвращает коллекцию таблиц с заданной областью, перекрывающуюся с любым диапазоном в этом RangeAreas объекте. |
|
getUsedRangeAreas(valuesOnly?: boolean) | Возвращает объект RangeAreas , который содержит все используемые области отдельных прямоугольных диапазонов в объекте RangeAreas . |
|
getUsedRangeAreasOrNullObject(valuesOnly?: boolean) | Возвращает объект RangeAreas , который содержит все используемые области отдельных прямоугольных диапазонов в объекте RangeAreas . |
|
isEntireColumn | Указывает, представляют ли все диапазоны этого RangeAreas объекта целые столбцы (например, "A:C, Q:Z"). |
|
isEntireRow | Указывает, представляют ли все диапазоны этого RangeAreas объекта целые строки (например, "1:3, 5:7"). |
|
setDirty() | Задает объект для пересчета RangeAreas при следующем пересчете. |
|
style | Представляет стиль для всех диапазонов в этом RangeAreas объекте. |
|
worksheet | Возвращает лист для текущего RangeAreas . |
|
RangeBorder | tintAndShade | Указывает двойник, который осветляет или затемняет цвет для границы диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий), с 0 для исходного цвета. |
RangeBorderCollection | tintAndShade | Задает двойник, который осветляет или затемняет цвет границ диапазона. |
RangeCollection | getCount() | Возвращает количество диапазонов в RangeCollection . |
getItemAt(index: number) | Возвращает объект диапазона на основе его положения в RangeCollection . |
|
items | Получает загруженные дочерние элементы в этой коллекции. | |
RangeFill | pattern | Шаблон диапазона. |
patternColor | Код цвета HTML, представляющий цвет шаблона диапазона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). | |
patternTintAndShade | Задает двойник, который осветляет или затемняет цвет узора для заливки диапазона. | |
tintAndShade | Задает двойник, который осветляет или затемняет цвет заливки диапазона. | |
RangeFont | strikethrough | Указывает состояние зачеркиния шрифта. |
subscript | Указывает состояние подстрочного индекса шрифта. | |
superscript | Указывает надстрочный индекс шрифта. | |
tintAndShade | Указывает двойник, который осветляет или затемняет цвет шрифта диапазона. | |
RangeFormat | autoIndent | Указывает, является ли текст автоматически отступом, если задано равное распределение текста. |
indentLevel | Целое число от 0 до 250, указывающее уровень отступа. | |
readingOrder | Направление чтения для диапазона. | |
shrinkToFit | Указывает, будет ли текст автоматически сжиматься в соответствии с доступной шириной столбца. | |
RemoveDuplicatesResult | removed | Количество повторяющихся строк, удаленных операцией. |
uniqueRemaining | Количество оставшихся уникальных строк, присутствующих в получившемся диапазоне. | |
ReplaceCriteria | completeMatch | Указывает, должно ли совпадение быть полным или частичным. |
matchCase | Указывает, учитывается ли совпадение с учетом регистра. | |
RowProperties | address | Представляет свойство address . |
addressLocal | Представляет свойство addressLocal . |
|
rowIndex | Представляет свойство rowIndex . |
|
SearchCriteria | completeMatch | Указывает, должно ли совпадение быть полным или частичным. |
matchCase | Указывает, учитывается ли совпадение с учетом регистра. | |
searchDirection | Указывает направление поиска. | |
SettableCellProperties | format | Представляет свойство format . |
hyperlink | Представляет свойство hyperlink . |
|
style | Представляет свойство style . |
|
SettableColumnProperties | columnHidden | Представляет свойство columnHidden . |
format | Представляет свойство format . |
|
SettableRowProperties | format | Представляет свойство format . |
rowHidden | Представляет свойство rowHidden . |
|
Shape | altTextDescription | Задает замещающий текст описания объекта Shape . |
altTextTitle | Задает замещающий текст заголовка Shape для объекта. |
|
connectionSiteCount | Возвращает количество точек соединения на фигуре. | |
delete() | Удаляет фигуру с листа. | |
fill | Возвращает формат заливки фигуры. | |
geometricShape | Возвращает геометрическую фигуру, связанную с линией. | |
geometricShapeType | Указывает тип геометрической фигуры этой геометрической фигуры. | |
getAsImage(format: Excel.PictureFormat) | Преобразует фигуру в изображение и возвращает изображение в виде строки в кодировке Base64. | |
group | Возвращает группу фигур, связанную с фигурой. | |
height | Задает высоту фигуры (в точках). | |
id | Указывает идентификатор фигуры. | |
image | Возвращает изображение, связанное с фигурой. | |
incrementLeft(increment: number) | Перемещает фигуру по горизонтали на указанное число пунктов. | |
incrementRotation(increment: number) | Поворачивает фигуру по часовой стрелке относительно оси Z на указанное число градусов. | |
incrementTop(increment: number) | Перемещает фигуру по вертикали на указанное число пунктов. | |
left | Расстояние в пунктах от левого края фигуры до левого края листа. | |
level | Задает уровень указанной фигуры. | |
line | Возвращает линию, связанную с фигурой. | |
lineFormat | Возвращает формат линии для фигуры. | |
lockAspectRatio | Указывает, заблокировано ли пропорции этой фигуры. | |
name | Указывает имя фигуры. | |
onActivated | Возникает, если фигура активирована. | |
onDeactivated | Возникает, если фигура деактивирована. | |
parentGroup | Указывает родительскую группу этой фигуры. | |
rotation | Задает поворот фигуры в градусах. | |
scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom) | Масштабирует высоту фигуры с применением указанного коэффициента. | |
scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom) | Масштабирует ширину фигуры с применением указанного коэффициента. | |
setZOrder(position: Excel.ShapeZOrder) | Перемещает указанную фигуру вверх или вниз по оси Z в коллекции, что переносит ее вперед или назад относительно других фигур. | |
textFrame | Возвращает объект рамки с текстом для фигуры. | |
top | Расстояние в пунктах от верхнего края фигуры до верхнего края листа. | |
type | Возвращает тип фигуры. | |
visible | Указывает, видна ли фигура. | |
width | Задает ширину фигуры (в точках). | |
zOrderPosition | Возвращает положение указанной фигуры по оси Z. Значение 0 представляет нижнее положение по оси. | |
ShapeActivatedEventArgs | shapeId | Возвращает идентификатор активированной фигуры. |
type | Получает тип события. | |
worksheetId | Возвращает идентификатор листа, на котором активирована фигура. | |
ShapeCollection | addGeometricShape(geometricShapeType: Excel.GeometricShapeType) | Добавляет геометрическую фигуру на лист. |
addGroup(values: строка массива<| Фигура>) | Группирует подмножество фигур на листе этой коллекции. | |
addImage(base64ImageString: string) | Создает изображение из строки в кодировке Base64 и добавляет его на лист. | |
addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType) | Добавляет линию на лист. | |
addTextBox(text?: string) | Добавляет текстовое поле на лист с указанным текстом в качестве содержимого. | |
getCount() | Возвращает количество фигур на листе. | |
getItem(key: string) | Возвращает фигуру, используя ее имя или идентификатор. | |
getItemAt(index: number) | Получает фигуру с помощью ее позиции в коллекции. | |
items | Получает загруженные дочерние элементы в этой коллекции. | |
ShapeDeactivatedEventArgs | shapeId | Возвращает идентификатор фигуры, отключенной. |
type | Получает тип события. | |
worksheetId | Возвращает идентификатор листа, на котором фигура деактивирована. | |
ShapeFill | clear() | Очищает формат заливки фигуры. |
foregroundColor | Представляет цвет переднего плана заливки фигуры в формате HTML, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый") | |
setSolidColor(color: string) | Задает заливку одним цветом для фигуры. | |
transparency | Задает процент прозрачности заливки в виде значения от 0,0 (непрозрачный) до 1,0 (очистить). | |
type | Возвращает тип заливки фигуры. | |
ShapeFont | bold | Указывает, является ли шрифт полужирным. |
color | Представление цветового кода HTML для цвета текста (например, "#FF0000" представляет красный цвет). | |
italic | Указывает, применяется ли курсив. | |
name | Представляет имя шрифта (например, "Calibri"). | |
size | Представляет размер шрифта в пунктах (например, 11). | |
underline | Тип подчеркивания, применяемый для шрифта. | |
ShapeGroup | id | Указывает идентификатор фигуры. |
shape | Возвращает объект, Shape связанный с группой. |
|
shapes | Возвращает коллекцию Shape объектов. |
|
ungroup() | Отменяет группировку любых сгруппированных фигур в указанной группе фигур. | |
ShapeLineFormat | color | Представляет цвет линии в цветовом формате HTML в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). |
dashStyle | Представляет тип линии фигуры. | |
style | Представляет тип линии фигуры. | |
transparency | Представляет степень прозрачности указанной линии как значение от 0,0 (непрозрачная) до 1,0 (полностью прозрачная). | |
visible | Указывает, отображается ли форматирование линий элемента фигуры. | |
weight | Представляет толщину линии (в пунктах). | |
SortField | subField | Указывает подполе, которое является именем целевого свойства расширенного значения для сортировки. |
StyleCollection | getCount() | Получает количество стилей в коллекции. |
getItemAt(index: number) | Получает стиль на основе его позиции в коллекции. | |
Table | autoFilter | Представляет AutoFilter объект таблицы. |
TableAddedEventArgs | source | Получает источник события. |
tableId | Возвращает идентификатор добавленной таблицы. | |
type | Получает тип события. | |
worksheetId | Возвращает идентификатор листа, на который добавляется таблица. | |
TableChangedEventArgs | details | Возвращает сведения об изменениях. |
TableCollection | onAdded | Происходит при добавлении новой таблицы в книгу. |
onDeleted | Возникает, если указанная таблица удалена из книги. | |
TableDeletedEventArgs | source | Получает источник события. |
tableId | Возвращает идентификатор удаляемой таблицы. | |
tableName | Возвращает имя удаляемой таблицы. | |
type | Получает тип события. | |
worksheetId | Возвращает идентификатор листа, на котором удаляется таблица. | |
TableScopedCollection | getCount() | Получает количество таблиц в коллекции. |
getFirst() | Получает первую таблицу в коллекции. | |
getItem(key: string) | Получает таблицу по имени или ИД. | |
items | Получает загруженные дочерние элементы в этой коллекции. | |
TextFrame | autoSizeSetting | Параметры автоматического изменения размера текстового фрейма. |
bottomMargin | Представляет нижнее поле рамки с текстом (в пунктах). | |
deleteText() | Удаляет весь текст в рамке с текстом. | |
hasText | Указывает, содержит ли текстовый фрейм текст. | |
horizontalAlignment | Представляет горизонтальное выравнивание рамки с текстом. | |
horizontalOverflow | Представляет действие горизонтального переполнения рамки с текстом. | |
leftMargin | Представляет левое поле рамки с текстом (в пунктах). | |
orientation | Представляет угол, на который ориентирован текст для текстового фрейма. | |
readingOrder | Представляет направление чтения рамки с текстом (слева направо или справа налево). | |
rightMargin | Представляет правое поле рамки с текстом (в пунктах). | |
textRange | Представляет текст, присоединенный к фигуре в текстовой рамке, а также свойства и методы для операций с текстом. | |
topMargin | Представляет верхнее поле рамки с текстом (в пунктах). | |
verticalAlignment | Представляет вертикальное выравнивание для рамки с текстом. | |
verticalOverflow | Представляет действие вертикального переполнения рамки с текстом. | |
TextRange | font |
ShapeFont Возвращает объект , представляющий атрибуты шрифта для текстового диапазона. |
getSubstring(start: number, length?: number) | Возвращает объект TextRange для подстроки в указанном диапазоне. | |
text | Представляет содержимое с обычным текстом в диапазоне текста. | |
Workbook | autoSave | Указывает, находится ли книга в режиме автосохранений. |
calculationEngineVersion | Возвращает номер версии модуля вычислений Excel. | |
chartDataPointTrack | Значение true, если все диаграммы в книге отслеживают точки фактических данных, с которыми они связаны. | |
getActiveChart() | Получает текущую активную диаграмму в книге. | |
getActiveChartOrNullObject() | Получает текущую активную диаграмму в книге. | |
getIsActiveCollabSession() | Возвращает значение true , если книга редактируется несколькими пользователями (с помощью совместного редактирования). |
|
getSelectedRanges() | Получает текущий выделенный диапазон (один или несколько) в книге. | |
isDirty | Указывает, были ли изменения внесены с момента последнего сохранения книги. | |
onAutoSaveSettingChanged | Происходит при изменении параметра автосохранение в книге. | |
previouslySaved | Указывает, сохранялась ли книга локально или в сети. | |
usePrecisionAsDisplayed | Значение true, если вычисления в книге выполняются только с той точностью чисел, с которой они отображаются. | |
WorkbookAutoSaveSettingChangedEventArgs | type | Получает тип события. |
Worksheet | autoFilter | Представляет AutoFilter объект листа. |
enableCalculation | Определяет, следует ли excel пересчитывать лист при необходимости. | |
findAll(text: string, criteria: Excel.WorksheetSearchCriteria) | Находит все вхождения заданной строки на основе заданных критериев и возвращает их в виде RangeAreas объекта, состоящего из одного или нескольких прямоугольных диапазонов. |
|
findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria) | Находит все вхождения заданной строки на основе заданных критериев и возвращает их в виде RangeAreas объекта, состоящего из одного или нескольких прямоугольных диапазонов. |
|
getRanges(address?: string) |
RangeAreas Возвращает объект , представляющий один или несколько блоков прямоугольных диапазонов, заданных адресом или именем. |
|
horizontalPageBreaks | Получает коллекцию горизонтальных разрывов страницы для листа. | |
onFormatChanged | Возникает, если изменен формат указанного листа. | |
pageLayout |
PageLayout Возвращает объект листа. |
|
replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria) | Находит и заменяет определенную строку на основе условий, указанных в текущем листе. | |
shapes | Возвращает коллекцию всех объектов Shape на листе. | |
verticalPageBreaks | Получает коллекцию вертикальных разрывов страницы для листа. | |
WorksheetChangedEventArgs | details | Представляет сведения об изменениях. |
WorksheetCollection | onChanged | Возникает при изменении любого листа в книге. |
onFormatChanged | Происходит при изменении формата любого листа в книге. | |
onSelectionChanged | Возникает при изменениях выделения на любом листе. | |
WorksheetFormatChangedEventArgs | address | Получает адрес диапазона, представляющий измененную область конкретного листа. |
getRange(ctx: Excel.RequestContext) | Получает диапазон, представляющий измененную область конкретного листа. | |
getRangeOrNullObject(ctx: Excel.RequestContext) | Получает диапазон, представляющий измененную область конкретного листа. | |
источник | Получает источник события. | |
type | Получает тип события. | |
worksheetId | Возвращает идентификатор листа, на котором были изменены данные. | |
WorksheetSearchCriteria | completeMatch | Указывает, должно ли совпадение быть полным или частичным. |
matchCase | Указывает, учитывается ли совпадение с учетом регистра. |
См. также
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
Office Add-ins