Class: RubyOSBXL::Dto::PivotFieldObject

Inherits:

Object

• Object
• RubyOSBXL::Dto::PivotFieldObject

Defined in:

lib/rubyosbxl.rb

Overview

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

Instance Method Summary

• #getBaseField ⇒ Integer

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

• #getBaseItem ⇒ Integer

  集計の計算に用いるアイテムIDを取得します。フィールドがデータフィールドである場合のみ有効です。.

• #getBaseItemSpecialCalculation ⇒ Integer

  集計の計算に用いるアイテムが、「次のアイテム」、「前のアイテム」かどうか取得します。フィールドがデータフィールドである場合のみ有効です。.

• #getCaption ⇒ String

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

• #getDataFieldCalculationMethod ⇒ RubyOSBXL::Enums::XlPivotFieldCalculationType

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

• #getDataFieldDisplayName ⇒ String

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

• #getDataFieldSubTotalsMethod ⇒ RubyOSBXL::Enums::XlPivotFieldSubtotalsMethodType

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

• #getFieldType ⇒ RubyOSBXL::Enums::XlPivotFieldType

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

• #getInsertBlankRow ⇒ bool

  空行をデータの後ろに挿入するか取得します。フィールドが行または列フィールドである場合のみ有効です。.

• #getNumberFormat ⇒ String

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

• #getRepeatLabels ⇒ bool

  ラベルの繰り返しをするか取得します。フィールドが行または列フィールドである場合のみ有効です。.

• #getShowEmtpyItems ⇒ bool

  空アイテムを表示するか取得します。フィールドが行または列フィールドである場合のみ有効です。.

• #initialize ⇒ void constructor

  コンストラクタ.

• #setCaption(caption) ⇒ void

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

• #setDataFieldCalculation(*args) ⇒ Object
• #setDataFieldCalculationSpecialItem(calculation, baseField, nextItem) ⇒ void

  集計の計算方法を設定します(フィールドおよびアイテムを含める計算タイプで、アイテムが「次のアイテム」、「前のアイテム」の場合)。フィールドがデータフィールドである場合のみ有効です。.

• #setDataFieldDisplayName(displayName) ⇒ void

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

• #setDataFieldSubTotalsMethod(subtotalType) ⇒ void

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

• #setFieldType(ptype) ⇒ void

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

• #setInsertBlankRow(apply) ⇒ void

  空行をデータの後ろに挿入するか設定します。フィールドが行または列フィールドである場合のみ有効です。.

• #setNumberFormat(numberFormat) ⇒ void

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

• #setRepeatLabels(apply) ⇒ void

  ラベルの繰り返しをするか設定します。フィールドが行または列フィールドである場合のみ有効です。.

• #setShowEmtpyItems(apply) ⇒ void

  空アイテムを表示するか設定します。フィールドが行または列フィールドである場合のみ有効です。.

Constructor Details

#initialize ⇒ void

コンストラクタ

インスタンスを作成します。

Instance Method Details

#getBaseField ⇒ Integer

Note:

フィールドを計算方法に含める集計の計算の方法の場合のみ有効です。

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

Returns:

• (Integer) —

  集計の計算に用いるフィールドID(フィールドIDは1が先頭です)

#getBaseItem ⇒ Integer

Note:

フィールドおよびアイテムを計算方法に含める集計の計算の方法の場合のみ有効です。

集計の計算に用いるアイテムIDを取得します。フィールドがデータフィールドである場合のみ有効です。

Returns:

• (Integer) —

  集計の計算に用いるアイテムID(フィールドIDは1が先頭です)

#getBaseItemSpecialCalculation ⇒ Integer

Note:

フィールドおよびアイテムを計算方法に含める集計の計算の方法の場合のみ有効です。

集計の計算に用いるアイテムが、「次のアイテム」、「前のアイテム」かどうか取得します。フィールドがデータフィールドである場合のみ有効です。

Returns:

• (Integer) —

  1: 次のアイテム 2: 前のアイテム

#getCaption ⇒ String

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

Returns:

• (String) —

  フィールド名称

#getDataFieldCalculationMethod ⇒ RubyOSBXL::Enums::XlPivotFieldCalculationType

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

Returns:

• (RubyOSBXL::Enums::XlPivotFieldCalculationType) —

  データフィールドの集計の計算方法

#getDataFieldDisplayName ⇒ String

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

Returns:

• (String) —

  フィールド表示名称

#getDataFieldSubTotalsMethod ⇒ RubyOSBXL::Enums::XlPivotFieldSubtotalsMethodType

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

