Class: RubyOSBXL::Charts::Chart

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

Overview

チャートを取り扱うクラスです。

Instance Method Summary collapse

Instance Method Details

#chartWizard(source, chartType, plotBy, seriesLabelLines, categoryLabelLines, chartStyleNo = 1, chartColorNo = RubyOSBXL::Enums::XlChartColorPalette::XlPaletteColorful1, hasLegend = false, title = "", categoryTitle = "", valueTitle = "", extraTitle = "") ⇒ void

Note:

Excelマクロとメソッドの引数の順番が違うので、注意してください。

チャートを作成します。

Parameters:

  • source (String) —

    チャートに用いるデータ領域(A1C1形式またはテーブル名)

  • chartType (RubyOSBXL::Enums::XlChartType) —

    チャート種類

  • plotBy (RubyOSBXL::Enums::XlRowCol) —

    チャートの向き (データ系列が行方向にある場合、XlRowCol.Columnsとなります)

  • seriesLabelLines (Integer) —

    シリーズ方向のヘッダ行数

  • categoryLabelLines (Integer) —

    カテゴリ方向のヘッダ行数

  • chartStyleNo (Integer) (defaults to: 1) —

    チャートスタイル番号列挙体

  • chartColorNo (RubyOSBXL::Enums::XlChartColorPalette) (defaults to: RubyOSBXL::Enums::XlChartColorPalette::XlPaletteColorful1) —

    チャート色番号列挙体

  • hasLegend (bool) (defaults to: false) —

    true: 凡例を表示する false: 凡例を表示しない

  • title (String) (defaults to: "") —

    チャートのタイトル(空文字の場合は設定しない)

  • categoryTitle (String) (defaults to: "") —

    カテゴリー軸方向タイトル(空文字の場合は設定しない)

  • valueTitle (String) (defaults to: "") —

    シリーズ軸方向タイトル(空文字の場合は設定しない)

  • extraTitle (String) (defaults to: "") —

    3D軸方向タイトル(空文字の場合は設定しない)

#clearAllCategoryFilter ⇒ void

すべてのカテゴリー軸のフィルターを解除します。

#clearAllSeriesFilter ⇒ void

すべてのシリーズ軸のフィルターを解除します。

#clearBackgroundPicture ⇒ void

チャートの背面の画像を除去します。

#clearCategoryFilter(categoryIndex) ⇒ void

特定のカテゴリー軸のフィルターを解除します。

Parameters:

  • categoryIndex (Integer) —

    カテゴリー軸番号(1から始まります)

#clearSeriesFilter(seriesIndex) ⇒ void

特定のシリーズ軸のフィルターを解除します。

Parameters:

  • seriesIndex (Integer) —

    シリーズ軸番号(1から始まります)

#deleteAxis(axisType, axisGroup = RubyOSBXL::Enums::XlAxisGroup::Primary) ⇒ void

チャートの軸を除去します。

Parameters:

#getAutoScaling ⇒ bool

チャートのオブジェクトが自動スケールするか取得します。

Returns:

  • (bool) —

    true: 自動スケールする false: 自動スケールしない

#getAxes(axisType, axisGroup = RubyOSBXL::Enums::XlAxisGroup::Primary) ⇒ RubyOSBXL::Charts::Axis

チャートの軸クラスを取得します。

Parameters:

Returns:

#getBackWall ⇒ RubyOSBXL::Charts::Walls

チャートの背面クラスを取得します。

Returns:

#getBarShape ⇒ RubyOSBXL::Enums::XlBarShape

3D棒グラフまたは列グラフで使用するBar形状を取得します。

Returns:

#getCategoryNameLevel ⇒ Integer

Note:

-1は、非表示、0 は全表示、1以降は、ラベルの表示行となります。

カテゴリラベルの表示行を取得します。

Returns:

  • (Integer) —

    カテゴリラベルの表示行

#getChartArea ⇒ RubyOSBXL::Charts::ChartArea

チャートの表示領域を取得します。

Returns:

#getChartColor ⇒ Integer

チャート色番号列挙体の整数値を取得します。(チャート色番号は、Excel画面のグラフデザイン項目の色の変更項目を参照してください)

Returns:

  • (Integer) —

    チャート色番号列挙体を整数値に変換した値

