Excel.Interfaces.TableColumnLoadOptions interface

テーブル内にある 1 つの列を表します。

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

filter

列に適用されているフィルターを取得します。

id

テーブル内の列を識別する一意のキーを返します。

index

テーブルの列コレクション内の列のインデックス番号を返します。 0 を起点とする番号になります。

name

テーブルの列の名前を指定します。

values

指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

valuesAsJson

このテーブル列のセルの値の JSON 表現。 TableColumn.values とは異なり、TableColumn.valuesAsJson はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常に en-US ロケールに合わせて調整されます。 ユーザーの表示ロケールでデータを取得するには、 TableColumn.valuesAsJsonLocal を使用します。

valuesAsJsonLocal

このテーブル列のセルの値の JSON 表現。 TableColumn.values とは異なり、TableColumn.valuesAsJsonLocal はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常にユーザーの表示ロケールに合わせて調整されます。 ロケールに関係なくデータを取得するには、 TableColumn.valuesAsJson を使用します。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

filter

列に適用されているフィルターを取得します。

filter?: Excel.Interfaces.FilterLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.2

id

テーブル内の列を識別する一意のキーを返します。

id?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

index

テーブルの列コレクション内の列のインデックス番号を返します。 0 を起点とする番号になります。

index?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

name

テーブルの列の名前を指定します。

name?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1 (名前の取得用)。1.4 設定を行います。

values

指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

values?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

valuesAsJson

このテーブル列のセルの値の JSON 表現。 TableColumn.values とは異なり、TableColumn.valuesAsJson はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常に en-US ロケールに合わせて調整されます。 ユーザーの表示ロケールでデータを取得するには、 TableColumn.valuesAsJsonLocal を使用します。

valuesAsJson?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.16

valuesAsJsonLocal

このテーブル列のセルの値の JSON 表現。 TableColumn.values とは異なり、TableColumn.valuesAsJsonLocal はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常にユーザーの表示ロケールに合わせて調整されます。 ロケールに関係なくデータを取得するには、 TableColumn.valuesAsJson を使用します。

valuesAsJsonLocal?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.16