Returns:

• (RubyOSBXL::Enums::XlPivotFieldSubtotalsMethodType) —

  データフィールドの集計メソッド

#getFieldType ⇒ RubyOSBXL::Enums::XlPivotFieldType

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

Returns:

• (RubyOSBXL::Enums::XlPivotFieldType) —

  フィールドの種類

#getInsertBlankRow ⇒ bool

空行をデータの後ろに挿入するか取得します。フィールドが行または列フィールドである場合のみ有効です。

Returns:

• (bool) —

  空行をデータの後ろに挿入するか

#getNumberFormat ⇒ String

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

Returns:

• (String) —

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

#getRepeatLabels ⇒ bool

ラベルの繰り返しをするか取得します。フィールドが行または列フィールドである場合のみ有効です。

Returns:

• (bool) —

  ラベルの繰り返しをするか

#getShowEmtpyItems ⇒ bool

空アイテムを表示するか取得します。フィールドが行または列フィールドである場合のみ有効です。

Returns:

• (bool) —

  空アイテムを表示するか

#setCaption(caption) ⇒ void

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

Parameters:

• caption (String) —

  フィールド名称

#setDataFieldCalculation(calculation) ⇒ void #setDataFieldCalculation(calculation, baseField) ⇒ void #setDataFieldCalculation(calculation, baseField, baseItem) ⇒ void

Overloads:

• #setDataFieldCalculation(calculation) ⇒ void

  集計の計算方法を設定します(フィールドおよびアイテムを計算に含めない計算タイプ)。フィールドがデータフィールドである場合のみ有効です。

  Parameters:

  • calculation (RubyOSBXL::Enums::XlPivotFieldCalculationType) —

    集計の計算方法

• #setDataFieldCalculation(calculation, baseField) ⇒ void

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

  Parameters:

  • calculation (RubyOSBXL::Enums::XlPivotFieldCalculationType) —

    集計の計算方法

  • baseField (Integer) —

    集計の計算に用いるフィールドID(フィールドIDは1が先頭です)

• #setDataFieldCalculation(calculation, baseField, baseItem) ⇒ void

  集計の計算方法を設定します(フィールドおよびアイテムを含める計算タイプ)。フィールドがデータフィールドである場合のみ有効です。

  Parameters:

  • calculation (RubyOSBXL::Enums::XlPivotFieldCalculationType) —

    集計の計算方法

  • baseField (Integer) —

    集計の計算に用いるフィールドID(フィールドIDは1が先頭です)

  • baseItem (Integer) —

    集計の計算に用いるアイテムID(アイテムIDは1が先頭です)

#setDataFieldCalculationSpecialItem(calculation, baseField, nextItem) ⇒ void

集計の計算方法を設定します(フィールドおよびアイテムを含める計算タイプで、アイテムが「次のアイテム」、「前のアイテム」の場合)。フィールドがデータフィールドである場合のみ有効です。

Parameters:

• calculation (RubyOSBXL::Enums::XlPivotFieldCalculationType) —

  集計の計算方法

• baseField (Integer) —

  集計の計算に用いるフィールドID(フィールドIDは1が先頭です)

• nextItem (bool) —

  1: 次のアイテム 2: 前のアイテム

#setDataFieldDisplayName(displayName) ⇒ void

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

Parameters:

• displayName (String) —

  フィールド表示名称

#setDataFieldSubTotalsMethod(subtotalType) ⇒ void

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

Parameters:

• subtotalType (RubyOSBXL::Enums::XlPivotFieldSubtotalsMethodType) —

  集計方法

#setFieldType(ptype) ⇒ void

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

Parameters:

• ptype (RubyOSBXL::Enums::XlPivotFieldType) —

  フィールドの種類

#setInsertBlankRow(apply) ⇒ void

空行をデータの後ろに挿入するか設定します。フィールドが行または列フィールドである場合のみ有効です。

Parameters:

• apply (bool) —

  true: 空行をデータの後ろに挿入する false: 空行をデータの後ろに挿入しない

#setNumberFormat(numberFormat) ⇒ void

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

Parameters:

• numberFormat (String) —

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

#setRepeatLabels(apply) ⇒ void

ラベルの繰り返しをするか設定します。フィールドが行または列フィールドである場合のみ有効です。

Parameters:

• apply (bool) —

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

#setShowEmtpyItems(apply) ⇒ void

空アイテムを表示するか設定します。フィールドが行または列フィールドである場合のみ有効です。

Parameters:

• apply (bool) —

  true: 空アイテムを表示する false: 空アイテムを表示しない