#getChartGroups(index) ⇒ RubyOSBXL::Charts::ChartGroup

チャートグループクラスを取得します。

Parameters:

  • index (Integer) —

    グループ番号(1から始まります)

Returns:

#getChartStyle ⇒ Integer

チャートのグラフスタイルの内部番号を取得します。(チャート種類により異なります。Excel画面のグラフデザイン項目のグラフスタイル項目に該当します) この番号は、Excel内部で保持しているグラフスタイルの番号となり、chartWizardメソッドで設定した1~14の値ではありません。

Returns:

  • (Integer) —

    チャートのグラフスタイルの内部番号

#getChartTitle ⇒ RubyOSBXL::Charts::ChartTitle

チャートのタイトルクラスを取得します。

Returns:

#getChartType ⇒ RubyOSBXL::Enums::XlChartType

チャート種類を取得します。

Returns:

#getDataSource ⇒ String

Note:

ピボットチャートの場合は、ピボットテーブル名を取得します。

チャートのデータソース(A1C1)領域を取得します。

Returns:

  • (String) —

    データソース(A1C1)領域

#getDataTable ⇒ RubyOSBXL::Charts::DataTable

チャートのデータテーブルクラスを取得します。

Returns:

#getDepthPercent ⇒ Integer

チャートの奥ゆき(パーセント)を取得します。

Returns:

  • (Integer) —

    奥ゆき(20～2000)

#getDisplayBlanksAs ⇒ RubyOSBXL::Enums::XlDisplayBlanksAs

チャートの空白データの扱い方を取得します。

Returns:

#getDisplayValueNotAvailableAsBlank ⇒ bool

チャートの表示データのERRORデータを空白として扱うかどうか示します。

Returns:

  • (bool) —

    true：エラーを空白として扱う false：エラーを空白として扱わない

#getElevation ⇒ Integer

チャートの表示角度を取得します。

Returns:

  • (Integer) —

    3D横棒グラフ(0～44) それ以外(-90～90)

#getFloor ⇒ RubyOSBXL::Charts::Floor

チャートの床領域クラスを取得します。

Returns:

#getFullSeriesCollection(index) ⇒ RubyOSBXL::Charts::Series

非表示のシリーズを含めたシリーズ(系列)クラスを取得します。

Parameters:

  • index (Integer) —

    シリーズ番号(1から始まります)

Returns:

#getGapDepth ⇒ Integer

3-Dグラフのデータ系列間の距離を取得します。

Returns:

  • (Integer) —

    (0～500) 値はマーカーの幅に対するパーセント値 (%)です。

#getHeightPercent ⇒ Integer

3-Dグラフの高さをグラフの幅に対するパーセント値 (%) で取得します。

Returns:

  • (Integer) —

    (5～500)

#getLegend ⇒ RubyOSBXL::Charts::Legend

チャートの凡例領域のクラスを取得します。

Returns:

#getPageSetupObject ⇒ RubyOSBXL::Dto::PageSetupObject

現在の印刷設定オブジェクトを取得します。

Returns:

#getPerspective ⇒ Integer

3Dグラフの視点位置(パーセント)を取得します。

Returns:

  • (Integer) —

    視点位置(パーセント) (0～100)

#getPlotArea ⇒ RubyOSBXL::Charts::PlotArea

チャートの表示ベース領域クラスを取得します。

Returns:

#getPlotBy ⇒ RubyOSBXL::Enums::XlRowCol

チャートのデータの向きを取得します。

Returns:

#getPlotVisibleOnly ⇒ bool

チャートを非表示データを含めて描画するか取得します。

Returns:

  • (bool) —

    true: 非表示データは含めない false: 非表示データも含める

#getProtectContents ⇒ bool

チャートのデータの保護状態を取得します。

Returns:

  • (bool) —

    true: 保護状態である false: 保護状態でない

#getProtectDrawingObjects ⇒ bool

チャートのグラフの保護状態を取得します。

Returns:

  • (bool) —

    true: 保護状態である false: 保護状態でない

#getProtectFormatting ⇒ bool

チャートの書式の保護状態を取得します。

Returns:

  • (bool) —

    true: 書式が保護状態である false: 書式が保護状態でない

#getProtectSelection ⇒ bool

チャートの選択領域の保護状態を取得します。

