Excel.Chart class

ブック内のグラフ オブジェクトを表します。Represents a chart object in a workbook. グラフオブジェクトモデルの詳細については、「 Excel JAVASCRIPT API を使用してグラフを操作する」を参照してください。To learn more about the Chart object model, see Work with charts using the Excel JavaScript API.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

Extends

プロパティ

axes

グラフの軸を表します。Represents chart axes. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

categoryLabelLevel

項目ラベルのソースとなるレベルを参照している ChartCategoryLabelLevel 列挙体定数を返すか設定します。Returns or sets a ChartCategoryLabelLevel enumeration constant referring to the level of where the category labels are being sourced from. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

chartType

グラフの種類を表します。Represents the type of the chart. 詳細については、「ChartType」を参照してください。See Excel.ChartType for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

dataLabels

グラフのデータラベルを表します。Represents the datalabels on the chart. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

displayBlanksAs

空白のセルがグラフでプロットされる方法を返すか設定します。Returns or sets the way that blank cells are plotted on a chart. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

format

グラフ領域の書式設定プロパティをカプセル化します。Encapsulates the format properties for the chart area. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

height

グラフ オブジェクトの高さをポイント単位で表します。Represents the height, in points, of the chart object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

id

グラフの一意の ID。The unique id of chart. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

left

グラフの左側からワークシートの原点までの距離 (ポイント単位)。The distance, in points, from the left side of the chart to the worksheet origin.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

legend

グラフの凡例を表します。Represents the legend for the chart. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

name

グラフ オブジェクトの名前を表します。Represents the name of a chart object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

pivotOptions

ピボット グラフのオプションをカプセル化します。Encapsulates the options for a pivot chart. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

plotArea

グラフのプロット エリアを表します。Represents the plotArea for the chart.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

plotBy

グラフ上で列または行がデータ系列として使用される方法を返すか設定します。Returns or sets the way columns or rows are used as data series on the chart. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

plotVisibleOnly

true の場合、可視セルだけがプロットされます。True if only visible cells are plotted. false の場合、可視セルと非表示セルの両方がプロットされます。False if both visible and hidden cells are plotted. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

series

グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。Represents either a single series or collection of series in the chart. 値の取得のみ可能です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

seriesNameLevel

系列名のソースとなるレベルを参照している ChartSeriesNameLevel 列挙体定数を返すか設定します。Returns or sets a ChartSeriesNameLevel enumeration constant referring to the level of where the series names are being sourced from. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

showAllFieldButtons

ピボットグラフにすべてのフィールド ボタンを表示するかどうかを示します。Represents whether to display all field buttons on a PivotChart.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showDataLabelsOverMaximum

値が数値軸の最大値より大きい場合にデータ ラベルを表示するかどうかを表します。Represents whether to show the data labels when the value is greater than the maximum value on the value axis. 数値軸がデータ要素のサイズよりも小さくなった場合は、このプロパティを使用してデータラベルを表示するかどうかを設定できます。If value axis became smaller than the size of data points, you can use this property to set whether to show the data labels. このプロパティは、2-D グラフにのみ使用できます。This property applies to 2-D charts only.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

style

グラフのグラフ スタイルを返すか設定します。Returns or sets the chart style for the chart. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

title

指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. 値の取得のみ可能です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

top

オブジェクトの上端から (ワークシートの) 1 行目の上部または (グラフの) グラフ領域の上部までの距離をポイント単位で表します。Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

width

グラフ オブジェクトの幅をポイント単位で表します。Represents the width, in points, of the chart object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

worksheet

現在のグラフを含んでいるワークシート。The worksheet containing the current chart. 読み取り専用。Read-only.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

メソッド

activate()

Excel UI でグラフをアクティブにします。Activates the chart in the Excel UI.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

delete()

グラフ オブジェクトを削除します。Deletes the chart object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

getImage(width, height, fittingMode)

