Новые возможности API JavaScript для Excel 1.4What's new in Excel JavaScript API 1.4

Ниже перечислено то, что было недавно добавлено в набор обязательных элементов 1.4, относящийся к API JavaScript для Excel.The following are the new additions to the Excel JavaScript APIs in requirement set 1.4.

Именованный элемент add и новые свойстваNamed item add and new properties

Новые свойства:New properties:

  • comment
  • scope— Элементы листа или книги.scope - Worksheet or workbook scoped items.
  • worksheet— Возвращает лист, на который распространяется именованный элемент.worksheet - Returns the worksheet on which the named item is scoped to.

Новые методы:New methods:

  • add(name: string, reference: Range or string, comment: string)— Добавляет новое имя в коллекцию заданной области.add(name: string, reference: Range or string, comment: string) - Adds a new name to the collection of the given scope.
  • addFormulaLocal(name: string, formula: string, comment: string)-Добавляет новое имя в коллекцию заданной области, используя языковой стандарт пользователя для формулы.addFormulaLocal(name: string, formula: string, comment: string) - Adds a new name to the collection of the given scope using the user's locale for the formula.

Параметры API в пространстве имен ExcelSettings API in the Excel namespace

Объект Setting представляет пару "ключ-значение" для параметра, хранящегося в документе.The Setting object represents a key:value pair for a setting persisted to the document. Функциональные возможности объекта Excel.Setting аналогичны Office.Settings, но он использует пакетный синтаксис API, а не модель обратного вызова общего API.The functionality of Excel.Setting is equivalent to Office.Settings, but uses the batched API syntax, rather than the Common API's callback model.

Интерфейсы API getItem() включают в себя получение записи параметров с помощью add() ключа и добавление указанной записи параметра key: value в книгу.APIs include getItem() to get setting entry via the key and add() to add the specified key:value setting pair to the workbook.

ДругиеOthers

  • Задайте имя столбца таблицы.Set the table column name.
  • Добавление столбца таблицы в конец таблицы.Add a table column to the end of the table.
  • Добавление нескольких строк в таблицу за раз.Add multiple rows to a table at a time.
  • range.getColumnsAfter(count: number) и range.getColumnsBefore(count: number), чтобы вернуть определенное количество столбцов справа/слева от текущего объекта Range.range.getColumnsAfter(count: number) and range.getColumnsBefore(count: number) to get a certain number of columns to the right/left of the current Range object.
  • Функция "получить элемент" или "null Object": Эта функция позволяет получать объект с помощью ключа.The get item or null object function: This functionality allows getting object using a key. Если объект не существует, isNullObject свойство возвращаемого объекта будет иметь значение true.If the object does not exist, the returned object's isNullObject property will be true. Это позволяет разработчикам проверять, существует ли объект, но не обрабатывать его с помощью обработки исключений.This allows developers to check if an object exists or not without having to handle it through exception handling. *OrNullObject Метод доступен для большинства объектов Collection.The *OrNullObject method is available on most collection objects.
worksheet.getItemOrNullObject("itemName")

Список APIAPI list

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

