クラス: DataChart

Sheets.DataCharts.DataChart

Table of contents

コンストラクタ

• constructor

メソッド

• allowMove
• allowResize
• alt
• canPrint
• dynamicMove
• dynamicSize
• endColumn
• endColumnOffset
• endRow
• endRowOffset
• getChartConfig
• height
• isLocked
• isSelected
• isVisible
• name
• setChartConfig
• startColumn
• startColumnOffset
• startRow
• startRowOffset
• width
• X
• y

コンストラクタ

constructor

• new DataChart(sheet, name, x, y, width, height, type)

データチャートを表します。

パラメータ

名前	型	説明
sheet	Worksheet	データチャートのホストシート。
name	string	データチャートの名前。
x	number	データチャートのx位置。
y	number	データチャートのy位置。
width	number	データチャートの幅。
height	number	データチャートの高さ。
type	DataChartType	データチャートの種類。

メソッド

allowMove

▸ allowMove(value?): any

データチャートの移動を無効にするかどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	テータチャートの移動を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合は、データチャートの移動を無効にするかどうかの設定を返します。値が設定されている場合は、データチャートを返します。

---

allowResize

▸ allowResize(value?): any

データチャートのサイズ変更を無効にするかどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	テータチャートのサイズ変更を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合は、データチャートのサイズ変更を無効にするかどうかの設定を返します。値が設定されている場合は、データチャートを返します。

---

alt

▸ alt(value?): any

スクリーンリーダーのデータチャートの代替テキストを取得または設定します。

パラメータ

名前	型	説明
value?	string	データチャートの代替テキスト。

戻り値

any

データチャートの代替テキスト。

---

canPrint

▸ canPrint(value?): any

このデータチャートが印刷可能かどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	このデータチャートが印刷可能かどうかを示す値。

戻り値

any

値が設定されていない場合、このデータチャートが印刷可能かどうかを返します。

---

dynamicMove

▸ dynamicMove(value?): any

行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにオブジェクトが移動するかどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにオブジェクトが移動するかどうかを示す値。

戻り値

any

値が設定されていない場合は、このデータチャートが動的に移動するかどうかを返します。値が設定されている場合は、データチャートを返します。

---

dynamicSize

▸ dynamicSize(value?): any

データチャートの位置が固定されているかどうかを取得または設定します。fixedPositionがtrueの場合、dynamicMoveとdynamicSizeは無効になります。

パラメータ

名前	型	説明
value?	boolean	データチャートの位置が固定されているかどうかを示す値。

戻り値

any

値が設定されていない場合は、データチャートの位置が固定されているかどうかを返します。値が設定されている場合は、データチャートを返します。

---

endColumn

▸ endColumn(value?): any

データチャートの位置の終了列インデックスを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの位置の終了列インデックス。

戻り値

any

値が設定されていない場合は、データチャートの位置の終了列インデックスを返します。値が設定されている場合は、データチャートを返します。

---

endColumnOffset

▸ endColumnOffset(value?): any

データチャートの終了列に対するオフセットを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの終了列に対するオフセット。

戻り値

any

値が設定されていない場合は、データチャートの終了列に対するオフセットを返します。値が設定されている場合は、データチャートを返します。

---

endRow

▸ endRow(value?): any

データチャートの位置の終了行インデックスを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの位置の終了行インデックス。

戻り値

any

値が設定されていない場合は、データチャートの位置の終了行インデックスを返します。値が設定されている場合は、データチャートを返します。

---

endRowOffset

▸ endRowOffset(value?): any

データチャートの終了行に対するオフセットを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの終了行に対するオフセット。

戻り値

any

値が設定されていない場合は、データチャートの終了行に対するオフセットを返します。値が設定されている場合は、データチャートを返します。

---

getChartConfig

▸ getChartConfig(): IDataChartConfig

データチャートの設定を取得します。

実例

var datachart = activeSheet.datacharts.add('datachart1', 250, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
console.log(datachart.getChartConfig());

戻り値

IDataChartConfig

データチャートの設定。

---

height

▸ height(value?): any

データチャートの高さを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの高さ。

戻り値

any

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

---

isLocked

▸ isLocked(value?): any

このデータチャートがロックされているかどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	このデータチャートがロックされているかどうかを示す値。

戻り値

any

値が設定されていない場合は、このデータチャートがロックされているかどうかを返します。値が設定されている場合は、データチャートを返します。

---

isSelected

▸ isSelected(value?): any

このデータチャートが選択されているかどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	このデータチャートが選択されているかどうかを示す値。

戻り値

any

値が設定されていない場合は、このデータチャートが選択されているかどうかを返します。値が設定されている場合は、データチャートを返します。

---

isVisible

▸ isVisible(value?): any

このデータチャートが表示されているかどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	このデータチャートが表示されているかどうかを示す値。

戻り値

any

値が設定されていない場合は、このデータチャートが表示されているかどうかを返します。値が設定されている場合は、データチャートを返します。

---

name

▸ name(value?): any

データチャート名を取得します。

パラメータ

名前	型	説明
value?	string	データチャートの名前。

戻り値

any

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

---

setChartConfig

▸ setChartConfig(config): void

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

実例

var datachart = activeSheet.datacharts.add('datachart1', 250, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
var config = datachart.getChartConfig();
config.plots[0].type = GC.Spread.Sheets.DataCharts.DataChartType.line;
datachart.setChartConfig(config);

パラメータ

名前	型	説明
config	IDataChartConfig	データチャートの設定。

戻り値

void

---

startColumn

▸ startColumn(value?): any

データチャートの位置の開始列インデックスを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの位置の開始列インデックス。

戻り値

any

値が設定されていない場合は、データチャートの位置の開始列インデックスを返します。値が設定されている場合は、データチャートを返します。

---

startColumnOffset

▸ startColumnOffset(value?): any

データチャートの開始列に対するオフセットを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの開始列に対するオフセット。

戻り値

any

値が設定されていない場合は、データチャートの開始列に対するオフセットを返します。値が設定されている場合は、データチャートを返します。

---

startRow

▸ startRow(value?): any

データチャートの位置の開始行インデックスを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの位置の開始行インデックス。

戻り値

any

値が設定されていない場合は、データチャートの位置の開始行インデックスを返します。値が設定されている場合は、データチャートを返します。

---

startRowOffset

▸ startRowOffset(value?): any

データチャートの開始行に対するオフセットを取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの開始行に対するオフセット。

戻り値

any

値が設定されていない場合は、データチャートの開始行に対するオフセットを返します。値が設定されている場合は、データチャートを返します。

---

width

▸ width(value?): any

データチャートの幅を取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの幅。

戻り値

any

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

---

x

▸ x(value?): any

データチャートの水平位置を取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの水平位置。

戻り値

any

値が設定されていない場合は、データチャートの水平位置を返します。値が設定されている場合は、データチャートを返します。

---

y

▸ y(value?): any

データチャートの垂直位置を取得または設定します。

パラメータ

名前	型	説明
value?	number	データチャートの垂直位置。

戻り値

any

値が設定されていない場合は、データチャートの垂直位置を返します。値が設定されている場合は、データチャートを返します。