pyosbxl.PivotTable

class documentation

class PivotTable:

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

Method	`addCustomField`	カスタムフィールドの追加を行います。
Method	`addCustomItem`	集計アイテムの追加を行います。
Method	`deleteCustomField`	カスタムフィールドの削除を行います。
Method	`deleteCustomItem`	集計アイテムの削除を行います。
Method	`deleteCustomItemPartial`	集計アイテムの部分更新(集計アイテム中の単一セルを別の集計式にする)の削除を行います。
Method	`getField`	ピボットテーブルのフィールド情報を取得します。
Method	`getFields`	ピボットフィールドの全取得を行います。
Method	`getGrandTotalLayoutType`	ピボット集計の末尾集計行の有無(行および列)の取得を行います。
Method	`getLayoutType`	ピボット集計のレイアウトタイプの取得を行います。
Method	`getPivotTableSetting`	ピボットテーブルの設定項目を取得します。
Method	`getSubTotalsLayoutType`	ピボット集計の末尾集計行の集計位置の取得を行います。
Method	`refresh`	ピボットテーブルの再集計を行います。フィールド構成の変更やフィールドの追加や削除が行われた場合、このメソッドで反映させます。集計元のデータはそのままです。
Method	`refreshData`	集計元のデータを最新化した上、再集計します。集計元のデータが変更されていた場合、ピボットテーブルの集計に反映させます。
Method	`setFields`	ピボット集計の実行を行います。
Method	`upadteCustomItemPartial`	集計アイテムの部分更新(集計アイテム中の単一セルを別の集計式にする)を行います。

def addCustomField(self, customFieldName: str, customFieldFormula: str, numberFormat: str = ''): ¶

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

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

customFieldFormulaの数式は、通常ピボットフィールドのフィールド名を含みますが、クォーテーション等で囲む必要がありません。(例：フィールドA * 2)

Parameters
customFieldName:`str`	カスタムフィールド名
customFieldFormula:`str`	カスタムフィールドの集計式
numberFormat:`str`, optional	表記書式を指定する場合は、指定可能です。空文字を設定すると、表記書式は設定されません。

def addCustomItem(self, itemName: str, targetFieldName: str, customItemFormula: str): ¶

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

refreshメソッドを呼ばない限り、集計アイテムを追加しただけでは、集計値が反映されません。最後に、refreshメソッドを必ず呼んでください。

customFieldFormulaの数式は、通常ピボットフィールドのフィールド名および項目名を含みますが、その際、クォーテーション等で囲む必要がありません。(例：フィールドA[項目あ] * 2 と設定)

Parameters
itemName:`str`	集計アイテムの名前
targetFieldName:`str`	追加する集計アイテムが属するピボットフィールドの項目名
customItemFormula:`str`	集計アイテムの集計式

def deleteCustomField(self, customFieldName: str): ¶

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

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

Parameters
customFieldName:`str`	カスタムフィールド名

def deleteCustomItem(self, itemName: str, targetFieldName: str): ¶

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

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

upadteCustomItemPartialメソッドで追加した部分アイテムが集計アイテムに所属していた場合、削除します。

Parameters
itemName:`str`	集計アイテムの名前
targetFieldName:`str`	削除する集計アイテムが属するピボットフィールドの項目名

def deleteCustomItemPartial(self, itemName: str, rowItems: dto.VectorString, colItems: dto.VectorString, dataFieldName: str): ¶

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

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

Parameters
itemName:`str`	セットした集計式の所属するアイテム名
rowItems:`VectorString`	部分更新したセルの行方向の値を上から記述した List＜集計する行の値＞
colItems:`VectorString`	部分更新したセルの列方向の値を上から記述した List＜集計する列の値＞
dataFieldName:`str`	対象のデータフィールド名

def getField(self, fieldName: str) -> dto.PivotFieldObject: ¶

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

Parameters
fieldName:`str`	フィールド名
Returns
`PivotFieldObject`	ピボットフィールドオブジェクト