КлассClass ПоляFields ОписаниеDescription
BindingCollectionBindingCollection getCount()getCount() Получает количество привязок в коллекции.Gets the number of bindings in the collection.
getItemOrNullObject(id: строка)getItemOrNullObject(id: string) Получает объект привязки по идентификатору.Gets a binding object by ID. Если объект привязки не существует, возвращает пустой объект.If the binding object does not exist, will return a null object.
ChartCollectionChartCollection getCount()getCount() Возвращает количество диаграмм на листе.Returns the number of charts in the worksheet.
getItemOrNullObject(имя: строка)getItemOrNullObject(name: string) Возвращает диаграмму по ее имени.Gets a chart using its name. Если одно и то же имя принадлежит нескольким диаграммам, будет возвращена первая из них.If there are multiple charts with the same name, the first one will be returned.
ChartPointsCollectionChartPointsCollection getCount()getCount() Возвращает количество точек диаграммы в ряду.Returns the number of chart points in the series.
ChartSeriesCollectionChartSeriesCollection getCount()getCount() Возвращает количество рядов в коллекции.Returns the number of series in the collection.
NamedItemNamedItem commentcomment Представляет примечание, связанное с этим именем.Represents the comment associated with this name.
delete()delete() Удаляет заданное имя.Deletes the given name.
getRangeOrNullObject()getRangeOrNullObject() Возвращает объект диапазона, связанный с именем.Returns the range object that is associated with the name. Возвращает пустой объект, если именованный элемент не является диапазоном.Returns a null object if the named item's type is not a range.
scopescope Указывает, относится ли имя к книге или определенному листу.Indicates whether the name is scoped to the workbook or to a specific worksheet. Возможные значения: лист, книга.Possible values are: Worksheet, Workbook. Только для чтения.Read-only.
worksheetworksheet Возвращает лист, к которому относится именованный элемент.Returns the worksheet on which the named item is scoped to. Выдает ошибку, если элемент находится в области действия книги.Throws an error if the item is scoped to the workbook instead.
worksheetOrNullObjectworksheetOrNullObject Возвращает лист, к которому относится именованный элемент.Returns the worksheet on which the named item is scoped to. Возвращает пустой объект, если элемент относится к книге.Returns a null object if the item is scoped to the workbook instead.
NamedItemCollectionNamedItemCollection Add (имя: строка, ссылка: строка | диапазона, комментарий?: строка)add(name: string, reference: Range | string, comment?: string) Добавляет новое имя в определенную коллекцию.Adds a new name to the collection of the given scope.
addFormulaLocal (имя: строка, формула: строка, Примечание?: строка)addFormulaLocal(name: string, formula: string, comment?: string) Добавляет новое имя в определенную коллекцию, используя языковой стандарт пользователя для формулы.Adds a new name to the collection of the given scope using the user's locale for the formula.
getCount()getCount() Получает количество именованных элементов в коллекции.Gets the number of named items in the collection.
getItemOrNullObject(имя: строка)getItemOrNullObject(name: string) Возвращает объект NamedItem, используя его имя.Gets a NamedItem object using its name. Если объект nameditem не существует, возвращает пустой объект.If the nameditem object does not exist, will return a null object.
PivotTableCollectionPivotTableCollection getCount()getCount() Получает количество сводных таблиц в коллекции.Gets the number of pivot tables in the collection.
getItemOrNullObject(имя: строка)getItemOrNullObject(name: string) Получает сводную таблицу по имени.Gets a PivotTable by name. Если сводная таблица не существует, возвращает пустой объект.If the PivotTable does not exist, will return a null object.
RangeRange getIntersectionOrNullObject (anotherRange: строка | Range)getIntersectionOrNullObject(anotherRange: Range | string) Возвращает объект диапазона, представляющий прямоугольное пересечение заданных диапазонов.Gets the range object that represents the rectangular intersection of the given ranges. Если пересечение не найдено, возвращает пустой объект.If no intersection is found, will return a null object.
getUsedRangeOrNullObject (valuesOnly?: Boolean)getUsedRangeOrNullObject(valuesOnly?: boolean) Возвращает используемый диапазон заданного объекта диапазона. Если в диапазоне нет используемых ячеек, эта функция возвращает пустой объект.Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object.
RangeViewCollectionRangeViewCollection getCount()getCount() Получает количество объектов RangeView в коллекции.Gets the number of RangeView objects in the collection.
ПараметрSetting delete()delete() Удаляет параметр.Deletes the setting.
keykey Возвращает ключ, представляющий идентификатор setting.Returns the key that represents the id of the Setting. Только для чтения.Read-only.
valuevalue Представляет значение, сохраненное для этого параметра.Represents the value stored for this setting.
SettingCollectionSettingCollection Add (ключ: строка, значение: строка | Number | Boolean | массив | | дат Any)add(key: string, value: string | number | boolean | Date | Array | any) Задает или добавляет указанный параметр в книгу.Sets or adds the specified setting to the workbook.
getCount()getCount() Получает количество параметров в коллекции.Gets the number of Settings in the collection.
getItem(key: string)getItem(key: string) Получает запись Setting по ключу.Gets a Setting entry via the key.
getItemOrNullObject(key: string)getItemOrNullObject(key: string) Возвращает объект Setting по ключу.Gets a Setting entry via the key. Если параметр не существует, возвращает пустой объект.If the Setting does not exist, will return a null object.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
onSettingsChangedonSettingsChanged Возникает при изменении параметров в документе.Occurs when the Settings in the document are changed.
SettingsChangedEventArgsSettingsChangedEventArgs settingssettings Получает объект Setting, представляющий привязку, которая вызвала событие SettingsChanged.Gets the Setting object that represents the binding that raised the SettingsChanged event
TableCollectionTableCollection getCount()getCount() Получает количество таблиц в коллекции.Gets the number of tables in the collection.
getItemOrNullObject(key: string)getItemOrNullObject(key: string) Получает таблицу по имени или ИД.Gets a table by Name or ID. Если таблица не существует, возвращает пустой объект.If the table does not exist, will return a null object.
TableColumnCollectionTableColumnCollection getCount()getCount() Получает количество столбцов в таблице.Gets the number of columns in the table.
getItemOrNullObject (Key: номер | строки)getItemOrNullObject(key: number | string) Возвращает объект столбца по имени или ИД.Gets a column object by Name or ID. Если столбец не существует, возвращает пустой объект.If the column does not exist, will return a null object.
TableRowCollectionTableRowCollection getCount()getCount() Получает количество строк в таблице.Gets the number of rows in the table.
WorkbookWorkbook settingssettings Представляет коллекцию параметров, сопоставленных с книгой.Represents a collection of Settings associated with the workbook. Только для чтения.Read-only.
WorksheetWorksheet getUsedRangeOrNullObject (valuesOnly?: Boolean)getUsedRangeOrNullObject(valuesOnly?: boolean) Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки, которые содержат значение или форматирование. Если весь лист пустой, эта функция возвращает пустой объект.The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, this function will return a null object.
псевдонимnames Коллекция имен, относящих к текущему листу.Collection of names scoped to the current worksheet. Только для чтения.Read-only.
WorksheetCollectionWorksheetCollection NOCOUNT (visibleOnly?: Boolean)getCount(visibleOnly?: boolean) Получает количество листов в коллекции.Gets the number of worksheets in the collection.
getItemOrNullObject(key: string)getItemOrNullObject(key: string) Получает объект листа по его имени или ИД.Gets a worksheet object using its Name or ID. Если лист не существует, возвращает пустой объект.If the worksheet does not exist, will return a null object.

См. такжеSee also