指定したサイズに合わせてグラフを拡大、縮小することで、グラフを Base64 でエンコードされた画像としてレンダリングします。Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. 縦横比は、サイズ変更の一部として保持されます。The aspect ratio is preserved as part of the resizing.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

getImage(width, height, fittingModeString)

指定したサイズに合わせてグラフを拡大、縮小することで、グラフを Base64 でエンコードされた画像としてレンダリングします。Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. 縦横比は、サイズ変更の一部として保持されます。The aspect ratio is preserved as part of the resizing.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

setData(sourceData, seriesBy)

グラフの元データをリセットします。Resets the source data for the chart.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

setData(sourceData, seriesByString)

グラフの元データをリセットします。Resets the source data for the chart.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

setPosition(startCell, endCell)

ワークシート上のセルを基準にしてグラフを配置します。Positions the chart relative to cells on the worksheet.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の Chart オブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.ChartData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Chart object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

イベント

onActivated

グラフがアクティブになったときに発生します。Occurs when the chart is activated.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

onDeactivated

グラフが非アクティブになったときに発生します。Occurs when the chart is deactivated.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

プロパティの詳細

axes

グラフの軸を表します。Represents chart axes. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly axes: Excel.ChartAxes;

プロパティ値

categoryLabelLevel

項目ラベルのソースとなるレベルを参照している ChartCategoryLabelLevel 列挙体定数を返すか設定します。Returns or sets a ChartCategoryLabelLevel enumeration constant referring to the level of where the category labels are being sourced from. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

categoryLabelLevel: number;

プロパティ値

number

chartType

グラフの種類を表します。Represents the type of the chart. 詳細については、「ChartType」を参照してください。See Excel.ChartType for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

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"

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

dataLabels

グラフのデータラベルを表します。Represents the datalabels on the chart. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly dataLabels: Excel.ChartDataLabels;

プロパティ値

displayBlanksAs

空白のセルがグラフでプロットされる方法を返すか設定します。Returns or sets the way that blank cells are plotted on a chart. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

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

プロパティ値

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

format

グラフ領域の書式設定プロパティをカプセル化します。Encapsulates the format properties for the chart area. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly format: Excel.ChartAreaFormat;

プロパティ値

height

グラフ オブジェクトの高さをポイント単位で表します。Represents the height, in points, of the chart object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

height: number;

プロパティ値

number

id

グラフの一意の ID。The unique id of chart. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly id: string;

プロパティ値

string

left

グラフの左側からワークシートの原点までの距離 (ポイント単位)。The distance, in points, from the left side of the chart to the worksheet origin.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

left: number;

プロパティ値

number

legend

グラフの凡例を表します。Represents the legend for the chart. 読み取り専用です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly legend: Excel.ChartLegend;

プロパティ値

name

グラフ オブジェクトの名前を表します。Represents the name of a chart object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

name: string;

プロパティ値

string

Examples

// Rename the chart to new name, resize the chart to 200 points in both height and weight. 
// Move Chart1 to 100 points to the top and left. 
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.name = "New Name";
    chart.top = 100;
    chart.left = 100;
    chart.height = 200;
    chart.width = 200;
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

pivotOptions

ピボット グラフのオプションをカプセル化します。Encapsulates the options for a pivot chart. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly pivotOptions: Excel.ChartPivotOptions;

プロパティ値

plotArea

グラフのプロット エリアを表します。Represents the plotArea for the chart.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly plotArea: Excel.ChartPlotArea;

プロパティ値

plotBy

グラフ上で列または行がデータ系列として使用される方法を返すか設定します。Returns or sets the way columns or rows are used as data series on the chart. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

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

プロパティ値

Excel.ChartPlotBy | "Rows" | "Columns"

plotVisibleOnly

true の場合、可視セルだけがプロットされます。True if only visible cells are plotted. false の場合、可視セルと非表示セルの両方がプロットされます。False if both visible and hidden cells are plotted. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

