Excel.Table class

Представляет AutoFilter объект таблицы.

readonly autoFilter: Excel.AutoFilter;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.9 ]

Представляет коллекцию всех столбцов в таблице.

readonly columns: Excel.TableColumnCollection;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.1 ]

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Указывает, содержит ли первый столбец специальное форматирование.

highlightFirstColumn: boolean;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.3 ]

Указывает, содержит ли последний столбец специальное форматирование.

highlightLastColumn: boolean;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.3 ]

Возвращает значение, однозначно идентифицирующее таблицу в данной книге. Значение идентификатора остается прежним, даже если переименовать таблицу.

readonly id: string;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.1 ]

Возвращает числовой идентификатор.

readonly legacyId: string;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.8 ]

Имя таблицы.

Заданное имя таблицы должно соответствовать рекомендациям, указанным в статье Переименование таблицы Excel .

name: string;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.1 ]

Представляет коллекцию всех строк в таблице.

readonly rows: Excel.TableRowCollection;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.1 ]

Указывает, отображаются ли столбцы в виде чередующегося форматирования, в котором нечетные столбцы выделены иначе, чем четные, чтобы упростить чтение таблицы.

showBandedColumns: boolean;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.3 ]

Указывает, отображаются ли строки с чередованием, в котором нечетные строки выделены иначе, чем четные, чтобы упростить чтение таблицы.

showBandedRows: boolean;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.3 ]

Указывает, отображаются ли кнопки фильтра в верхней части заголовка каждого столбца. Это свойство можно использовать, только если таблица содержит строку заголовков.

showFilterButton: boolean;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.3 ]

Указывает, отображается ли строка заголовка. Можно задать это значение, чтобы отобразить или скрыть строку заголовков.

showHeaders: boolean;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.1 ]

Указывает, отображается ли итоговая строка. Можно задать это значение, чтобы отобразить или скрыть строку итогов.

showTotals: boolean;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.1 ]

Представляет сортировку для таблицы.

readonly sort: Excel.TableSort;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.2 ]

Значение константы, представляющее стиль таблицы. Возможные значения: "TableStyleLight1" – "TableStyleLight21", "TableStyleMedium1" – "TableStyleMedium28", "TableStyleDark1" – "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.

style: string;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

// 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);
});

Стиль, применяемый к таблице.

readonly tableStyle: Excel.TableStyle;

Значение свойства

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Лист, содержащий текущую таблицу.

readonly worksheet: Excel.Worksheet;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.2 ]

Удаляет все фильтры, примененные к таблице.

clearFilters(): void;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.2 ]

Изменяет таблицу для использования стиля таблицы по умолчанию.

clearStyle(): void;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Преобразовывает таблицу в обычный диапазон ячеек. Все данные сохраняются.

convertToRange(): Excel.Range;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.2 ]

Примеры

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.convertToRange();
    await context.sync(); 
});

Удаляет таблицу.

delete(): void;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.delete();
    await context.sync(); 
});

Получает объект диапазона, связанный с основными данными таблицы.

getDataBodyRange(): Excel.Range;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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(): Excel.Range;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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(): Excel.Range;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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(): Excel.Range;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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);
});

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table;

Параметры

Возвращаемое значение

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.Table;

Параметры

Возвращаемое значение

Примеры

// 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);
});

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Table;

Параметры

Возвращаемое значение

Повторно применяет все текущие фильтры к таблице.

reapplyFilters(): void;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.2 ]

Измените размер таблицы до нового диапазона. Новый диапазон должен перекрываться с исходным диапазоном таблицы, а заголовки (или верхняя часть таблицы) должны находиться в одной строке.

resize(newRange: Range | string): void;

Параметры

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.13 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/resize-table.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet and a table on that worksheet.
  const sheet = context.workbook.worksheets.getItem("Sample");
  const expensesTable = sheet.tables.getItem("ExpensesTable");
  
  // Resize the table.
  expensesTable.resize("A1:D20");
  
  await context.sync();
});

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

Возвращаемое значение

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.Table): void;

Параметры

Возвращаемое значение

Задает стиль, применяемый к таблице.

setStyle(style: string | TableStyle | BuiltInTableStyle): void;

Параметры

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.Table является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TableData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.TableData;

Возвращаемое значение

Происходит при изменении данных в ячейках в определенной таблице.

readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;

Тип события

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml

await Excel.run(async (context) => {
    let table = context.workbook.tables.getItemAt(0);
    table.onChanged.add(onChange);

    await context.sync();
    console.log("A handler has been registered for the onChanged event");
});

Происходит при применении фильтра к определенной таблице.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>;

Тип события

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Происходит при изменении выделения в определенной таблице.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.TableSelectionChangedEventArgs>;

Тип события

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml

await Excel.run(async (context) => {
    let table = context.workbook.tables.getItemAt(0);
    table.onSelectionChanged.add(onSelectionChange);

    await context.sync();
    console.log("A handler has been registered for table onSelectionChanged event");
});