Excel.ChartCollection class

ワークシート上のすべてのグラフ オブジェクトのコレクション。

Extends

注釈

[API セット: ExcelApi 1.1]

プロパティ

context

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

count

ワークシート上のグラフの数を返します。

items

このコレクション内に読み込まれた子アイテムを取得します。

メソッド

add(type, sourceData, seriesBy)

新しいグラフを作成します。

add(type, sourceData, seriesBy)

新しいグラフを作成します。

getCount()

ワークシート上のグラフの数を返します。

getItem(name)

グラフ名を使用してグラフを取得します。 同じ名前の複数のグラフがある場合は、最初の 1 つが返されます。

getItemAt(index)

コレクション内での位置を基にグラフを取得します。

getItemOrNullObject(name)

グラフ名を使用してグラフを取得します。 同じ名前の複数のグラフがある場合は、最初の 1 つが返されます。 グラフが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

イベント

onActivated

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

onAdded

ワークシートに新しいグラフが追加されたときに発生します。

onDeactivated

グラフが非アクティブになっているときに発生します。

onDeleted

グラフが削除されたときに発生します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

count

ワークシート上のグラフの数を返します。

readonly count: number;

プロパティ値

number

注釈

[API セット: ExcelApi 1.1]

items

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.Chart[];

プロパティ値

メソッドの詳細

add(type, sourceData, seriesBy)

新しいグラフを作成します。

add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy): Excel.Chart;

パラメーター

type
Excel.ChartType

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

sourceData
Excel.Range

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

seriesBy
Excel.ChartSeriesBy

省略可能。 列や行がグラフのデータ系列として使用される方法を指定します。 詳細は「Excel.ChartSeriesBy」をご覧ください。

返品

注釈

[API セット: ExcelApi 1.1]

add(type, sourceData, seriesBy)

新しいグラフを作成します。

add(type: "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", sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): Excel.Chart;

パラメーター

type

"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」をご覧ください。

sourceData
Excel.Range

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

seriesBy

"Auto" | "Columns" | "Rows"

省略可能。 列や行がグラフのデータ系列として使用される方法を指定します。 詳細は「Excel.ChartSeriesBy」をご覧ください。

返品

注釈

[API セット: ExcelApi 1.1]

getCount()

ワークシート上のグラフの数を返します。

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

[API セット: ExcelApi 1.4]

getItem(name)

グラフ名を使用してグラフを取得します。 同じ名前の複数のグラフがある場合は、最初の 1 つが返されます。

getItem(name: string): Excel.Chart;

パラメーター

name

string

取得するグラフの名前。

返品

注釈

[API セット: ExcelApi 1.1]

getItemAt(index)

コレクション内での位置を基にグラフを取得します。

getItemAt(index: number): Excel.Chart;

パラメーター

index

number

取得するオブジェクトのインデックス値。 0 を起点とする番号になります。

返品

注釈

[API セット: ExcelApi 1.1]

getItemOrNullObject(name)

グラフ名を使用してグラフを取得します。 同じ名前の複数のグラフがある場合は、最初の 1 つが返されます。 グラフが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getItemOrNullObject(name: string): Excel.Chart;

パラメーター

name

string

取得するグラフの名前。

返品

注釈

[API セット: ExcelApi 1.4]

load(options)

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

load(options?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection;

パラメーター

options

Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返品

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartCollection;

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

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

返品

toJSON()

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

toJSON(): Excel.Interfaces.ChartCollectionData;

返品

イベントの詳細

onActivated

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

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

イベントの種類

注釈

[API セット: ExcelApi 1.8]

onAdded

ワークシートに新しいグラフが追加されたときに発生します。

readonly onAdded: OfficeExtension.EventHandlers<Excel.ChartAddedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.8]

onDeactivated

グラフが非アクティブになっているときに発生します。

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

イベントの種類

注釈

[API セット: ExcelApi 1.8]

onDeleted

グラフが削除されたときに発生します。

readonly onDeleted: OfficeExtension.EventHandlers<Excel.ChartDeletedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.8]