plotVisibleOnly: boolean;

プロパティ値

boolean

series

グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。Represents either a single series or collection of series in the chart. 値の取得のみ可能です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly series: Excel.ChartSeriesCollection;

プロパティ値

seriesNameLevel

系列名のソースとなるレベルを参照している ChartSeriesNameLevel 列挙体定数を返すか設定します。Returns or sets a ChartSeriesNameLevel enumeration constant referring to the level of where the series names are being sourced from. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

seriesNameLevel: number;

プロパティ値

number

showAllFieldButtons

ピボットグラフにすべてのフィールド ボタンを表示するかどうかを示します。Represents whether to display all field buttons on a PivotChart.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showAllFieldButtons: boolean;

プロパティ値

boolean

showDataLabelsOverMaximum

値が数値軸の最大値より大きい場合にデータ ラベルを表示するかどうかを表します。Represents whether to show the data labels when the value is greater than the maximum value on the value axis. 数値軸がデータ要素のサイズよりも小さくなった場合は、このプロパティを使用してデータラベルを表示するかどうかを設定できます。If value axis became smaller than the size of data points, you can use this property to set whether to show the data labels. このプロパティは、2-D グラフにのみ使用できます。This property applies to 2-D charts only.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

showDataLabelsOverMaximum: boolean;

プロパティ値

boolean

style

グラフのグラフ スタイルを返すか設定します。Returns or sets the chart style for the chart. 読み取り/書き込み可能。Read/Write.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

style: number;

プロパティ値

number

title

指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. 値の取得のみ可能です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly title: Excel.ChartTitle;

プロパティ値

top

オブジェクトの上端から (ワークシートの) 1 行目の上部または (グラフの) グラフ領域の上部までの距離をポイント単位で表します。Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

top: number;

プロパティ値

number

width

グラフ オブジェクトの幅をポイント単位で表します。Represents the width, in points, of the chart object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

width: number;

プロパティ値

number

worksheet

現在のグラフを含んでいるワークシート。The worksheet containing the current chart. 読み取り専用。Read-only.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

readonly worksheet: Excel.Worksheet;

プロパティ値

メソッドの詳細

activate()

Excel UI でグラフをアクティブにします。Activates the chart in the Excel UI.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

activate(): void;

戻り値

void

delete()

グラフ オブジェクトを削除します。Deletes the chart object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

delete(): void;

戻り値

void

Examples

Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.delete();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getImage(width, height, fittingMode)

指定したサイズに合わせてグラフを拡大、縮小することで、グラフを Base64 でエンコードされた画像としてレンダリングします。Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. 縦横比は、サイズ変更の一部として保持されます。The aspect ratio is preserved as part of the resizing.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

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

パラメーター

width
number

(省略可能) 結果の画像の希望する幅。(Optional) The desired width of the resulting image.

height
number

(省略可能) 結果の画像の希望する高さ。(Optional) The desired height of the resulting image.

fittingMode
Excel.ImageFittingMode

オプション指定した寸法 (高さと幅の両方が設定されている場合) にグラフを拡大または縮小するために使用する方法を指定します。(Optional) The method used to scale the chart to the specified to the specified dimensions (if both height and width are set).

戻り値

OfficeExtension.ClientResult<string>

Examples

Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    var image = chart.getImage();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getImage(width, height, fittingModeString)

指定したサイズに合わせてグラフを拡大、縮小することで、グラフを Base64 でエンコードされた画像としてレンダリングします。Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. 縦横比は、サイズ変更の一部として保持されます。The aspect ratio is preserved as part of the resizing.

[API セット: excelapi 1.2][ API set: ExcelApi 1.2 ]

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

パラメーター

width
number

(省略可能) 結果の画像の希望する幅。(Optional) The desired width of the resulting image.

height
number

(省略可能) 結果の画像の希望する高さ。(Optional) The desired height of the resulting image.

