Excel.Table class
Представляет таблицу Excel. Дополнительные сведения о объектной модели таблиц см. в статье Работа с таблицами с помощью API JavaScript для Excel.
- Extends
Комментарии
Свойства
| columns | Представляет коллекцию всех столбцов в таблице. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| highlight |
Указывает, содержит ли первый столбец специальное форматирование. |
| highlight |
Указывает, содержит ли последний столбец специальное форматирование. |
| id | Возвращает значение, однозначно идентифицирующее таблицу в данной книге. Значение идентификатора остается прежним, даже если переименовать таблицу. |
| name | Имя таблицы. Заданное имя таблицы должно соответствовать рекомендациям, указанным в статье Переименование таблицы Excel . |
| rows | Представляет коллекцию всех строк в таблице. |
| show |
Указывает, отображаются ли столбцы в виде чередующегося форматирования, в котором нечетные столбцы выделены иначе, чем четные, чтобы упростить чтение таблицы. |
| show |
Указывает, отображаются ли строки с чередованием, в котором нечетные строки выделены иначе, чем четные, чтобы упростить чтение таблицы. |
| show |
Указывает, отображаются ли кнопки фильтра в верхней части заголовка каждого столбца. Это свойство можно использовать, только если таблица содержит строку заголовков. |
| show |
Указывает, отображается ли строка заголовка. Можно задать это значение, чтобы отобразить или скрыть строку заголовков. |
| show |
Указывает, отображается ли итоговая строка. Можно задать это значение, чтобы отобразить или скрыть строку итогов. |
| sort | Представляет сортировку для таблицы. |
| style | Значение константы, представляющее стиль таблицы. Возможные значения: "TableStyleLight1" – "TableStyleLight21", "TableStyleMedium1" – "TableStyleMedium28", "TableStyleDark1" – "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге. |
| worksheet | Лист, содержащий текущую таблицу. |
Методы
| clear |
Удаляет все фильтры, примененные к таблице. |
| convert |
Преобразовывает таблицу в обычный диапазон ячеек. Все данные сохраняются. |
| delete() | Удаляет таблицу. |
| get |
Получает объект диапазона, связанный с основными данными таблицы. |
| get |
Получает объект диапазона, связанный со строкой заголовка таблицы. |
| get |
Получает объект диапазона, связанный со всей таблицей. |
| get |
Получает объект диапазона, связанный со строкой итогов таблицы. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| reapply |
Повторно применяет все текущие фильтры к таблице. |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
columns
Представляет коллекцию всех столбцов в таблице.
readonly columns: Excel.TableColumnCollection;Значение свойства
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
highlightFirstColumn
Указывает, содержит ли первый столбец специальное форматирование.
highlightFirstColumn: boolean;Значение свойства
boolean
Комментарии
highlightLastColumn
Указывает, содержит ли последний столбец специальное форматирование.
highlightLastColumn: boolean;Значение свойства
boolean
Комментарии
id
Возвращает значение, однозначно идентифицирующее таблицу в данной книге. Значение идентификатора остается прежним, даже если переименовать таблицу.
readonly id: string;Значение свойства
string
Комментарии
name
Имя таблицы.
Заданное имя таблицы должно соответствовать рекомендациям, указанным в статье Переименование таблицы Excel .
name: string;Значение свойства
string
Комментарии
rows
Представляет коллекцию всех строк в таблице.
readonly rows: Excel.TableRowCollection;Значение свойства
Комментарии
showBandedColumns
Указывает, отображаются ли столбцы в виде чередующегося форматирования, в котором нечетные столбцы выделены иначе, чем четные, чтобы упростить чтение таблицы.
showBandedColumns: boolean;Значение свойства
boolean
Комментарии
showBandedRows
Указывает, отображаются ли строки с чередованием, в котором нечетные строки выделены иначе, чем четные, чтобы упростить чтение таблицы.
showBandedRows: boolean;Значение свойства
boolean
Комментарии
showFilterButton
Указывает, отображаются ли кнопки фильтра в верхней части заголовка каждого столбца. Это свойство можно использовать, только если таблица содержит строку заголовков.
showFilterButton: boolean;Значение свойства
boolean
Комментарии
showHeaders
Указывает, отображается ли строка заголовка. Можно задать это значение, чтобы отобразить или скрыть строку заголовков.
showHeaders: boolean;Значение свойства
boolean
Комментарии
showTotals
Указывает, отображается ли итоговая строка. Можно задать это значение, чтобы отобразить или скрыть строку итогов.
showTotals: boolean;Значение свойства
boolean
Комментарии
sort
Представляет сортировку для таблицы.
readonly sort: Excel.TableSort;Значение свойства
Комментарии
style
Значение константы, представляющее стиль таблицы. Возможные значения: "TableStyleLight1" – "TableStyleLight21", "TableStyleMedium1" – "TableStyleMedium28", "TableStyleDark1" – "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.
style: string;Значение свойства
string
Комментарии
Примеры
// Set table style.
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.name = 'Table1-Renamed';
table.showTotals = false;
table.style = 'TableStyleMedium2';
table.load('tableStyle');
await context.sync();
console.log(table.style);
});
worksheet
Лист, содержащий текущую таблицу.
readonly worksheet: Excel.Worksheet;Значение свойства
Комментарии
Сведения о методе
clearFilters()
Удаляет все фильтры, примененные к таблице.
clearFilters(): void;Возвращаемое значение
void
Комментарии
convertToRange()
Преобразовывает таблицу в обычный диапазон ячеек. Все данные сохраняются.
convertToRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.convertToRange();
await context.sync();
});
delete()
Удаляет таблицу.
delete(): void;Возвращаемое значение
void
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.delete();
await context.sync();
});
getDataBodyRange()
Получает объект диапазона, связанный с основными данными таблицы.
getDataBodyRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableDataRange = table.getDataBodyRange();
tableDataRange.load('address')
await context.sync();
console.log(tableDataRange.address);
});
getHeaderRowRange()
Получает объект диапазона, связанный со строкой заголовка таблицы.
getHeaderRowRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableHeaderRange = table.getHeaderRowRange();
tableHeaderRange.load('address');
await context.sync();
console.log(tableHeaderRange.address);
});
getRange()
Получает объект диапазона, связанный со всей таблицей.
getRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableRange = table.getRange();
tableRange.load('address');
await context.sync();
console.log(tableRange.address);
});
getTotalRowRange()
Получает объект диапазона, связанный со строкой итогов таблицы.
getTotalRowRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableTotalsRange = table.getTotalRowRange();
tableTotalsRange.load('address');
await context.sync();
console.log(tableTotalsRange.address);
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.Table;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
// Get a table by name.
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.load('id')
await context.sync();
console.log(table.id);
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Table;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
reapplyFilters()
Повторно применяет все текущие фильтры к таблице.
reapplyFilters(): void;Возвращаемое значение
void
Комментарии
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.TableUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.Table): void;Параметры
- properties
- Excel.Table
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.Table является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TableData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.TableData;Возвращаемое значение
Office Add-ins