Excel.PivotField class

パッケージ:

excel

Excel PivotField を表します。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.8 ]

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
id	PivotField の ID。
items	PivotField に関連付けられている PivotItems を返します。
name	PivotField の名前。
showAllItems	PivotField のすべての項目を表示するかどうかを指定します。
subtotals	PivotField の小計。

メソッド

load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
sortByLabels(sortBy)	PivotField を並べ替えます。 DataPivotHierarchy を指定すると、そのピボット階層に基づいて並べ替えが適用されます。指定しない場合、ピボット フィールド自体が並べ替えの基準になります。
sortByValues(sortBy, valuesHierarchy, pivotItemScope)	与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。 スコープは、同じ DataPivotHierarchy から複数の値がある場合に並べ替えに使用する特定の値を定義します。
sortByValues(sortByString, valuesHierarchy, pivotItemScope)	与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。 スコープは、同じ DataPivotHierarchy から複数の値がある場合に並べ替えに使用する特定の値を定義します。
toJSON()	API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PivotField オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PivotFieldData として型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

id

PivotField の ID。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.8 ]

items

PivotField に関連付けられている PivotItems を返します。

readonly items: Excel.PivotItemCollection;

プロパティ値

Excel.PivotItemCollection

注釈

[ API セット: ExcelApi 1.8 ]

name

PivotField の名前。

name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.8 ]

showAllItems

PivotField のすべての項目を表示するかどうかを指定します。

showAllItems: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

subtotals

PivotField の小計。

subtotals: Excel.Subtotals;

プロパティ値

Excel.Subtotals

注釈

[ API セット: ExcelApi 1.8 ]

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField;

パラメーター

options

Excel.Interfaces.PivotFieldLoadOptions

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

戻り値

Excel.PivotField

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.PivotField

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Excel.PivotField

set(properties, options)

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

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

パラメーター

properties

Excel.Interfaces.PivotFieldUpdateData

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

options

OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.PivotField): void;

パラメーター

properties

Excel.PivotField

戻り値

void

sortByLabels(sortBy)

PivotField を並べ替えます。 DataPivotHierarchy を指定すると、そのピボット階層に基づいて並べ替えが適用されます。指定しない場合、ピボット フィールド自体が並べ替えの基準になります。

sortByLabels(sortBy: SortBy): void;

パラメーター

sortBy

Excel.SortBy

並べ替えが昇順または降順で行われるかどうかを指定します。

戻り値

void

注釈

[ API セット: ExcelApi 1.8 ]

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。 スコープは、同じ DataPivotHierarchy から複数の値がある場合に並べ替えに使用する特定の値を定義します。

sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;

パラメーター

sortBy

Excel.SortBy

並べ替えが昇順または降順で行われるかどうかを指定します。

valuesHierarchy

Excel.DataPivotHierarchy

並べ替えに使用するデータ軸の値階層を指定します。

pivotItemScope

Array<Excel.PivotItem | string>

並べ替えのスコープに使用する必要がある項目。 これらは、並べ替える行または列を構成する項目です。 PivotItem の代わりに文字列を使用する場合、文字列は PivotItem の ID を表します。 並べ替える軸にデータ階層以外の項目がない場合は、空にすることができます。

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

sortByValues(sortByString, valuesHierarchy, pivotItemScope)

与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。 スコープは、同じ DataPivotHierarchy から複数の値がある場合に並べ替えに使用する特定の値を定義します。

sortByValues(sortByString: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;

パラメーター

sortByString

"Ascending" | "Descending"

並べ替えが昇順または降順で行われるかどうかを指定します。

valuesHierarchy

Excel.DataPivotHierarchy

並べ替えに使用するデータ軸の値階層を指定します。

pivotItemScope

Array<Excel.PivotItem | string>

並べ替えのスコープに使用する必要がある項目。 これらは、並べ替える行または列を構成する項目です。 PivotItem の代わりに文字列を使用する場合、文字列は PivotItem の ID を表します。 並べ替える軸にデータ階層以外の項目がない場合は、空にすることができます。

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

toJSON()

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

toJSON(): Excel.Interfaces.PivotFieldData;

戻り値

Excel.Interfaces.PivotFieldData