Excel.Chart class

ブック内のグラフ オブジェクトを表します。 グラフ オブジェクト モデルの詳細については、「Excel JavaScript API を使用してグラフを操作する」を参照してください。

Extends

注釈

[API セット: ExcelApi 1.1]

プロパティ

axes

グラフの軸を表します。

categoryLabelLevel

ソース カテゴリ ラベルのレベルを参照する、グラフ カテゴリ ラベル レベルの列挙定数を指定します。

chartType

グラフの種類を指定します。 詳細は「Excel.ChartType」をご覧ください。

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

dataLabels

グラフのデータ ラベルを表します。

displayBlanksAs

グラフ上に空白セルをプロットする方法を指定します。

format

グラフ領域の書式設定プロパティをカプセル化します。

height

グラフ オブジェクトの高さをポイント単位で指定します。

id

グラフの一意の ID。

left

グラフの左側からワークシートの原点までの距離 (ポイント単位)。

legend

グラフの凡例を表します。

name

グラフ オブジェクトの名前を指定します。

pivotOptions

ピボット グラフのオプションをカプセル化します。

plotArea

グラフのプロット エリアを表します。

plotBy

列や行がグラフのデータ系列として使用される方法を指定します。

plotVisibleOnly

true の場合、可視セルだけがプロットされます。 false の場合、可視セルと非表示セルの両方がプロットされます。

series

グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。

seriesNameLevel

ソース系列名のレベルを参照するグラフ系列名レベルの列挙定数を指定します。

showAllFieldButtons

ピボットグラフにすべてのフィールド ボタンを表示するかどうかを指定します。

showDataLabelsOverMaximum

値が数値軸の最大値より大きい場合に、データ ラベルを表示するかどうかを指定します。 値の軸がデータ ポイントのサイズより小さくなった場合は、このプロパティを使用してデータ ラベルを表示するかどうかを設定できます。 このプロパティは、2-D グラフにのみ使用できます。

style

グラフのグラフ スタイルを指定します。

title

指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。

top

オブジェクトの上端から行 1 の先頭 (ワークシート上)、またはグラフ領域の一番上 (グラフ上) までの距離をポイント単位で指定します。

width

グラフ オブジェクトの幅をポイント単位で指定します。

worksheet

現在のグラフを含んでいるワークシート。

メソッド

activate()

Excel UI でグラフをアクティブにします。

delete()

グラフ オブジェクトを削除します。

getDataTable()

グラフのデータ テーブルを取得します。 グラフでデータ テーブルが許可されていない場合は、例外がスローされます。

getDataTableOrNullObject()

グラフのデータ テーブルを取得します。 グラフでデータ テーブルが許可されていない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getImage(width, height, fittingMode)

指定した寸法に合わせてグラフを拡大縮小して、グラフを Base64 でエンコードされた画像としてレンダリングします。 縦横比は、サイズ変更の一部として保持されます。

getImage(width, height, fittingMode)

指定した寸法に合わせてグラフを拡大縮小して、グラフを Base64 でエンコードされた画像としてレンダリングします。 縦横比は、サイズ変更の一部として保持されます。

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

setData(sourceData, seriesBy)

グラフの元データをリセットします。

setData(sourceData, seriesBy)

グラフの元データをリセットします。

setPosition(startCell, endCell)

ワークシート上のセルを基準にしてグラフを配置します。

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Chart オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartData と型指定) を返します。

イベント

onActivated

グラフがアクティブ化されたときに発生します。

onDeactivated

グラフが非アクティブ化されたときに発生します。

プロパティの詳細

axes

グラフの軸を表します。

readonly axes: Excel.ChartAxes;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

categoryLabelLevel

ソース カテゴリ ラベルのレベルを参照する、グラフ カテゴリ ラベル レベルの列挙定数を指定します。

categoryLabelLevel: number;

プロパティ値

number

注釈

[API セット: ExcelApi 1.8]

chartType

グラフの種類を指定します。 詳細は「Excel.ChartType」をご覧ください。

chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";