Returns:

  • (bool) —

    true: 選択領域が保護状態である false: 選択領域が保護状態でない

#getRightAngleAxes ⇒ bool

Note:

3D線グラフ、列グラフ、および棒グラフにのみ適用されます。

グラフの軸を直角、グラフの回転角または仰角とは無関係かどうか取得します。

Returns:

  • (bool) —

    true: 無関係 false: 無関係でない

#getRotation ⇒ Integer

3Dグラフの回転角(プロットエリアのz軸周りの回転角度)を取得します。

Returns:

  • (Integer) —

    3Dグラフの回転角

#getSeriesCollection(index) ⇒ RubyOSBXL::Charts::Series

シリーズ(系列)クラスを取得します。

Parameters:

  • index (Integer) —

    シリーズ番号(1から始まります)

Returns:

#getSeriesNameLevel ⇒ Integer

Note:

-1は、非表示、0 は全表示、1以降は、ラベルの表示行となります。

シリーズラベルの表示行を取得します。

Returns:

  • (Integer) —

    カテゴリラベルの表示行

#getSideWall ⇒ RubyOSBXL::Charts::Walls

チャートの側面領域クラスを取得します

Returns:

#hasAxis(axisType, axisGroup = RubyOSBXL::Enums::XlAxisGroup::Primary) ⇒ bool

チャートが軸を持っているか取得します。

Parameters:

Returns:

  • (bool) —

    true: 軸を持っている false: 軸を持っていない

#hasDataTable ⇒ bool

チャートのデータテーブル領域が表示されているか取得します。

Returns:

  • (bool) —

    true: チャートのデータテーブル領域が表示されている false: チャートのデータテーブル領域が表示されていない

#hasLegend ⇒ bool

チャートの凡例領域が表示されているか示します。

Returns:

  • (bool) —

    true: チャートの凡例領域が表示されている false: チャートの凡例領域が表示されていない

#hasTitle ⇒ bool

チャートのタイトル領域が表示されているか取得します。

Returns:

  • (bool) —

    true: チャートのタイトル領域が表示されている false: チャートのタイトル領域が表示されていない

#pivotChartWizard(source, chartType, chartStyleNo = 1, chartColorNo = RubyOSBXL::Enums::XlChartColorPalette::XlPaletteColorful1) ⇒ void

ピボットチャートを作成します。

Parameters:

  • source (String) —

    チャートに用いるデータ領域(ピボットテーブル名となります)

  • chartType (RubyOSBXL::Enums::XlChartType) —

    チャート種類

  • chartStyleNo (Integer) (defaults to: 1) —

    チャートスタイル番号列挙体

  • chartColorNo (RubyOSBXL::Enums::XlChartColorPalette) (defaults to: RubyOSBXL::Enums::XlChartColorPalette::XlPaletteColorful1) —

    チャート色番号列挙体

#setAllFieldButtons(show) ⇒ void

ピボットグラフのすべてのフィールド ボタンを表示するか取得します。

Parameters:

  • show (bool) —

    true: 表示状態 false: 非表示状態

#setAutScaling(scaling) ⇒ void

チャートのオブジェクトが自動スケールするか設定します。

Parameters:

  • scaling (bool) —

    true: 自動スケールする false: 自動スケールしない

#setAxis(axisType, axisGroup = RubyOSBXL::Enums::XlAxisGroup::Primary) ⇒ void

チャートの軸を設定します。

Parameters:

#setAxisFieldButtons(show) ⇒ void

ピボットグラフの軸フィールドボタンを表示するか設定します。

Parameters:

  • show (bool) —

    true: 表示状態 false: 非表示状態

#setBackgroundPicture(filePath) ⇒ void

チャートの背面の画像を設定します。

Parameters:

  • filePath (String) —

    画像のファイルパス

#setBarShape(shape) ⇒ void

3D棒グラフまたは列グラフで使用するBar形状を取得します。

Parameters:

#setCategoryFilter(categoryIndex) ⇒ void

特定のカテゴリー軸をフィルターします。

Parameters:

  • categoryIndex (Integer) —

    カテゴリー軸番号(1から始まります)。

#setCategoryNameLevel(categoryNameLevel) ⇒ void

Note:

-1は、非表示、0 は全表示、1以降は、ラベルの表示行となります。

