[]
デモ ヘルプ APIリファレンス デザイナ
ダウンロード
(Showing Draft Content)

GC.Spread.Sheets.Charts.Chart

クラス: Chart

Sheets.Charts.Chart

Table of contents

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

• new Chart(sheet, name, chartType, x, y, width, height, dataRange?, dataOrientation?, colorScheme?)

チャートを表します。

パラメータ

名前 型 説明
sheet Worksheet チャートが存在するシート。
name string チャート名。
chartType ChartType チャートの種類。
x number チャートのx位置。
y number チャートのy位置。
width number チャートの幅。
height number チャートの高さ。
dataRange? string -
dataOrientation? RowCol -
colorScheme? ColorScheme -

プロパティ

typeName

• typeName: string

シリアル化のサポートに使用される型名の文字列を表します。

メソッド

allowMove

▸ allowMove(value?): any

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

パラメータ

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

戻り値

any

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

allowResize

▸ allowResize(value?): any

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

パラメータ

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

戻り値

any

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

alt

▸ alt(value?): any

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

パラメータ

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

戻り値

any

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

axes

▸ axes(value?): any

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

パラメータ

名前 型
value? IAxes

戻り値

any

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

canPrint

▸ canPrint(value?): any

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

パラメータ

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

戻り値

any

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

chartArea

▸ chartArea(value?): any

チャートエリアのスタイルを取得または設定します。

パラメータ

名前 型
value? IChartArea

戻り値

any

値が設定されていない場合は、チャート領域のスタイルを返します。値が設定されている場合は、チャートを返します。

chartType

▸ chartType(value?): any

チャートの種類を取得または設定します。

パラメータ

名前 型
value? ChartType

戻り値

any

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

cloneContent

▸ cloneContent(): HTMLElement

インスタンスの現在の内容のコピーを取得します。

非推奨 バージョン 17.0.0 以降、このメソッドはチャートプラグインでは使用できません。このメソッドを使用するには、従来のチャートプラグインを使用してください。

戻り値

HTMLElement

インスタンスの現在の内容のコピー。

colorScheme

▸ colorScheme(value?): ColorScheme | Chart

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

パラメータ

名前 型 説明
value? ColorScheme チャートの色スタイルを表します。

戻り値

ColorScheme | Chart

値が設定されていない場合は、現在のチャートの色スタイルを返します。値が設定されている場合は、チャートを返します。

content

▸ content(value?): any

カスタムチャートの内容を取得または設定します。

非推奨 バージョン 17.0.0 以降、このメソッドはチャートプラグインでは使用できません。このメソッドを使用するには、従来のチャートプラグインを使用してください。

パラメータ

名前 型 説明
value? HTMLElement カスタムチャートの内容。

戻り値

any

値が設定されていない場合は、カスタムチャートの内容を返します。値が設定されている場合は、チャートを返します。

dataLabels

▸ dataLabels(value?): any

チャートのデータラベルのスタイルを取得または設定します。

パラメータ

名前 型
value? IDataLabels

戻り値

any

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

dataRange

▸ dataRange(value?): any

チャートのデータ範囲全体を数式文字列として取得または設定します。

パラメータ

名前 型
value? string

戻り値

any

値が設定されていない場合は、チャートのデータ範囲全体の数式文字列を返します。値が設定されている場合は、チャートを返します。

displayBlanksAs

▸ displayBlanksAs(value?): any

チャートに空のデータを表示する方法を指定します。

パラメータ

名前 型
value? DisplayBlanksAs

戻り値

any

値が設定されていない場合は、チャートが空白データを表示する方法を返します。値が設定されている場合は、チャートを返します。

displayNaAsBlank

▸ displayNaAsBlank(value?): boolean | Chart

#N/Aセルを空白セルとして表示するかどうかを取得または設定します。

パラメータ

名前 型 説明
value? boolean #N/Aセルを空白セルとして表示するかどうか。

戻り値

boolean | Chart

値が設定されていない場合は、#N/Aセルを空白セルとして表示するかどうかを返します。値が設定されている場合は、チャートを返します。

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

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

fixedPosition

▸ fixedPosition(value): any

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

非推奨 バージョン 17.0.0 以降、このメソッドはチャートプラグインでは使用できません。このメソッドを使用するには、従来のチャートプラグインを使用してください。

