Excel.Table class

アクセシビリティの代替テキストを指定します。

altTextDescription: string;

プロパティ値

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

スクリーン リーダーで使用されるものなど、表の概要を指定します。

altTextTitle: string;

プロパティ値

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

テーブルの AutoFilter オブジェクトを表します。

readonly autoFilter: Excel.AutoFilter;

プロパティ値

注釈

API セット: ExcelApi 1.9

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

readonly columns: Excel.TableColumnCollection;

プロパティ値

注釈

API セット: ExcelApi 1.1

テーブルに関連付けられているコメントを指定します。

comment: string;

プロパティ値

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

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

context: RequestContext;

プロパティ値

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

highlightFirstColumn: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.3

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

highlightLastColumn: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.3

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

readonly id: string;

プロパティ値

注釈

API セット: ExcelApi 1.1

テーブルが現在アクティブかどうかを取得します。

readonly isActive: boolean;

プロパティ値

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

数値 ID を返します。

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

テーブルの元のデータ ソースの型を取得します。

readonly source: Excel.TableSource | "External" | "Range" | "Xml" | "Query" | "Model";

プロパティ値

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

表のスタイルを表す定数値。 指定可能な値は、"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 ベータ版 (プレビューのみ)

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

readonly worksheet: Excel.Worksheet;

プロパティ値

注釈

API セット: ExcelApi 1.2

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

clearFilters(): void;

返品

注釈

API セット: ExcelApi 1.2

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

clearStyle(): void;

返品

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

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

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 ベータ版 (プレビューのみ)

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、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 ベータ版 (プレビューのみ)

特定のテーブルの選択が変更されたときに発生します。

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