Class PivotTable

ピボットテーブルの集計を取り扱うクラスです。

Methods

addCustomField addCustomItem deleteCustomField deleteCustomItem deleteCustomItemPartial getField getFields getGrandTotalLayoutType getLayoutType getPivotTableSetting getSubTotalsLayoutType refresh refreshData setFields upadteCustomItemPartial

Methods

addCustomField

  • addCustomField(customFieldName, customFieldFormula, numberFormat?): void

  • カスタムフィールドの追加を行います。

    1. refreshメソッドを呼ばない限り、カスタムフィールドを追加しただけでは、集計値が反映されません。最後に、refreshメソッドを必ず呼んでください。
    2. customFieldFormulaの数式は、通常ピボットフィールドのフィールド名を含みますが、その際、クォーテーション等で囲む必要がありません。(例： フィールドA * 2 と設定)

    Parameters

    • customFieldName: string

      カスタムフィールド名

    • customFieldFormula: string

      カスタムフィールドの集計式

    • numberFormat: string = ""

      表記書式を指定する場合は、指定可能です。空文字を設定すると、表記書式は設定されません。

    Returns void

addCustomItem

  • addCustomItem(itemName, targetFieldName, customItemFormula): void

  • 集計アイテムの追加を行います。

    1. refreshメソッドを呼ばない限り、集計アイテムを追加しただけでは、集計値が反映されません。最後に、refreshメソッドを必ず呼んでください。
    2. customFieldFormulaの数式は、通常ピボットフィールドのフィールド名および項目名を含みますが、その際、クォーテーション等で囲む必要がありません。(例： フィールドA[項目あ] * 2 と設定)

    Parameters

    • itemName: string

      集計アイテムの名前

    • targetFieldName: string

      追加する集計アイテムが属するピボットフィールドの項目名

    • customItemFormula: string

      集計アイテムの集計式

    Returns void

deleteCustomField

  • deleteCustomField(customFieldName): void

  • カスタムフィールドの削除を行います。

    1. refreshメソッドを呼ばない限り、カスタムフィールドを削除しただけでは、集計値が反映されません。最後に、refreshメソッドを必ず呼んでください。

    Parameters

    • customFieldName: string

      カスタムフィールド名

    Returns void

deleteCustomItem

  • deleteCustomItem(itemName, targetFieldName): void

  • 集計アイテムの削除を行います。

    1. refreshメソッドを呼ばない限り、集計アイテムを削除しただけでは、集計値が反映されません。最後に、refreshメソッドを必ず呼んでください。
    2. upadteCustomItemPartialメソッドで追加した部分アイテムが集計アイテムに所属していた場合、削除します。

    Parameters

    • itemName: string

      集計アイテムの名前

    • targetFieldName: string

      削除する集計アイテムが属するピボットフィールドの項目名

    Returns void

deleteCustomItemPartial

  • deleteCustomItemPartial(itemName, rowItems, colItems, dataFieldName): void

  • 集計アイテムの部分更新(集計アイテム中の単一セルを別の集計式にする)の削除を行います。

    1. refreshメソッドを呼ばない限り、集計アイテムの部分更新の削除だけでは、集計値が反映されません。最後に、refreshメソッドを必ず呼んでください。

    Parameters

    • itemName: string

      セットした集計式の所属するアイテム名

    • rowItems: string[]

      部分更新したセルの行方向の値を上から記述した Array<集計する行の値>

    • colItems: string[]

      部分更新したセルの列方向の値を上から記述した Array<集計する列の値>

    • dataFieldName: string

      対象のデータフィールド名

    Returns void

getField

  • getField(fieldName): PivotFieldObject

  • ピボットテーブルのフィールド情報を取得します。

    Parameters

    • fieldName: string

      フィールド名

    Returns PivotFieldObject

    ピボットフィールドオブジェクト

getFields

  • getFields(): PivotFieldObject[]

  • ピボットフィールドの全取得を行います。

    Returns PivotFieldObject[]

    Array<ピボットフィールドオブジェクト>

getGrandTotalLayoutType

getLayoutType

getPivotTableSetting

getSubTotalsLayoutType

refresh

  • refresh(): void

  • ピボットテーブルの再集計を行います。

    1. フィールド構成の変更やフィールドの追加や削除が行われた場合、このメソッドで反映させます。集計元のデータはそのままです

    Returns void

refreshData

  • refreshData(): void

  • 集計元のデータを最新化した上、再集計します。

    1. 集計元のデータが変更されていた場合、ピボットテーブルの集計に反映させます。

    Returns void

setFields

  • setFields(settings, layoutType, rowFields, colFields, filterFields, dataFields, grandTotalLayoutType?, subtotalsLayoutType?, specialDataFieldDirectionCol?, specialDataFieldOrder?): void

  • ピボット集計の実行を行います。

    1. dataFieldsが複数ある場合、集計アイテム(Σ)をCol方向またはRow方向に置く必要がありますが、specialDataFieldDirectionColは、この方向を決めます。
    2. dataFieldsが単一の時、specialDataFieldDirectionColおよびspecialDataFieldOrderは無視されます。

    Parameters

    • settings: PivotTableSettingObject

      ピボットテーブルの設定項目オブジェクト

    • layoutType: XlPivotTableLayoutType

      レポートのレイアウトタイプ

    • rowFields: PivotFieldObject[]

      行におくピボットフィールド

    • colFields: PivotFieldObject[]

      列におくピボットフィールド

    • filterFields: PivotFieldObject[]

      フィルター条件におくピボットフィールド

    • dataFields: PivotFieldObject[]

      集計対象のピボットフィールド(データ項目)

    • grandTotalLayoutType: XlPivotTableDisplayGrandTotalType = enums.XlPivotTableDisplayGrandTotalType.RowsAndColumns

      末尾の集計フィールドの有無およびおく方向

    • subtotalsLayoutType: XlPivotTableDisplaySubtotalsType = enums.XlPivotTableDisplaySubtotalsType.SubtotalsDisplayTypeBottom

      末尾の集計フィールドの集計位置

    • specialDataFieldDirectionCol: boolean = true

      (dataFieldsが複数の時) true:集計アイテム(Σ)を列側に配置 false:集計アイテム(Σ)を行側に配置

    • specialDataFieldOrder: number = -1

      (dataFieldsが複数の時) 集計アイテム(Σ)の位置 -1は最後尾を表します。1から始まります。

    Returns void

upadteCustomItemPartial

  • upadteCustomItemPartial(itemName, customItemFormula, rowItems, colItems, dataFieldName): void

  • 集計アイテムの部分更新(集計アイテム中の単一セルを別の集計式にする)を行います。

    1. refreshメソッドを呼ばない限り、集計アイテムの部分更新だけでは、集計値が反映されません。最後に、refreshメソッドを必ず呼んでください。
    2. customItemFormulaの数式は、通常ピボットフィールドのフィールド名および項目名を含みますが、その際、クォーテーション等で囲む必要がありません。(例： フィールドA[項目あ] * 2 と設定)

    Parameters

    • itemName: string

      セットする集計式の所属するアイテム名

    • customItemFormula: string

      セットする集計式

    • rowItems: string[]

      部分更新するセルの行方向の値を上から記述した Array<集計する行の値>

    • colItems: string[]

      部分更新するセルの列方向の値を上から記述した Array<集計する列の値>

    • dataFieldName: string

      対象のデータフィールド名

    Returns void

Settings

Member Visibility

Theme

On This Page

   Copyright © 2023. OSB-OFFICE.Inc, All rights reserved.   Generated using TypeDoc