カテゴリラベルの表示行を設定します。

Parameters:

  • categoryNameLevel (Integer) —

    カテゴリラベルの表示行

#setChartType(chartType) ⇒ void

チャート種類を設定します。

Parameters:

#setDataLabels(legendKey, showLeaderLine, showSeriesName, showCategoryName, showValue, showPercentage, showBubbleSize, separator = ",") ⇒ void

データラベルの表示有無を設定します。チャート全体に適用されます。

Parameters:

  • legendKey (bool) —

    true: 凡例のデータラベルを表示 false: 表示しない

  • showLeaderLine (bool) —

    true: 導線のデータラベルを表示 false: 表示しない

  • showSeriesName (bool) —

    true: シリーズ名のデータラベルを表示 false: 表示しない

  • showCategoryName (bool) —

    true: カテゴリー名のデータラベルを表示 false: 表示しない

  • showValue (bool) —

    true: 値のデータラベルを表示 false: 表示しない

  • showPercentage (bool) —

    true: 値のパーセントのデータラベルを表示 false: 表示しない

  • showBubbleSize (bool) —

    true: バブルグラフのサイズのデータラベルを表示 false: 表示しない

  • separator (String) (defaults to: ",") —

    データラベルの区切り文字

#setDataLabelsOverMaximum(show) ⇒ void

値が値軸の最大値より大きい場合にデータラベルを表示するか設定します。

Parameters:

  • show (bool) —

    true: データラベルを表示しない false: データラベルを表示しない

#setDataSource(source, plotBy, categoryLabelLines, seriesLabelLines) ⇒ void

Note:

チャートがピボットチャートの場合、このメソッドは使用できません。

データソースを設定します。

Parameters:

  • source (String) —

    データソース領域(A1C1またはテーブル名)

  • plotBy (RubyOSBXL::Enums::XlRowCol) —

    データの向き

  • categoryLabelLines (Integer) —

    カテゴリ軸のラベル行数

  • seriesLabelLines (Integer) —

    シリーズ軸のラベル行数

#setDataTable(show) ⇒ void

チャートのデータテーブル領域が表示されているか設定します。

Parameters:

  • show (bool) —

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

#setDepthPercent(percent) ⇒ void

チャートの奥ゆき(パーセント)を設定します。

Parameters:

  • percent (Integer) —

    奥ゆき(20～2000)

#setDisplayBlanksAs(blank) ⇒ void

チャートの空白データの扱い方を設定します。

Parameters:

#setDisplayValueNotAvailableAsBlank(blank) ⇒ void

チャートの表示データのERRORデータを空白として扱うかどうか設定します。

Parameters:

  • blank (bool) —

    true：エラーを空白として扱う false：エラーを空白として扱わない

#setElevation(elevation) ⇒ void

チャートの表示角度を設定します。

Parameters:

  • elevation (Integer) —

    角度

#setExpandCollapseEntireFieldButtons(show) ⇒ void

ピボットチャートにフィールド全体を展開およびフィールド全体を折りたたむボタンが表示するか設定します。

Parameters:

  • show (bool) —

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

#setGapDepth(depth) ⇒ void

3-Dグラフのデータ系列間の距離を設定します。

Parameters:

  • depth (Integer) —

    距離(0～500) 値はマーカーの幅に対するパーセント値 (%)です。

#setHeightPercent(percent) ⇒ void

3-Dグラフの高さをグラフの幅に対するパーセント値 (%) で設定します。

Parameters:

  • percent (Integer) —

    パーセント値 5～500

#setLegend(show) ⇒ void

チャートの凡例領域が表示されているか設定します。

Parameters:

  • show (bool) —

    true: チャートの凡例領域を表示する false: チャートの凡例領域を表示しない

#setLegendFieldButtons(show) ⇒ void

ピボットグラフの凡例フィールドボタンを表示するか設定します。

Parameters:

  • show (bool) —

    true: ピボットグラフの凡例フィールドボタンを表示する false: ピボットグラフの凡例フィールドボタンを表示しない

#setPageSetupObject(page) ⇒ void

現在の印刷設定を設定します。

Parameters:

#setPerspective(perspective) ⇒ void

3Dグラフの視点位置(パーセント)を設定します。

Parameters:

  • perspective (Integer) —

    視点位置(パーセント) 0～100