パラメータ

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

戻り値

any

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

formatOvers

▸ formatOvers(value?): IFormatOvers | Chart

ウォーターフォールチャートのさまざまなポイントのコレクションスタイルを取得または設定します。

パラメータ

名前 型 説明
value? IFormatOvers ウォーターフォールチャートの特定のデータポイントのコレクションスタイル。

戻り値

IFormatOvers | Chart

値が設定されていない場合は、ウォーターフォールチャートのさまざまなポイントのコレクションスタイルを返します。

getFormula

▸ getFormula(path): string

パスによってチャートから数式の文字列を取得します。

パラメータ

名前 型 説明
path string 数式の文字列を受け入れることができるパス。 「x」、「y」、「width」、「height」のいずれかに設定できます。

戻り値

string

パスによってチャートから数式の文字列を返します。

getHost

▸ getHost(): HTMLElement[]

カスタムコンテンツのDOMホストを取得します。

非推奨 バージョン 17.0.0 以降、このメソッドはチャートプラグインでは使用できません。このメソッドを使用するには、従来のチャートプラグインを使用してください。

戻り値

HTMLElement[]

height

▸ height(value?): any

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

パラメータ

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

戻り値

any

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

hoverStyle

▸ hoverStyle(value?): any

マウスがデータポイントの上に置かれたきのスタイルを取得または設定します。

パラメータ

名前 型
value? IHoverStyle

戻り値

any

値が設定されていない場合、チャートの現在のホバースタイルを返します。 それ以外の場合は、チャートを返します。

ignoreHidden

▸ ignoreHidden(value?): boolean | Chart

チャートが非表示の行と列のデータを表示する方法を取得または設定します。

パラメータ

名前 型 説明
value? boolean チャートが非表示の行と列のデータを表示する値。

戻り値

boolean | Chart

値が設定されていない場合は、チャートが非表示の行と列のデータを表示する場合は値を返します。値が設定されている場合は、チャートを返します。

isLocked

▸ isLocked(value?): any

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

パラメータ

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

戻り値

any

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

isSelected

▸ isSelected(value?): any

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

パラメータ

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

戻り値

any

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

isVisible

▸ isVisible(value?): any

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

パラメータ

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

戻り値

any

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

legend

▸ legend(value?): any

チャートの凡例を取得または設定します。

パラメータ

名前 型
value? IChartLegend

戻り値

any

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

name

▸ name(value?): any

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

パラメータ

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

戻り値

any

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

refreshContent

▸ refreshContent(): void

チャートを更新します。ほとんどの場合、このメソッドを呼び出す必要はありません。

戻り値

void

series

▸ series(): SeriesCollection

チャートの系列コレクションを取得します。

戻り値

SeriesCollection

チャートの系列コレクションを返します。

setFormula

▸ setFormula(path, formula): void

パスによってチャートに数式の文字列を設定します。

パラメータ

名前 型 説明
path string 数式の文字列を受け入れることができるパス。 「x」、「y」、「width」、「height」のいずれかに設定できます。
formula string 数式文字列。

戻り値

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

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

switchDataOrientation

▸ switchDataOrientation(): boolean

データの行と列を入れ替えます。

戻り値

boolean

データの向きが変更可能で、入れ替えが成功した場合はtrue、それ以外の場合はfalseを返します。

title

▸ title(value?): any

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

パラメータ

名前 型
value? IChartTitle

戻り値

any

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

toImageSrc

▸ toImageSrc(): string

Base64 文字列タイプのチャート画像の src を取得します。

実例

let chartImageSrc = sheet.charts.all()[0].toImageSrc();

戻り値

string

チャート画像の Base64 src 文字列を返します。

useAnimation

▸ useAnimation(value?): any

チャートにアニメーションを適用するかどうかを取得または設定します。

パラメータ

名前 型
value? boolean

戻り値

any

値が設定されていない場合は、チャートにアニメーションを適用するかどうかを返します。値が設定されている場合は、チャートを返します。

width

▸ width(value?): any

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

パラメータ

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

戻り値

any

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

x

▸ x(value?): any

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

パラメータ

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

戻り値

any

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

y

▸ y(value?): any

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

パラメータ

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

戻り値

any

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