Class: RubyOSBXL::Charts::Axis

Inherits:
Object
  • Object
show all
Defined in:
lib/rubyosbxl.rb

Overview

チャートの軸クラスです。

Instance Method Summary collapse

Instance Method Details

#getAxisBetweenCategories ⇒ bool

Note:

カテゴリ軸にのみ適用され、3Dグラフには適用されません

カテゴリ間で、軸が横切っているか取得します。

Returns:

  • (bool) —

    true: 横切っている false: 横切っていない

#getAxisGroup ⇒ RubyOSBXL::Enums::XlAxisGroup

軸グループを取得します。

Returns:

#getBaseUnit ⇒ RubyOSBXL::Enums::XlTimeUnit

軸の単位を取得します(軸が日付・時刻軸の場合)。

Returns:

#getBaseUnitIsAuto ⇒ bool

軸の単位が自動設定されているか取得します。カテゴリー軸のみ取得可能です。

Returns:

  • (bool) —

    true: 自動設定されている false: 自動設定されていない

#getCategoryNames ⇒ Array<String>

カテゴリー軸名を取得します。

Returns:

  • (Array<String>) —

    Array<個々のカテゴリー軸名>

#getCategoryType ⇒ RubyOSBXL::Enums::XlCategoryType

カテゴリー軸の種類を取得します。

Returns:

#getCrosses ⇒ RubyOSBXL::Enums::XlAxisCrosses

カテゴリー軸の交差種類を取得します。シリーズ軸は取得不可能です。

Returns:

#getCrossesAt ⇒ Numeric

値軸の交差位置を取得します。値軸のみ取得可能です。

Returns:

  • (Numeric) —

    値軸の交差位置

#getDisplayUnit ⇒ RubyOSBXL::Enums::XlDisplayUnit

軸の表示単位を取得します。値軸のみ取得可能です。

Returns:

#getDisplayUnitCustom ⇒ Numeric

値軸の表示単位値(カスタム)を取得します。値軸のみ取得可能です。

Returns:

  • (Numeric) —

    値軸の表示単位値(カスタム)

#getDisplayUnitLabel ⇒ RubyOSBXL::Charts::DisplayUnitLabel

軸単位ラベルクラスを取得します。値軸のみ取得可能です。

Returns:

#getFillFormat ⇒ RubyOSBXL::Charts::ChartFillFormat

オブジェクトの塗りつぶしの描画クラスを取得します。

Returns:

#getGlowFormat ⇒ RubyOSBXL::Charts::ChartGlowFormat

オブジェクトの光彩の描画クラスを取得します。

Returns:

#getLineFormat ⇒ RubyOSBXL::Charts::ChartLineFormat

オブジェクトの線の描画クラスを取得します。

Returns:

#getLogBase ⇒ Numeric

ログスケールを使用する場合の対数の基数を取得します。値軸のみ取得可能です。

Returns:

  • (Numeric) —

    対数の基数

#getMajorGridlines ⇒ RubyOSBXL::Charts::Gridlines

軸の主罫線クラスを取得します。

Returns:

#getMajorTickMark ⇒ RubyOSBXL::Enums::XlTickMark

軸の主目盛を取得します。

Returns:

#getMajorUnit ⇒ Numeric

軸の主目盛の設定値を取得します。値軸と日付タイプのカテゴリ軸のみ取得可能です。

Returns:

  • (Numeric) —

    軸の主目盛の設定値

#getMajorUnitIsAuto ⇒ bool

軸の主目盛が自動生成されたものかどうか取得します。値軸と日付タイプのカテゴリ軸のみ取得可能です。

Returns:

  • (bool) —

    true: 自動生成された false: 自動生成されていない

#getMajorUnitScale ⇒ RubyOSBXL::Enums::XlTimeUnit

軸の主目盛の単位を取得します。日付タイプのカテゴリ軸のみ取得可能です。

Returns:

#getMaximumScaleIsAuto ⇒ bool

軸の最大値が自動生成されているか取得します。値軸と日付タイプのカテゴリ軸のみ取得可能です。

Returns:

  • (bool) —

    true: 自動生成された false: 自動生成されていない

#getMinimumScaleIsAuto ⇒ bool

軸の最小値が自動生成されているか取得します。値軸と日付タイプのカテゴリ軸のみ取得可能です。

Returns:

  • (bool) —

    true: 自動生成された false: 自動生成されていない

#getMinorGridlines ⇒ RubyOSBXL::Charts::Gridlines

軸の補助罫線クラスを取得します。

Returns:

