Excel.PivotField class

パッケージ:
excel

Excel のピボットフィールドを表します。

Extends
OfficeExtension.ClientObject

注釈

API セット: ExcelApi 1.8

使用元

プロパティ

context

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

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

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

PivotField の名前。
showAllItems

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

PivotField の小計。

メソッド

applyFilter(filter)

フィールドの現在のピボットフィルターの 1 つ以上を設定し、フィールドに適用します。 指定されたフィルターが無効であるか適用できない場合は、例外がスローされます。
clearAllFilters()

フィールドのすべてのフィルターからすべての条件をクリアします。 これにより、フィールドでのアクティブなフィルター処理が削除されます。
clearFilter(filterType)

指定された種類のフィールドのフィルターから、既存のすべての抽出条件をクリアします (現在抽出条件が適用されている場合)。
clearFilter(filterType)

指定された種類のフィールドのフィルターから、既存のすべての抽出条件をクリアします (現在抽出条件が適用されている場合)。
getFilters()

フィールドに現在適用されているすべてのフィルターを取得します。
isFiltered(filterType)

フィールドに適用されたフィルターがあるかどうかを確認します。
isFiltered(filterType)

フィールドに適用されたフィルターがあるかどうかを確認します。
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(sortBy, 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

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

readonly id: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.8

items

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

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

メソッドの詳細

applyFilter(filter)

フィールドの現在のピボットフィルターの 1 つ以上を設定し、フィールドに適用します。 指定されたフィルターが無効であるか適用できない場合は、例外がスローされます。

applyFilter(filter: Excel.PivotFilters): void;

パラメーター

filter
Excel.PivotFilters

構成済みの特定の PivotFilter、または複数の構成済みフィルターを含む PivotFilters インターフェイス。

返品

void

注釈

API セット: ExcelApi 1.12

clearAllFilters()

フィールドのすべてのフィルターからすべての条件をクリアします。 これにより、フィールドでのアクティブなフィルター処理が削除されます。

clearAllFilters(): void;

返品

void

注釈

API セット: ExcelApi 1.12

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml

await Excel.run(async (context) => {
  // Clear all the PivotFilters.

  // Get the PivotTable.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
  pivotTable.hierarchies.load("name");
  await context.sync();

  // Clear the filters on each PivotField.
  pivotTable.hierarchies.items.forEach((hierarchy) => {
    hierarchy.fields.getItem(hierarchy.name).clearAllFilters();
  });
  await context.sync();
});

clearFilter(filterType)

指定された種類のフィールドのフィルターから、既存のすべての抽出条件をクリアします (現在抽出条件が適用されている場合)。

clearFilter(filterType: Excel.PivotFilterType): void;

パラメーター

filterType
Excel.PivotFilterType

すべての条件をクリアするフィールドのフィルターの種類。

返品

void

注釈

API セット: ExcelApi 1.12

clearFilter(filterType)

指定された種類のフィールドのフィルターから、既存のすべての抽出条件をクリアします (現在抽出条件が適用されている場合)。

clearFilter(filterType: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;

パラメーター

filterType

"Unknown" | "Value" | "Manual" | "Label" | "Date"

すべての条件をクリアするフィールドのフィルターの種類。

返品

void

注釈

API セット: ExcelApi 1.12

getFilters()

フィールドに現在適用されているすべてのフィルターを取得します。

getFilters(): OfficeExtension.ClientResult<Excel.PivotFilters>;

返品

OfficeExtension.ClientResult<Excel.PivotFilters>

すべてのアクティブなフィルターを含む PivotFilters インターフェイス。

注釈

API セット: ExcelApi 1.12

isFiltered(filterType)

フィールドに適用されたフィルターがあるかどうかを確認します。

isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult<boolean>;

パラメーター

filterType
Excel.PivotFilterType

チェックするフィルターの種類。 型が指定されていない場合、このメソッドはフィルターが適用されているかどうかをチェックします。

返品

OfficeExtension.ClientResult<boolean>

フィールドに filterType タイプのフィルターが適用されている場合は true。 filterTypeが指定されていない場合、フィールドにフィルターが適用されていればtrueが返されます。

注釈

API セット: ExcelApi 1.12

isFiltered(filterType)

フィールドに適用されたフィルターがあるかどうかを確認します。

isFiltered(filterType?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;

パラメーター

filterType

"Unknown" | "Value" | "Manual" | "Label" | "Date"

チェックするフィルターの種類。 型が指定されていない場合、このメソッドはフィルターが適用されているかどうかをチェックします。

返品

OfficeExtension.ClientResult<boolean>

フィールドに filterType タイプのフィルターが適用されている場合は true。 filterTypeが指定されていない場合、フィールドにフィルターが適用されていればtrueが返されます。

注釈

API セット: ExcelApi 1.12

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

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

返品

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>

並べ替えの範囲に使用するアイテム。 これらは、並べ替える行または列を構成するアイテムです。 ピボット項目の代わりに文字列が使用されている場合、文字列はピボット項目の ID を表します。 並べ替える軸にデータ階層以外の項目がない場合、これは空にすることができます。

返品

void

注釈

API セット: ExcelApi 1.9

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

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

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

パラメーター

sortBy

"Ascending" | "Descending"

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

valuesHierarchy
Excel.DataPivotHierarchy

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

pivotItemScope

Array<Excel.PivotItem | string>

並べ替えの範囲に使用するアイテム。 これらは、並べ替える行または列を構成するアイテムです。 ピボット項目の代わりに文字列が使用されている場合、文字列はピボット項目の 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