Excel.ChartSeriesCollection class

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Renvoie le nombre de séries de la collection.

readonly count: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.ChartSeries[];

Valeur de propriété

Ajouter une nouvelle série à la collection. La nouvelle série ajoutée n’est pas visible tant que les valeurs, les valeurs de l’axe X ou les tailles de bulles ne sont pas définies (selon le type de graphique).

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

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Renvoie le nombre de séries de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

Extrait une série en fonction de sa position dans la collection.

getItemAt(index: number): Excel.ChartSeries;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

// 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);
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Exemples

// 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);
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ChartSeriesCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ChartSeriesCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.ChartSeriesCollectionData;

Retours