#getMinorTickMark ⇒ RubyOSBXL::Enums::XlTickMark

軸の補助目盛を取得します。

Returns:

#getMinorUnit ⇒ Numeric

軸の補助目盛の設定値を取得します。値軸と日付タイプのカテゴリ軸のみ取得可能です。

Returns:

  • (Numeric) —

    軸の補助目盛の設定値

#getMinorUnitIsAuto ⇒ bool

軸の補助目盛が自動生成されたものかどうか取得します。値軸と日付タイプのカテゴリ軸のみ取得可能です。

Returns:

  • (bool) —

    true: 自動生成された false: 自動生成されていない

#getMinorUnitScale ⇒ RubyOSBXL::Enums::XlTimeUnit

軸の補助目盛の単位を取得します。日付タイプのカテゴリ軸のみ取得可能です。

Returns:

#getReversePlotOrder ⇒ bool

軸の表示順が、通常と逆か取得します。

Returns:

  • (bool) —

    true: 通常と逆 false: 通常通り

#getScaleType ⇒ RubyOSBXL::Enums::XlScaleType

軸スケール種類を取得します。

Returns:

#getShadowFormat ⇒ RubyOSBXL::Charts::ChartShadowFormat

オブジェクトの影つけの描画クラスを取得します。

Returns:

#getSoftEdgeFormat ⇒ RubyOSBXL::Charts::ChartSoftEdgeFormat

オブジェクトのぼかしの描画クラスを取得します。

Returns:

#getTickLabelPosition ⇒ RubyOSBXL::Enums::XlTickLabelPosition

軸ラベルの位置を取得します。

Returns:

#getTickLabels ⇒ RubyOSBXL::Charts::TickLabels

軸ラベルクラスを取得します。

Returns:

#getTickLabelSpacing ⇒ Numeric

軸のラベルの間隔を取得します。値軸で取得可能です。

Returns:

  • (Numeric) —

    軸のラベルの間隔

#getTickLabelSpacingIsAuto ⇒ bool

軸のラベルの間隔が自動生成されているか取得します。値軸のみ取得可能です。

Returns:

  • (bool) —

    true: 自動生成されている false: 自動生成されていない

#getTickMarkSpacing ⇒ Integer

軸の目盛りの間隔を取得します。

Returns:

  • (Integer) —

    軸の目盛りの間隔

#getTitle ⇒ RubyOSBXL::Charts::AxisTitle

軸タイトルクラスを取得します。

Returns:

#getType ⇒ RubyOSBXL::Enums::XlAxisType

軸種類を取得します。

Returns:

#hasDisplayUnitLabel ⇒ bool

軸単位ラベルが表示されているか取得します。値軸のみ取得可能です。

Returns:

  • (bool) —

    true: 表示されている false: 表示されていない

#hasMajorGridlines ⇒ bool

軸の主罫線が表示されているか取得します。

Returns:

  • (bool) —

    true: 表示されている false: 表示されていない

#hasMinorGridlines ⇒ bool

軸の補助罫線が表示されているか取得します。

Returns:

  • (bool) —

    true: 表示されている false: 表示されていない

#hasTitle ⇒ bool

軸タイトルが表示されているか取得します。

Returns:

  • (bool) —

    true: 表示されている false: 表示されていない

#setAxisBetweenCategories(cross) ⇒ void

Note:

カテゴリ軸にのみ適用され、3Dグラフには適用されません

カテゴリ間で、軸が横切るか設定します。

Parameters:

  • cross (bool) —

    true: 横切る false: 横切らない

#setBaseUnit(unit) ⇒ void

軸の単位を設定します(軸が日付・時刻軸の場合)。

Parameters:

#setBaseUnitIsAuto(automatic) ⇒ void

軸の単位が自動設定されているか設定します。カテゴリー軸のみ設定可能です。

Parameters:

  • automatic (bool) —

    true: 自動設定する false: 自動設定を解除する

#setCategoryNames(param1) ⇒ void #setCategoryNames(param1) ⇒ void

Overloads:

  • #setCategoryNames(param1) ⇒ void

    カテゴリー軸名をセル範囲の値にて設定します。

    Parameters:

    • param1 (String) —

      セル範囲

  • #setCategoryNames(param1) ⇒ void

    カテゴリー軸名を設定します。

    Parameters:

    • param1 (Array<String>) —

      Array<個々のカテゴリー軸名>

#setCategoryType(ptype) ⇒ void

カテゴリー軸の種類を設定します。

Parameters:

#setCrosses(crosses) ⇒ void

カテゴリー軸の交差種類を設定します。シリーズ軸は設定不可能です。