fittingModeString
"Fit" | "FitAndCenter" | "Fill"

オプション指定した寸法 (高さと幅の両方が設定されている場合) にグラフを拡大または縮小するために使用する方法を指定します。(Optional) The method used to scale the chart to the specified to the specified dimensions (if both height and width are set).

戻り値

OfficeExtension.ClientResult<string>

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.Chart-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.Chart - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.Chart-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.Chart - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Chart-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Chart - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

Examples

// Get a chart named "Chart1"
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.load('name');
    return ctx.sync().then(function() {
            console.log(chart.name);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.ChartUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.Chart): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Chart): void;

パラメーター

properties
Excel.Chart

戻り値

void

setData(sourceData, seriesBy)

グラフの元データをリセットします。Resets the source data for the chart.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

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

パラメーター

sourceData
Range

ソースデータに対応する range オブジェクトを指定します。The range object corresponding to the source data.

seriesBy
Excel.ChartSeriesBy

列や行がグラフのデータ系列として使用される方法を指定します。Specifies the way columns or rows are used as data series on the chart. Auto (既定)、行、列のいずれかをすることができます。Can be one of the following: Auto (default), Rows, and Columns. 詳細については、「Excel Chart系列」を参照してください。See Excel.ChartSeriesBy for details.

戻り値

void

setData(sourceData, seriesByString)

グラフの元データをリセットします。Resets the source data for the chart.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

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

パラメーター

sourceData
Range

ソースデータに対応する range オブジェクトを指定します。The range object corresponding to the source data.

seriesByString
"Auto" | "Columns" | "Rows"

列や行がグラフのデータ系列として使用される方法を指定します。Specifies the way columns or rows are used as data series on the chart. Auto (既定)、行、列のいずれかをすることができます。Can be one of the following: Auto (default), Rows, and Columns. 詳細については、「Excel Chart系列」を参照してください。See Excel.ChartSeriesBy for details.

戻り値

void

Examples

// Set the sourceData to be "A1:B4" and seriesBy to be "Columns"
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    var sourceData = "A1:B4";
    chart.setData(sourceData, "Columns");
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

setPosition(startCell, endCell)

ワークシート上のセルを基準にしてグラフを配置します。Positions the chart relative to cells on the worksheet.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

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

パラメーター

startCell
Range | string

開始セル。これは、グラフの移動先です。開始セルは、ユーザーの右から左への表示の設定に応じて、左上のセルか、右上のセルとなります。The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings.

endCell
Range | string

(省略可能) 最後のセル。(Optional) The end cell. 指定されている場合、グラフの幅と高さは、このセルまたは範囲を完全にカバーするように設定されます。If specified, the chart's width and height will be set to fully cover up this cell/range.

戻り値

void

Examples

Excel.run(function (ctx) { 
    var sheetName = "Charts";
    var rangeSelection = "A1:B4";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeSelection);
    var sourceData = sheetName + "!" + "A1:B4";
    var chart = ctx.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto");
    chart.width = 500;
    chart.height = 300;
    chart.setPosition("C2", null);
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の Chart オブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.ChartData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Chart object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartData;

戻り値

イベントの詳細

onActivated

グラフがアクティブになったときに発生します。Occurs when the chart is activated.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

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

戻り値

OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>

Examples

Excel.run(function (context){
    var pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");
    pieChart.onActivated.add(function (event) {
        return Excel.run((context) => {
            console.log("The pie chart is the active chart. ID: " + event.chartId);
            return context.sync();
        });
    });
    return context.sync();
});

onDeactivated

グラフが非アクティブになったときに発生します。Occurs when the chart is deactivated.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

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

戻り値

OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>

Examples

Excel.run(function (context){
    var pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");
    pieChart.onDeactivated.add(function (event) {
        return Excel.run((context) => {
            console.log("The pie chart is NOT active.");
            return context.sync();
        });
    });
    return context.sync();
});