Excel.Interfaces.TableData interface

table.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。

注釈

使用元

プロパティ

altTextDescription

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

altTextTitle

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

autoFilter

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

columns

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

comment

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

highlightFirstColumn

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

highlightLastColumn

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

id

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

isActive

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

legacyId

数値 ID を返します。

name

テーブルの名前。

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

rows

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

showBandedColumns

テーブルを読みやすくするために、奇数列が偶数列とは異なる方法で強調表示される縞模様の書式設定を列に表示するかどうかを指定します。

showBandedRows

表を読みやすくするために、奇数行と偶数行が異なるように強調表示される縞模様の書式設定を行にするかどうかを指定します。

showFilterButton

各列ヘッダーの上部にフィルター ボタンを表示するかどうかを指定します。 これは、テーブルにヘッダー行が含まれている場合のみ設定できます。

showHeaders

ヘッダー行を表示するかどうかを指定します。 この値によって、ヘッダー行の表示または削除を設定できます。

showTotals

合計行を表示するかどうかを指定します。 この値によって、集計行の表示または削除を設定できます。

sort

テーブル内の並べ替えを表します。

source

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

style

表のスタイルを表す定数値。 指定可能な値は、"TableStyleLight1" から "TableStyleLight21"、"TableStyleMedium1" から "TableStyleMedium28"、"TableStyleDark1" から "TableStyleDark11" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。

tableStyle

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

プロパティの詳細

altTextDescription

注意

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

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

altTextDescription?: string;

プロパティ値

string

注釈

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

altTextTitle

注意

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

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

altTextTitle?: string;

プロパティ値

string

注釈

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

autoFilter

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

autoFilter?: Excel.Interfaces.AutoFilterData;

プロパティ値

注釈

API セット: ExcelApi 1.9

columns

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

columns?: Excel.Interfaces.TableColumnData[];

プロパティ値

注釈

API セット: ExcelApi 1.1

comment

注意

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

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

comment?: string;

プロパティ値

string

注釈

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

highlightFirstColumn

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

highlightFirstColumn?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

highlightLastColumn

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

highlightLastColumn?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

id

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

id?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.1

isActive

注意

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

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

isActive?: boolean;

プロパティ値

boolean

注釈

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

legacyId

数値 ID を返します。

legacyId?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.8

name

テーブルの名前。

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

name?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.1

rows

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

rows?: Excel.Interfaces.TableRowData[];

プロパティ値

注釈

API セット: ExcelApi 1.1

showBandedColumns

テーブルを読みやすくするために、奇数列が偶数列とは異なる方法で強調表示される縞模様の書式設定を列に表示するかどうかを指定します。

showBandedColumns?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

showBandedRows

表を読みやすくするために、奇数行と偶数行が異なるように強調表示される縞模様の書式設定を行にするかどうかを指定します。

showBandedRows?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

showFilterButton

各列ヘッダーの上部にフィルター ボタンを表示するかどうかを指定します。 これは、テーブルにヘッダー行が含まれている場合のみ設定できます。

showFilterButton?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

showHeaders

ヘッダー行を表示するかどうかを指定します。 この値によって、ヘッダー行の表示または削除を設定できます。

showHeaders?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

showTotals

合計行を表示するかどうかを指定します。 この値によって、集計行の表示または削除を設定できます。

showTotals?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

sort

テーブル内の並べ替えを表します。

sort?: Excel.Interfaces.TableSortData;

プロパティ値

注釈

API セット: ExcelApi 1.2

source

注意

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

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

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

プロパティ値

Excel.TableSource | "External" | "Range" | "Xml" | "Query" | "Model"

注釈

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

style

表のスタイルを表す定数値。 指定可能な値は、"TableStyleLight1" から "TableStyleLight21"、"TableStyleMedium1" から "TableStyleMedium28"、"TableStyleDark1" から "TableStyleDark11" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。

style?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.1

tableStyle

注意

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

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

tableStyle?: Excel.Interfaces.TableStyleData;

プロパティ値

注釈

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