pyosbxl.dto.PivotFieldObject

class documentation

class PivotFieldObject:

Constructor: PivotFieldObject()

ピボットテーブルのフィールドオブジェクトです。

Method	`__init__`	コンストラクタ。インスタンスを作成します。
Method	`getBaseField`	集計の計算に用いるフィールド名称を取得します。
Method	`getBaseItem`	集計の計算に用いるアイテム名称を取得します。
Method	`getBaseItemSpecialCalculation`	集計の計算に用いるアイテム名が、「次のアイテム」、「前のアイテム」かどうかを取得します。
Method	`getCaption`	フィールド名称を取得します。
Method	`getDataFieldCalculationMethod`	集計の計算方法を取得します。フィールドがデータフィールドである場合のみ有効です。
Method	`getDataFieldDisplayName`	フィールド表示名称を取得します。フィールドがデータフィールドの場合のみ、有効です。
Method	`getDataFieldSubTotalsMethod`	集計メソッドを取得します。フィールドがデータフィールドの場合のみ、有効です。
Method	`getFieldType`	フィールドの種類を取得します。
Method	`getIncludeNewItemsInFilter`	フィルターに、追加されたアイテムを表示するか取得します。ページアイテムの場合のみ、有効です。
Method	`getInsertBlankRow`	空行をデータの後ろ(集計データの前)に挿入するかどうかを取得します。
Method	`getNumberFormat`	集計フィールドに適用する書式を取得します。フィールドがデータフィールドである場合のみ有効です。
Method	`getRepeatLabels`	ラベルの繰り返しをするかどうかを取得します。行/列フィールドの場合有効です。
Method	`getShowEmtpyItems`	空アイテムを表示するかどうかを取得します。行/列フィールドの場合有効です。
Method	`setCaption`	フィールド名称を設定します。
Method	`setDataFieldCalculation`	集計の計算方法を設定します。フィールドがデータフィールドである場合のみ有効です。
Method	`setDataFieldCalculationSpecialItem`	集計の計算方法を設定します(フィールドおよびアイテムを設定する計算種類で次のアイテムまたは前のアイテムを設定する場合)
Method	`setDataFieldDisplayName`	フィールド表示名称を設定します。フィールドがデータフィールドの場合のみ、有効です。
Method	`setDataFieldSubTotalsMethod`	集計メソッドを設定します。フィールドがデータフィールドである場合のみ有効です。
Method	`setFieldType`	フィールドの種類を設定します。
Method	`setIncludeNewItemsInFilter`	フィルターに、追加されたアイテムを表示するかどうかを設定します。ページアイテムの場合のみ、有効です。
Method	`setInsertBlankRow`	空行をデータの後ろ(集計データの前)に挿入するかどうかを設定します。
Method	`setNumberFormat`	集計フィールドに適用する書式を設定します。フィールドがデータフィールドである場合のみ有効です。
Method	`setRepeatLabels`	ラベルの繰り返しをするかどうかを設定します。行/列フィールドの場合有効です。
Method	`setShowEmtpyItems`	空アイテムを表示するかどうかを設定します。行/列フィールドの場合有効です。

def __init__(self): ¶

コンストラクタ。インスタンスを作成します。

def getBaseField(self) -> str: ¶

集計の計算に用いるフィールド名称を取得します。

フィールドがデータフィールドである場合のみ有効です。集計の計算にフィールドを用いる計算種類の場合、値が入ります。

Returns
`str`	集計の計算に用いるフィールド名称

def getBaseItem(self) -> str: ¶

集計の計算に用いるアイテム名称を取得します。

フィールドがデータフィールドである場合のみ有効です。集計の計算にフィールドの個別アイテムを用いる計算種類の場合、値が入ります。

Returns
`str`	集計の計算に用いるアイテム名称

def getBaseItemSpecialCalculation(self) -> int: ¶

集計の計算に用いるアイテム名が、「次のアイテム」、「前のアイテム」かどうかを取得します。

フィールドがデータフィールドである場合のみ有効です。集計の計算にフィールドの個別アイテムを用いる計算種類の場合で、次のアイテム、前のアイテムを設定した場合、値が入ります。

Returns
`int`	1:次のアイテム 2:前のアイテム

def getCaption(self) -> str: ¶

フィールド名称を取得します。

Returns
`str`	フィールド名称

def getDataFieldCalculationMethod(self) -> enums.XlPivotFieldCalculationType: ¶

集計の計算方法を取得します。フィールドがデータフィールドである場合のみ有効です。

Returns
`XlPivotFieldCalculationType`	集計の計算方法

def getDataFieldDisplayName(self) -> str: ¶

フィールド表示名称を取得します。フィールドがデータフィールドの場合のみ、有効です。