#setPlotVisibleOnly(plot) ⇒ void

チャートを非表示データを含めて描画するか設定します。

Parameters:

  • plot (bool) —

    true: 非表示データは含めない false: 非表示データも含める

#setProtectContents(protect) ⇒ void

チャートのデータの保護状態を設定します。

Parameters:

  • protect (bool) —

    true: データを保護状態にする false: データを保護状態にしない

#setProtectDrawingObjects(protect) ⇒ void

チャートのグラフの保護状態を設定します。

Parameters:

  • protect (bool) —

    true: グラフを保護状態にする false: グラフを保護状態にしない

#setProtectFormatting(protect) ⇒ void

チャートの書式の保護状態を設定します。

Parameters:

  • protect (bool) —

    true: 書式を保護状態にする false: 書式を保護状態にしない

#setProtectSelection(protect) ⇒ void

チャートの選択領域の保護状態を設定します。

Parameters:

  • protect (bool) —

    true: 選択領域を保護状態にする false: 選択領域を保護状態にしない

#setReportFilterFieldButtons(show) ⇒ void

ピボットグラフのレポートフィルターフィールドボタンを表示するか設定します。

Parameters:

  • show (bool) —

    true: ピボットグラフの凡例フィールドボタンを表示する false: ピボットグラフの凡例フィールドボタンを表示しない

#setRightAngleAxes(axis) ⇒ void

グラフの軸を直角、グラフの回転角または仰角とは無関係かどうか設定します。

Parameters:

  • axis (bool) —

    true: 無関係 false: 無関係でない

#setSeriesFilter(seriesIndex) ⇒ void

特定のシリーズ軸をフィルターします。

Parameters:

  • seriesIndex (Integer) —

    シリーズ軸番号(1から始まります)。

#setSeriesNameLevel(seriesNameLevel) ⇒ void

Note:

-1は、非表示、0 は全表示、1以降は、ラベルの表示行となります。

シリーズラベルの表示行を設定します。

Parameters:

  • seriesNameLevel (Integer) —

    カテゴリラベルの表示行

#setTitle(show) ⇒ void

チャートのタイトル領域が表示されているか設定します。

Parameters:

  • show (bool) —

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

#setValueFieldButtons(show) ⇒ void

ピボットグラフの値フィールドボタンを表示するか設定します。

Parameters:

  • show (bool) —

    true: ピボットグラフの値フィールドボタンを表示する false: ピボットグラフの値フィールドボタンを表示する

#showAllFieldButtons ⇒ bool

ピボットグラフのすべてのフィールド ボタンを表示しているか取得します。

Returns:

  • (bool) —

    true: 表示状態 false: 非表示状態

#showAxisFieldButtons ⇒ bool

ピボットグラフの軸フィールドボタンを表示しているか取得します。

Returns:

  • (bool) —

    true: 表示状態 false: 非表示状態

#showDataLabelsOverMaximum ⇒ bool

値が値軸の最大値より大きい場合にデータラベルを表示するか取得します。

Returns:

  • (bool) —

    true: データラベルを表示しない false: データラベルを表示しない

#showExpandCollapseEntireFieldButtons ⇒ bool

ピボットチャートにフィールド全体を展開およびフィールド全体を折りたたむボタンが表示されているか取得します。

Returns:

  • (bool) —

    true: ピボットチャートにフィールド全体を展開およびフィールド全体を折りたたむボタンが表示されている

#showLegendFieldButtons ⇒ bool

ピボットグラフの凡例フィールドボタンを表示するか取得します。

Returns:

  • (bool) —

    true: ピボットグラフの凡例フィールドボタンを表示する false: ピボットグラフの凡例フィールドボタンを表示しない

#showReportFilterFieldButtons ⇒ bool

ピボットグラフのレポートフィルターフィールドボタンを表示するか取得します。

Returns:

  • (bool) —

    true: ピボットグラフのレポートフィルターフィールドボタンを表示する false: ピボットグラフのレポートフィルターフィールドボタンを表示しない

#showValueFieldButtons ⇒ bool

ピボットグラフの値フィールドボタンを表示するか取得します。

Returns:

  • (bool) —

    true: ピボットグラフの値フィールドボタンを表示する false: ピボットグラフの値フィールドボタンを表示する