プロパティ値

Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"

注釈

[API セット: ExcelApi 1.7]

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

dataLabels

グラフのデータ ラベルを表します。

readonly dataLabels: Excel.ChartDataLabels;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

displayBlanksAs

グラフ上に空白セルをプロットする方法を指定します。

displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";

プロパティ値

Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"

注釈

[API セット: ExcelApi 1.8]

format

グラフ領域の書式設定プロパティをカプセル化します。

readonly format: Excel.ChartAreaFormat;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

height

グラフ オブジェクトの高さをポイント単位で指定します。

height: number;

プロパティ値

number

注釈

[API セット: ExcelApi 1.1]

id

グラフの一意の ID。

readonly id: string;

プロパティ値

string

注釈

[API セット: ExcelApi 1.7]

left

グラフの左側からワークシートの原点までの距離 (ポイント単位)。

left: number;

プロパティ値

number

注釈

[API セット: ExcelApi 1.1]

legend

グラフの凡例を表します。

readonly legend: Excel.ChartLegend;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

name

グラフ オブジェクトの名前を指定します。

name: string;

プロパティ値

string

注釈

[API セット: ExcelApi 1.1]

pivotOptions

ピボット グラフのオプションをカプセル化します。

readonly pivotOptions: Excel.ChartPivotOptions;

プロパティ値

注釈

[API セット: ExcelApi 1.9]

plotArea

グラフのプロット エリアを表します。

readonly plotArea: Excel.ChartPlotArea;

プロパティ値

注釈

[API セット: ExcelApi 1.8]

plotBy

列や行がグラフのデータ系列として使用される方法を指定します。

plotBy: Excel.ChartPlotBy | "Rows" | "Columns";

プロパティ値

Excel.ChartPlotBy | "Rows" | "Columns"

注釈

[API セット: ExcelApi 1.8]

plotVisibleOnly

true の場合、可視セルだけがプロットされます。 false の場合、可視セルと非表示セルの両方がプロットされます。

plotVisibleOnly: boolean;

プロパティ値

boolean

注釈

[API セット: ExcelApi 1.8]

series

グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。

readonly series: Excel.ChartSeriesCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

seriesNameLevel

ソース系列名のレベルを参照するグラフ系列名レベルの列挙定数を指定します。

seriesNameLevel: number;

プロパティ値

number

注釈

[API セット: ExcelApi 1.8]

showAllFieldButtons

ピボットグラフにすべてのフィールド ボタンを表示するかどうかを指定します。

showAllFieldButtons: boolean;

プロパティ値

boolean

注釈

[API セット: ExcelApi 1.7]

showDataLabelsOverMaximum

値が数値軸の最大値より大きい場合に、データ ラベルを表示するかどうかを指定します。 値の軸がデータ ポイントのサイズより小さくなった場合は、このプロパティを使用してデータ ラベルを表示するかどうかを設定できます。 このプロパティは、2-D グラフにのみ使用できます。

showDataLabelsOverMaximum: boolean;

プロパティ値

boolean

注釈

[API セット: ExcelApi 1.8]

style

グラフのグラフ スタイルを指定します。

style: number;

プロパティ値

number

注釈

[API セット: ExcelApi 1.8]

title

指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。

readonly title: Excel.ChartTitle;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

top

オブジェクトの上端から行 1 の先頭 (ワークシート上)、またはグラフ領域の一番上 (グラフ上) までの距離をポイント単位で指定します。

top: number;

プロパティ値

number

注釈

[API セット: ExcelApi 1.1]

width

グラフ オブジェクトの幅をポイント単位で指定します。

width: number;

プロパティ値

number

注釈

[API セット: ExcelApi 1.1]

worksheet

現在のグラフを含んでいるワークシート。

readonly worksheet: Excel.Worksheet;

プロパティ値

注釈

[API セット: ExcelApi 1.2]

メソッドの詳細

activate()

Excel UI でグラフをアクティブにします。

activate(): void;

返品

void

注釈

[API セット: ExcelApi 1.9]

delete()

グラフ オブジェクトを削除します。

