Class: RubyOSBXL::Charts::Legend

Inherits:

Object

• Object
• RubyOSBXL::Charts::Legend

Defined in:

lib/rubyosbxl.rb

Overview

チャートの凡例を扱うクラスです。

Instance Method Summary

• #getAutoLayout ⇒ bool

  凡例のレイアウトが自動設定されたかどうか取得します。.

• #getBorderFormat ⇒ RubyOSBXL::Charts::ChartLineFormat

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

• #getFillFormat ⇒ RubyOSBXL::Charts::ChartFillFormat

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

• #getGlowFormat ⇒ RubyOSBXL::Charts::ChartGlowFormat

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

• #getLegendEntry(index) ⇒ RubyOSBXL::Charts::LegendEntry

  凡例項目クラスを取得します。.

• #getPosition ⇒ RubyOSBXL::Enums::XlLegendPosition

  凡例の表示位置を取得します。.

• #getShadow ⇒ bool

  凡例が影付きかどうか取得します。.

• #getShadowFormat ⇒ RubyOSBXL::Charts::ChartShadowFormat

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

• #getSoftEdgeFormat ⇒ RubyOSBXL::Charts::ChartSoftEdgeFormat

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

• #getTextBoxAlignment ⇒ RubyOSBXL::Charts::ChartTextBoxAlignment

  オブジェクトのテキストボックスのレイアウトクラスを取得します。.

• #getTextFillFormat ⇒ RubyOSBXL::Charts::ChartTextFillFormat

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

• #getTextGlowFormat ⇒ RubyOSBXL::Charts::ChartTextGlowFormat

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

• #getTextLineFormat ⇒ RubyOSBXL::Charts::ChartTextLineFormat

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

• #getTextReflectionFormat ⇒ RubyOSBXL::Charts::ChartTextReflectionFormat

  オブジェクトのテキストの反射の描画クラスを取得します。.

• #getTextShadowFormat ⇒ RubyOSBXL::Charts::ChartTextShadowFormat

  オブジェクトのテキストの影付きの描画クラスを取得します。.

• #getThreeDFormat ⇒ RubyOSBXL::Charts::ChartThreeDFormat

  オブジェクトの3D表示の描画クラスを取得します。.

• #setAutoLayout ⇒ void

  凡例のレイアウトを自動設定します。.

• #setCustomLayout(left, ptop, width, height) ⇒ void

  凡例のレイアウトの位置を手動設定します。.

• #setPosition(position) ⇒ void

  凡例の表示位置を設定します。.

• #setShadow(shadow) ⇒ void

  凡例が影付きかどうか設定します。.

Instance Method Details

#getAutoLayout ⇒ bool

凡例のレイアウトが自動設定されたかどうか取得します。

Returns:

• (bool) —

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

#getBorderFormat ⇒ RubyOSBXL::Charts::ChartLineFormat

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

Returns:

• (RubyOSBXL::Charts::ChartLineFormat) —

  オブジェクトの淵の描画クラス

#getFillFormat ⇒ RubyOSBXL::Charts::ChartFillFormat

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

Returns:

• (RubyOSBXL::Charts::ChartFillFormat) —

  オブジェクトの塗りつぶしの描画クラス

#getGlowFormat ⇒ RubyOSBXL::Charts::ChartGlowFormat

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

Returns:

• (RubyOSBXL::Charts::ChartGlowFormat) —

  オブジェクトの光彩の描画クラス

#getLegendEntry(index) ⇒ RubyOSBXL::Charts::LegendEntry

凡例項目クラスを取得します。

Parameters:

• index (Integer) —

  何番目の凡例であるか 先頭は1です。

Returns:

• (RubyOSBXL::Charts::LegendEntry) —

  凡例項目クラス

#getPosition ⇒ RubyOSBXL::Enums::XlLegendPosition

凡例の表示位置を取得します。

Returns:

• (RubyOSBXL::Enums::XlLegendPosition) —

  凡例の表示位置

#getShadow ⇒ bool

凡例が影付きかどうか取得します。

Returns:

• (bool) —

  true: 影付き false: 影付きでない

#getShadowFormat ⇒ RubyOSBXL::Charts::ChartShadowFormat

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

Returns:

• (RubyOSBXL::Charts::ChartShadowFormat) —

  オブジェクトの影つけの描画クラス

#getSoftEdgeFormat ⇒ RubyOSBXL::Charts::ChartSoftEdgeFormat

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

Returns:

• (RubyOSBXL::Charts::ChartSoftEdgeFormat) —

  オブジェクトのぼかしの描画クラス

#getTextBoxAlignment ⇒ RubyOSBXL::Charts::ChartTextBoxAlignment

オブジェクトのテキストボックスのレイアウトクラスを取得します。

Returns:

• (RubyOSBXL::Charts::ChartTextBoxAlignment) —

  オブジェクトのテキストボックスのレイアウトクラス

#getTextFillFormat ⇒ RubyOSBXL::Charts::ChartTextFillFormat

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

Returns:

• (RubyOSBXL::Charts::ChartTextFillFormat) —

  オブジェクトのテキストの塗りつぶしの描画クラス

#getTextGlowFormat ⇒ RubyOSBXL::Charts::ChartTextGlowFormat

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

Returns:

• (RubyOSBXL::Charts::ChartTextGlowFormat) —

  オブジェクトのテキストの光彩の描画クラス

#getTextLineFormat ⇒ RubyOSBXL::Charts::ChartTextLineFormat

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

Returns:

• (RubyOSBXL::Charts::ChartTextLineFormat) —

  オブジェクトのテキストの描画クラス

#getTextReflectionFormat ⇒ RubyOSBXL::Charts::ChartTextReflectionFormat

オブジェクトのテキストの反射の描画クラスを取得します。

Returns:

• (RubyOSBXL::Charts::ChartTextReflectionFormat) —

  オブジェクトのテキストの反射の描画クラス

#getTextShadowFormat ⇒ RubyOSBXL::Charts::ChartTextShadowFormat

オブジェクトのテキストの影付きの描画クラスを取得します。

Returns:

• (RubyOSBXL::Charts::ChartTextShadowFormat) —

  オブジェクトのテキストの影付きの描画クラス

#getThreeDFormat ⇒ RubyOSBXL::Charts::ChartThreeDFormat

オブジェクトの3D表示の描画クラスを取得します。

Returns:

• (RubyOSBXL::Charts::ChartThreeDFormat) —

  オブジェクトの3D表示の描画クラス

#setAutoLayout ⇒ void

凡例のレイアウトを自動設定します。

#setCustomLayout(left, ptop, width, height) ⇒ void

凡例のレイアウトの位置を手動設定します。

Parameters:

• left (Numeric) —

  左端のオフセット(ポイント(pt)) 現在の位置からの相対位置なので、マイナス値を許容します。

• ptop (Numeric) —

  上端のオフセット(ポイント(pt)) 現在の位置からの相対位置なので、マイナス値を許容します。

• width (Numeric) —

  幅(ポイント(pt))

• height (Numeric) —

  高さ(ポイント(pt))

#setPosition(position) ⇒ void

凡例の表示位置を設定します。

Parameters:

• position (RubyOSBXL::Enums::XlLegendPosition) —

  凡例の表示位置

#setShadow(shadow) ⇒ void

凡例が影付きかどうか設定します。

Parameters:

• shadow (bool) —

  true: 影付き false: 影付きでない