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

注釈

rows

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

readonly rows: Excel.TableRowCollection;

プロパティ値

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;

プロパティ値

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

tableStyle

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

テーブルに適用されるスタイル。

readonly tableStyle: Excel.TableStyle;

プロパティ値

Excel.TableStyle

注釈

worksheet

現在のテーブルを含んでいるワークシート。

readonly worksheet: Excel.Worksheet;

プロパティ値

Excel.Worksheet

注釈

メソッドの詳細

clearFilters()

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

clearFilters(): void;

戻り値

void

注釈

clearStyle()

注意

既定のテーブルスタイルを使用するようにテーブルを変更します。

clearStyle(): void;

戻り値

void

注釈

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)

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)

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

パラメーター

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

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

戻り値

Excel.Table

reapplyFilters()

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

reapplyFilters(): void;

戻り値

void

注釈

resize(newRange)

テーブルのサイズを新しい範囲に変更します。新しい範囲は元のテーブル範囲と重複する必要があり、ヘッダー (またはテーブルの先頭) は同じ行に存在する必要があります。

resize(newRange: Range | string): void;

パラメーター

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

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

properties: Excel.Interfaces.TableUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.Table): void;

パラメーター

properties: Excel.Table

戻り値

void

setStyle(style)

注意

テーブルに適用されるスタイルを設定します。

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

パラメーター

style: string | Excel.TableStyle | Excel.BuiltInTableStyle

テーブルに適用するスタイル。スタイルの名前と一致しない文字列が指定されている場合、 InvalidArgumentException がスローされます。

戻り値

void

注釈

OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Table オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TableData として型指定) を返します。

toJSON(): Excel.Interfaces.TableData;

戻り値

Excel.Interfaces.TableData

イベントの詳細

onChanged

セル内のデータが特定のテーブルで変更されたときに発生します。

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

onFiltered

注意

特定のテーブルにフィルターが適用されると発生します。

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

イベントの種類

OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>

注釈