Excel.PivotField class

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

context: RequestContext;

プロパティ値

ピボットフィールドの ID。

readonly id: string;

プロパティ値

注釈

API セット: ExcelApi 1.8

ピボットフィールドに関連付けられているピボット項目を返します。

readonly items: Excel.PivotItemCollection;

プロパティ値

注釈

API セット: ExcelApi 1.8

PivotField の名前。

name: string;

プロパティ値

注釈

API セット: ExcelApi 1.8

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

showAllItems: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.8

PivotField の小計。

subtotals: Excel.Subtotals;

プロパティ値

注釈

API セット: ExcelApi 1.8

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Excel.PivotField): void;

パラメーター

返品

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

sortByLabels(sortBy: SortBy): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.8

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

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

パラメーター

返品

注釈

API セット: ExcelApi 1.9

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

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

パラメーター

返品

注釈

API セット: ExcelApi 1.9

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

toJSON(): Excel.Interfaces.PivotFieldData;

返品