Parameters:

#setCrossesAt(crossAt) ⇒ void

値軸の交差位置を設定します。値軸のみ設定可能です。

Parameters:

  • crossAt (Numeric) —

    交差位置

#setDisplayUnit(unit) ⇒ void

軸の表示単位を設定します。値軸のみ設定可能です。

Parameters:

#setDisplayUnitCustom(unit) ⇒ void

値軸の表示単位値(カスタム)を設定します。値軸のみ設定可能です。

Parameters:

  • unit (Numeric) —

    値軸の表示単位値(カスタム)

#setDisplayUnitLabel(show) ⇒ void

軸単位ラベルを表示するか設定します。値軸のみ設定可能です。

Parameters:

  • show (bool) —

    true: 表示する false: 表示しない

#setLogBase(logBase) ⇒ void

ログスケールを使用する場合の対数の基数を設定します。値軸のみ設定可能です。

Parameters:

  • logBase (Numeric) —

    対数の基数

#setMajorGridlines(show) ⇒ void

軸の主罫線を表示するか設定します。

Parameters:

  • show (bool) —

    true: 表示されている false: 表示されていない

#setMajorTickMark(tickMark) ⇒ void

軸の主目盛を設定します。

Parameters:

#setMajorUnit(unit) ⇒ void

軸の主目盛の設定値を設定します。値軸と日付タイプのカテゴリ軸のみ設定可能です。

Parameters:

  • unit (Numeric) —

    軸の主目盛の設定値

#setMajorUnitIsAuto ⇒ void

軸の主目盛を自動生成に設定します。値軸と日付タイプのカテゴリ軸のみ設定可能です。

#setMajorUnitScale(scale) ⇒ void

軸の主目盛の単位を設定します。日付タイプのカテゴリ軸のみ設定可能です。

Parameters:

#setMaximumScale(scale) ⇒ void

軸の最大値を設定します。値軸と日付タイプのカテゴリ軸のみ設定可能です。

Parameters:

  • scale (Numeric) —

    最大値

#setMaximumScaleIsAuto ⇒ void

軸の最大値を自動生成するか取得します。値軸と日付タイプのカテゴリ軸のみ設定可能です。

#setMinimumScale(scale) ⇒ void

軸の最小値を設定します。値軸と日付タイプのカテゴリ軸のみ設定可能です。

Parameters:

  • scale (Numeric) —

    最小値

#setMinimumScaleIsAuto ⇒ void

軸の最小値を自動生成するか取得します。値軸と日付タイプのカテゴリ軸のみ設定可能です。

#setMinorGridlines(show) ⇒ void

軸の補助罫線を表示するか設定します。

Parameters:

  • show (bool) —

    true: 表示する false: 表示しない

#setMinorTickMark(tickMark) ⇒ void

軸の補助目盛を設定します。

Parameters:

#setMinorUnit(unit) ⇒ void

軸の補助目盛の設定値を設定します。値軸と日付タイプのカテゴリ軸のみ設定可能です。

Parameters:

  • unit (Numeric) —

    軸の補助目盛の設定値

#setMinorUnitIsAuto ⇒ void

軸の補助目盛を自動生成に設定します。値軸と日付タイプのカテゴリ軸のみ設定可能です。

#setMinorUnitScale(scale) ⇒ void

軸の補助目盛の単位を設定します。日付タイプのカテゴリ軸のみ設定可能です。

Parameters:

#setReversePlotOrder(reverse) ⇒ void

軸の表示順が、通常と逆か設定します。

Parameters:

  • reverse (bool) —

    true: 通常と逆 false: 通常通り

#setScaleType(ptype) ⇒ void

軸スケール種類を設定します。

Parameters:

#setTickLabelPosition(position) ⇒ void

軸ラベルの位置を設定します。

Parameters:

#setTickLabelSpacing(spacing) ⇒ void

軸のラベルの間隔を設定します。値軸で設定可能です。

Parameters:

  • spacing (Numeric) —

    軸のラベルの間隔

#setTickLabelSpacingIsAuto(autospace) ⇒ void

軸のラベルの間隔が自動生成するか設定します。値軸のみ設定可能です。

Parameters:

  • autospace (bool) —

    true: 自動生成する false: 自動生成しない

#setTickMarkSpacing(spacing) ⇒ void

軸の目盛りの間隔を設定します。

Parameters:

  • spacing (Integer) —

    軸の目盛りの間隔

#setTitle(show) ⇒ void

軸タイトルの表示を設定します。

Parameters:

  • show (bool) —

    true: 表示する false: 表示しない