Excel. Table class

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

highlightFirstColumn

最初の列に特別な書式が含まれているかどうかを指定します。

highlightFirstColumn: boolean;

プロパティ値

boolean

注釈

highlightLastColumn

最後の列に特別な書式が設定されているかどうかを指定します。

highlightLastColumn: boolean;

プロパティ値

boolean

注釈

id

指定されたブックのテーブルを一意に識別する値を返します。識別子の値は、テーブルの名前が変更された場合も変わりません。

readonly id: string;

プロパティ値

string

注釈

legacyId

数値 ID を返します。

readonly legacyId: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.8

name

テーブルの名前。

テーブルのセット名は、「 Excel テーブルの名前を変更する」の記事で指定されているガイドラインに従う必要があります。

name: string;

プロパティ値

string

注釈

例

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.add('A1:E7', true);
    expensesTable.name = "ExpensesTable";

    await context.sync();
});

rows

テーブルに含まれるすべての行のコレクションを表します。

readonly rows: Excel.TableRowCollection;

プロパティ値

Excel.TableRowCollection

注釈

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/add-rows-and-columns-to-a-table.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");

    expensesTable.rows.add(null, [
    ["1/16/2017", "THE PHONE COMPANY", "Communications", "$120"],
    ["1/20/2017", "NORTHWIND ELECTRIC CARS", "Transportation", "$142"],
    ["1/20/2017", "BEST FOR YOU ORGANICS COMPANY", "Groceries", "$27"]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    sheet.getUsedRange().format.autofitRows();

    await context.sync();
});

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;

プロパティ値

Excel.TableSort

注釈

例

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");

    // Sort the table by the "Amount" column.
    const sortFields = [
        {
        key: 3,
        ascending: false
        }
    ];
    expensesTable.sort.apply(sortFields);

    await context.sync();
});

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;

プロパティ値

Excel.Worksheet

注釈

clearFilters()

現在テーブルに適用されているすべてのフィルターをクリアします。

clearFilters(): void;

返品

void

注釈

例

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable = sheet.tables.getItem("ExpensesTable");
    expensesTable.clearFilters();
    await context.sync();
   });

convertToRange()

テーブルを通常の範囲のセルに変換します。すべてのデータが保持されます。

convertToRange(): Excel.Range;

返品

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;

返品

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;

返品

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;

返品

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;

返品

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;

パラメーター

options: Excel.Interfaces.TableLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Excel.Table

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

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

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Excel.Table

reapplyFilters()

現在テーブルにあるすべてのフィルターを再適用します。

reapplyFilters(): void;

返品

void

注釈