Returns
`str`	フィールド表示名称

def getDataFieldSubTotalsMethod(self) -> enums.XlPivotFieldSubtotalsMethodType: ¶

集計メソッドを取得します。フィールドがデータフィールドの場合のみ、有効です。

Returns
`XlPivotFieldSubtotalsMethodType`	集計メソッド

def getFieldType(self) -> enums.XlPivotFieldType: ¶

フィールドの種類を取得します。

Returns
`XlPivotFieldType`	フィールドの種類

def getIncludeNewItemsInFilter(self) -> bool: ¶

フィルターに、追加されたアイテムを表示するか取得します。ページアイテムの場合のみ、有効です。

Returns
`bool`	true:追加されたアイテムを表示する false:追加されたアイテムを表示しない

def getInsertBlankRow(self) -> bool: ¶

空行をデータの後ろ(集計データの前)に挿入するかどうかを取得します。

Returns
`bool`	true:空行を挿入する false:空行を挿入しない

def getNumberFormat(self) -> str: ¶

集計フィールドに適用する書式を取得します。フィールドがデータフィールドである場合のみ有効です。

Returns
`str`	集計フィールドに適用する書式

def getRepeatLabels(self) -> bool: ¶

ラベルの繰り返しをするかどうかを取得します。行/列フィールドの場合有効です。

Returns
`bool`	true:ラベルを繰り返す false:ラベルを繰り返さない

def getShowEmtpyItems(self) -> bool: ¶

空アイテムを表示するかどうかを取得します。行/列フィールドの場合有効です。

Returns
`bool`	true:表示する false:表示しない

def setCaption(self, caption: str): ¶

フィールド名称を設定します。

Parameters
caption:`str`	フィールド名称

def setDataFieldCalculation(self, calculation: enums.XlPivotFieldCalculationType, baseField: Optional[str] = None, baseItem: Optional[str] = None): ¶

集計の計算方法を設定します。フィールドがデータフィールドである場合のみ有効です。

フィールドが必要な計算種類には、baseFieldを設定してください。

フィールドおよびアイテムが必要な計算種類には、baseFieldおよびbaseItemを設定してください。

Parameters
calculation:`XlPivotFieldCalculationType`	集計の計算方法
baseField:`str`, optional	集計対象のフィールドID
baseItem:`str`, optional	集計対象のアイテム名称

def setDataFieldCalculationSpecialItem(self, calculation: enums.XlPivotFieldCalculationType, baseField: str, nextItem: bool): ¶

集計の計算方法を設定します(フィールドおよびアイテムを設定する計算種類で次のアイテムまたは前のアイテムを設定する場合)

Parameters
calculation:`XlPivotFieldCalculationType`	集計の計算方法
baseField:`str`	集計対象のフィールド名称
nextItem:`bool`	true: 次のアイテム false:前のアイテム

def setDataFieldDisplayName(self, displayName: str): ¶

フィールド表示名称を設定します。フィールドがデータフィールドの場合のみ、有効です。

Parameters
displayName:`str`	フィールド表示名称

def setDataFieldSubTotalsMethod(self, subtotalType: enums.XlPivotFieldSubtotalsMethodType): ¶

集計メソッドを設定します。フィールドがデータフィールドである場合のみ有効です。

Parameters
subtotalType:`XlPivotFieldSubtotalsMethodType`	集計メソッド

def setFieldType(self, type: enums.XlPivotFieldType): ¶

フィールドの種類を設定します。

Parameters
type:`XlPivotFieldType`	フィールドの種類

def setIncludeNewItemsInFilter(self, apply: bool): ¶

フィルターに、追加されたアイテムを表示するかどうかを設定します。ページアイテムの場合のみ、有効です。

Parameters
apply:`bool`	true:追加されたアイテムを表示する false:追加されたアイテムを表示しない

def setInsertBlankRow(self, apply: bool): ¶

空行をデータの後ろ(集計データの前)に挿入するかどうかを設定します。

Parameters
apply:`bool`	true:空行を挿入する false:空行を挿入しない

def setNumberFormat(self, numberFormat: str): ¶

集計フィールドに適用する書式を設定します。フィールドがデータフィールドである場合のみ有効です。

Parameters
numberFormat:`str`	適用する書式

def setRepeatLabels(self, apply: bool): ¶

ラベルの繰り返しをするかどうかを設定します。行/列フィールドの場合有効です。

Parameters
apply:`bool`	true:ラベルを繰り返す false:ラベルを繰り返さない

def setShowEmtpyItems(self, apply: bool): ¶

空アイテムを表示するかどうかを設定します。行/列フィールドの場合有効です。

Parameters
apply:`bool`	true:表示する false:表示しない