delete(): void;

返品

void

注釈

[API セット: ExcelApi 1.1]

getDataTable()

グラフのデータ テーブルを取得します。 グラフでデータ テーブルが許可されていない場合は、例外がスローされます。

getDataTable(): Excel.ChartDataTable;

返品

注釈

[API セット: ExcelApi 1.14]

getDataTableOrNullObject()

グラフのデータ テーブルを取得します。 グラフでデータ テーブルが許可されていない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getDataTableOrNullObject(): Excel.ChartDataTable;

返品

注釈

[API セット: ExcelApi 1.14]

getImage(width, height, fittingMode)

指定した寸法に合わせてグラフを拡大縮小して、グラフを Base64 でエンコードされた画像としてレンダリングします。 縦横比は、サイズ変更の一部として保持されます。

getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult<string>;

パラメーター

width

number

省略可能。 結果の画像の希望する幅。

height

number

省略可能。 結果の画像の希望する高さ。

fittingMode
Excel.ImageFittingMode

省略可能。 グラフを指定したサイズにスケーリングするために使用されるメソッド (高さと幅の両方が設定されている場合)。

返品

注釈

[API セット: ExcelApi 1.2]

getImage(width, height, fittingMode)

指定した寸法に合わせてグラフを拡大縮小して、グラフを Base64 でエンコードされた画像としてレンダリングします。 縦横比は、サイズ変更の一部として保持されます。

getImage(width?: number, height?: number, fittingMode?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult<string>;

パラメーター

width

number

省略可能。 結果の画像の希望する幅。

height

number

省略可能。 結果の画像の希望する高さ。

fittingMode

"Fit" | "FitAndCenter" | "Fill"

省略可能。 グラフを指定したサイズにスケーリングするために使用されるメソッド (高さと幅の両方が設定されている場合)。

返品

注釈

[API セット: ExcelApi 1.2]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.ChartLoadOptions): Excel.Chart;

パラメーター

options
Excel.Interfaces.ChartLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.Chart;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Chart;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Excel.Interfaces.ChartUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

返品

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.Chart): void;

パラメーター

properties
Excel.Chart

返品

void

setData(sourceData, seriesBy)

グラフの元データをリセットします。

setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;

パラメーター

sourceData
Excel.Range

ソース データに対応する範囲オブジェクト。

seriesBy
Excel.ChartSeriesBy

列や行がグラフのデータ系列として使用される方法を指定します。 Auto (既定値)、Rows、Columns のいずれかになります。 詳細は「Excel.ChartSeriesBy」をご覧ください。

返品

void

注釈

[API セット: ExcelApi 1.1]

setData(sourceData, seriesBy)

グラフの元データをリセットします。

setData(sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): void;

パラメーター

sourceData
Excel.Range

ソース データに対応する範囲オブジェクト。

seriesBy

"Auto" | "Columns" | "Rows"

列や行がグラフのデータ系列として使用される方法を指定します。 Auto (既定値)、Rows、Columns のいずれかになります。 詳細は「Excel.ChartSeriesBy」をご覧ください。

返品

void

注釈

[API セット: ExcelApi 1.1]

setPosition(startCell, endCell)

ワークシート上のセルを基準にしてグラフを配置します。

setPosition(startCell: Range | string, endCell?: Range | string): void;

パラメーター

startCell

Excel.Range | string

開始セル。 これは、グラフの移動先です。 開始セルは、ユーザーの右から左への表示の設定に応じて、左上のセルか、右上のセルとなります。

endCell

Excel.Range | string

省略可能。 終了セル。 指定されている場合、グラフの幅と高さは、このセルまたは範囲を完全にカバーするように設定されます。

返品

void

注釈

[API セット: ExcelApi 1.1]

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Chart オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartData と型指定) を返します。

toJSON(): Excel.Interfaces.ChartData;

返品

イベントの詳細

onActivated

グラフがアクティブ化されたときに発生します。

readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.8]

onDeactivated

グラフが非アクティブ化されたときに発生します。

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.8]