def getFields(self) -> dto.VectorPivotFieldObject: ¶

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

Returns
`VectorPivotFieldObject`	List＜ピボットフィールドオブジェクト＞

def getGrandTotalLayoutType(self) -> enums.XlPivotTableDisplayGrandTotalType: ¶

ピボット集計の末尾集計行の有無(行および列)の取得を行います。

Returns
`XlPivotTableDisplayGrandTotalType`	末尾の集計フィールドの有無およびおく方向を取得します。

def getLayoutType(self) -> enums.XlPivotTableLayoutType: ¶

ピボット集計のレイアウトタイプの取得を行います。

Returns
`XlPivotTableLayoutType`	レポートのレイアウトタイプ

def getPivotTableSetting(self) -> dto.PivotTableSettingObject: ¶

ピボットテーブルの設定項目を取得します。

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

def getSubTotalsLayoutType(self) -> enums.XlPivotTableDisplaySubtotalsType: ¶

ピボット集計の末尾集計行の集計位置の取得を行います。

Returns
`XlPivotTableDisplaySubtotalsType`	末尾の集計フィールドの集計位置の取得を行います。

def refresh(self): ¶

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

def refreshData(self): ¶

集計元のデータを最新化した上、再集計します。集計元のデータが変更されていた場合、ピボットテーブルの集計に反映させます。

def setFields(self, settings: dto.PivotTableSettingObject, layoutType: enums.XlPivotTableLayoutType, rowFields: dto.VectorPivotFieldObject, colFields: dto.VectorPivotFieldObject, filterFields: dto.VectorPivotFieldObject, dataFields: dto.VectorPivotFieldObject, grandTotalLayoutType: enums.XlPivotTableDisplayGrandTotalType = enums.XlPivotTableDisplayGrandTotalType.RowsAndColumns, subtotalsLayoutType: enums.XlPivotTableDisplaySubtotalsType = enums.XlPivotTableDisplaySubtotalsType.SubtotalsDisplayTypeBottom, specialDataFieldDirectionCol: bool = True, specialDataFieldOrder: int = -1): ¶

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

Parameters
settings:`PivotTableSettingObject`	ピボットテーブルの設定項目オブジェクト
layoutType:`XlPivotTableLayoutType`	レポートのレイアウトタイプ
rowFields:`VectorPivotFieldObject`	行におくピボットフィールド
colFields:`VectorPivotFieldObject`	列におくピボットフィールド
filterFields:`VectorPivotFieldObject`	フィルター条件におくピボットフィールド
dataFields:`VectorPivotFieldObject`	集計対象のピボットフィールド(データ項目)
grandTotalLayoutType:`XlPivotTableDisplayGrandTotalType`, optional	末尾の集計フィールドの有無およびおく方向
subtotalsLayoutType:`XlPivotTableDisplaySubtotalsType`, optional	末尾の集計フィールドの集計位置
specialDataFieldDirectionCol:`bool`, optional	(dataFieldsが複数の時) true:集計アイテム(Σ)を列側に配置。false:集計アイテム(Σ)を行側に配置
specialDataFieldOrder:`int`, optional	(dataFieldsが複数の時) 集計アイテム(Σ)の位置 -1は最後尾を表します。1から始まります。

def upadteCustomItemPartial(self, itemName: str, customItemFormula: str, rowItems: dto.VectorString, colItems: dto.VectorString, dataFieldName: str): ¶

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

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

customItemFormulaの数式は、通常ピボットフィールドのフィールド名および項目名を含みますが、その際、クォーテーション等で囲む必要がありません。(例：フィールドA[項目あ] * 2 と設定)

Parameters
itemName:`str`	セットする集計式の所属するアイテム名
customItemFormula:`str`	セットする集計式
rowItems:`VectorString`	部分更新するセルの行方向の値を上から記述した List＜集計する行の値＞
colItems:`VectorString`	部分更新するセルの列方向の値を上から記述した List＜集計する列の値＞
dataFieldName:`str`	対象のデータフィールド名