Excel.PivotField class

PivotHierarchy 内の単一のピボットフィールドを表します。Represents a single pivot field within a PivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

id

PivotField の ID。Id of the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

items

PivotField を構成する PivotItems を返します。Returns the PivotItems that comprise the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

name

PivotField の名前。Name of the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

showAllItems

PivotField のすべての項目を表示するかどうかを指定します。Determines whether to show all items of the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

subtotals

PivotField の小計。Subtotals of the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

メソッド

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

sortByLabels(sortBy)

PivotField を並べ替えます。Sorts the PivotField. DataPivotHierarchy を指定すると、そのピボット階層に基づいて並べ替えが適用されます。指定しない場合、ピボット フィールド自体が並べ替えの基準になります。If a DataPivotHierarchy is specified, then sort will be applied based on it, if not sort will be based on the PivotField itself.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。Sorts the PivotField by specified values in a given scope. 範囲では、同じ DataPivotHierarchy の複数の値がある場合に、並べ替えに使用する特定の値を定義します。The scope defines which specific values will be used to sort when there are multiple values from the same DataPivotHierarchy.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

sortByValues(sortByString, valuesHierarchy, pivotItemScope)

与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。Sorts the PivotField by specified values in a given scope. 範囲では、同じ DataPivotHierarchy の複数の値がある場合に、並べ替えに使用する特定の値を定義します。The scope defines which specific values will be used to sort when there are multiple values from the same DataPivotHierarchy.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の PivotField オブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.PivotFieldData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotField object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotFieldData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

id

PivotField の ID。Id of the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly id: string;

プロパティ値

string

items

PivotField を構成する PivotItems を返します。Returns the PivotItems that comprise the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly items: Excel.PivotItemCollection;

プロパティ値

name

PivotField の名前。Name of the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

name: string;

プロパティ値

string

showAllItems

PivotField のすべての項目を表示するかどうかを指定します。Determines whether to show all items of the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

showAllItems: boolean;

プロパティ値

boolean

subtotals

PivotField の小計。Subtotals of the PivotField.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

subtotals: Excel.Subtotals;

プロパティ値

メソッドの詳細

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.PivotField-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.PivotField - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.PivotField-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.PivotField - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotField-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotField - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.PivotFieldUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.PivotField): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.PivotField): void;

パラメーター

properties
Excel.PivotField

戻り値

void

sortByLabels(sortBy)

PivotField を並べ替えます。Sorts the PivotField. DataPivotHierarchy を指定すると、そのピボット階層に基づいて並べ替えが適用されます。指定しない場合、ピボット フィールド自体が並べ替えの基準になります。If a DataPivotHierarchy is specified, then sort will be applied based on it, if not sort will be based on the PivotField itself.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

sortByLabels(sortBy: SortBy): void;

パラメーター

sortBy
SortBy

並べ替えが昇順または降順のどちらで行われるかを表します。Represents whether the sorting is done in an ascending or descending order.

戻り値

void

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。Sorts the PivotField by specified values in a given scope. 範囲では、同じ DataPivotHierarchy の複数の値がある場合に、並べ替えに使用する特定の値を定義します。The scope defines which specific values will be used to sort when there are multiple values from the same DataPivotHierarchy.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

パラメーター

sortBy
Excel.SortBy

並べ替えが昇順または降順のどちらで行われるかを表します。Represents whether the sorting is done in an ascending or descending order.

valuesHierarchy
Excel.DataPivotHierarchy

並べ替えに使用するデータ軸の値階層を指定します。Specifies the values hierarchy on the data axis to be used for sorting.

pivotItemScope
Array<PivotItem | string>

並べ替えの範囲として使用するアイテムを指定します。The items that should be used for the scope of the sorting. これらは、並べ替えの基準となる行または列を構成するアイテムになります。These will be the items that make up the row or column that you want to sort on. PivotItem の代わりに文字列を使用する場合、文字列は PivotItem の ID を表します。If a string is used instead of a PivotItem, the string represents the ID of the PivotItem. 並べ替えの基準となるデータ階層以外のアイテムが軸上にない場合、この値は空になることがあります。If there are no items other than data hierarchy on the axis you want to sort on, this can be empty.

戻り値

void

sortByValues(sortByString, valuesHierarchy, pivotItemScope)

与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。Sorts the PivotField by specified values in a given scope. 範囲では、同じ DataPivotHierarchy の複数の値がある場合に、並べ替えに使用する特定の値を定義します。The scope defines which specific values will be used to sort when there are multiple values from the same DataPivotHierarchy.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

パラメーター

sortByString
"Ascending" | "Descending"

並べ替えが昇順または降順のどちらで行われるかを表します。Represents whether the sorting is done in an ascending or descending order.

valuesHierarchy
Excel.DataPivotHierarchy

並べ替えに使用するデータ軸の値階層を指定します。Specifies the values hierarchy on the data axis to be used for sorting.

pivotItemScope
Array<PivotItem | string>

並べ替えの範囲として使用するアイテムを指定します。The items that should be used for the scope of the sorting. これらは、並べ替えの基準となる行または列を構成するアイテムになります。These will be the items that make up the row or column that you want to sort on. PivotItem の代わりに文字列を使用する場合、文字列は PivotItem の ID を表します。If a string is used instead of a PivotItem, the string represents the ID of the PivotItem. 並べ替えの基準となるデータ階層以外のアイテムが軸上にない場合、この値は空になることがあります。If there are no items other than data hierarchy on the axis you want to sort on, this can be empty.

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の PivotField オブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.PivotFieldData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotField object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotFieldData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.PivotFieldData;

戻り値