Excel.ChartSeriesCollection class

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

context: RequestContext;

プロパティ値

コレクションに含まれるデータ系列の数を返します。

readonly count: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

readonly items: Excel.ChartSeries[];

プロパティ値

コレクションに新しい系列を追加します。 新しく追加された系列は、値、x 軸の値、またはバブル サイズが設定されるまで表示されません (グラフの種類に応じて)。

add(name?: string, index?: number): Excel.ChartSeries;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.7 ]

コレクションに含まれるデータ系列の数を返します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

コレクション内の位置に基づいてデータ系列を取得します。

getItemAt(index: number): Excel.ChartSeries;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.1 ]

例

// Get the name of the first series in the series collection.
await Excel.run(async (context) => { 
    const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('items');
    await context.sync();
    
    console.log(seriesCollection.items[0].name);
});

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

load(options?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection;

パラメーター

戻り値

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

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

パラメーター

戻り値

例

// Get the number of chart series in the collection.
await Excel.run(async (context) => { 
    const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('count');
    await context.sync();

    console.log("series: Count= " + seriesCollection.count);
});

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

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

パラメーター

戻り値

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

toJSON(): Excel.Interfaces.ChartSeriesCollectionData;

戻り値