クラス: ChartCollection

Sheets.Charts.ChartCollection

Table of contents

コンストラクタ

• constructor

メソッド

• add
• all
• clear
• get
• preserveUnsupportedChart
• remove
• zIndex

コンストラクタ

constructor

• new ChartCollection()

シートのすべてのチャートを管理するチャートマネージャを表します。

メソッド

add

▸ add(name, chartType, x, y, width, height, dataRange?, dataOrientation?): Chart

シートにチャートを追加します。

実例

// 次のサンプルコードは、チャートの追加方法を示します。
var dataRange = "A1:D4";
var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);

パラメータ

戻り値

Chart

シートに追加されたチャート。

all

▸ all(): Chart[]

シートに存在するすべてのチャートを取得します。

実例

var dataRange = "A1:D4";
activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 180, dataRange);
var dataRange2 = "A20:D24";
activeSheet.charts.add('Chart2', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 220, 600, 180, dataRange2);
var charts = activeSheet.charts.all();
for (var i = 0; i < charts.length; i++) {
    alert("Name of chart " + i + " is:  " + charts[i].name())
}

戻り値

Chart[]

シートに存在するすべてのチャートのコレクション。

clear

▸ clear(): void

シートに存在するすべてのチャートを削除します。

戻り値

void

get

▸ get(name): Chart

シート上のチャートを名前によって取得します。

実例

var dataRange = "A1:D4";
activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);
// ボタン
$("#button1").click(function () {
 var chart = activeSheet.charts.get("f2");
});

パラメータ

戻り値

Chart

指定した名前を持つ、シート上のチャート。

preserveUnsupportedChart

▸ preserveUnsupportedChart(flag, paintCallBack?): undefined | boolean

インポート時にサポートされていないチャートを保持するかどうかを取得または設定します。

実例

sheet.charts.preserveUnsupportedChart(true, function(chartHost, chart){
var paintElement= document.createElement('div');
paintElement.innerHTML = '<span>to be continue</span>';
chartHost.appendChild(paintElement);
])

パラメータ

戻り値

undefined | boolean

値が設定されていない場合は、チャートの値を返します。値が設定されている場合は、undefinedを返します。

remove

▸ remove(name): void

シート上のチャートを名前によって削除します。

実例

var dataRange = "A1:D4";
activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);
// ボタン
$("#button1").click(function () {
     activeSheet.resumePaint();
     activeSheet.charts.remove("f2");
     activeSheet.repaint();
});

パラメータ

戻り値

void

zIndex

▸ zIndex(name, zIndex?): any

チャートのzインデックスを取得または設定します。

実例

var dataRange = "A1:D4";
activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 180, dataRange);
var dataRange2 = "A20:D24";
activeSheet.charts.add('Chart2', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 180, 600, 180, dataRange2);
activeSheet.charts.zIndex('Chart1', 897);
activeSheet.charts.zIndex('Chart2', 890);

パラメータ

戻り値

any

パラメーター'zIndex'がnullまたはundefinedの場合は、指定した名前を持つチャートのzインデックスが返されます。