Excel.ChartLineFormat class

Encapsule les options de mise en forme pour les éléments de ligne.

[Ensemble d’API : ExcelApi 1.1]

Extends

Propriétés

color

Code couleur HTML qui représente la couleur des lignes dans le graphique.

[Ensemble d’API : ExcelApi 1.1]

context

Contexte de demande associé à l’objet. Cela connecte le processus du add-in au processus de l’application hôte Office.

lineStyle

Représente le style de trait. Pour Excel.ChartLineStyle plus d’informations, voir.

[Ensemble d’API : ExcelApi 1.7]

weight

Représente l’épaisseur de bordure, en points.

[Ensemble d’API : ExcelApi 1.7]

Méthodes

clear()

Permet d’effacer le format de trait d’un élément de graphique.

[Ensemble d’API : ExcelApi 1.1]

load(options)

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)

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)

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.

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre un objet simple avec les propriétés appropriées ou un autre objet API du même type.

set(properties)

Définit plusieurs propriétés de l’objet en même temps, en fonction d’un objet chargé existant.

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que l’objet Excel.ChartLineFormat d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.ChartLineFormatData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

color

Code couleur HTML qui représente la couleur des lignes dans le graphique.

[Ensemble d’API : ExcelApi 1.1]

color: string;

Valeur de propriété

string

context

Contexte de demande associé à l’objet. Cela connecte le processus du add-in au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

lineStyle

Représente le style de trait. Pour Excel.ChartLineStyle plus d’informations, voir.

[Ensemble d’API : ExcelApi 1.7]

lineStyle: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot";

Valeur de propriété

Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"

weight

Représente l’épaisseur de bordure, en points.

[Ensemble d’API : ExcelApi 1.7]

weight: number;

Valeur de propriété

number

Détails de la méthode

clear()

Permet d’effacer le format de trait d’un élément de graphique.

[Ensemble d’API : ExcelApi 1.1]

clear(): void;

Retours

void

Exemples

// Set to show legend of Chart1 and make it on top of the chart.
Excel.run(function (ctx) { 
    var gridlines = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
    gridlines.format.line.clear();
    return ctx.sync().then(function() {
            console.log("Chart Major Gridlines Format Cleared");
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(options)

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.ChartLineFormatLoadOptions): Excel.ChartLineFormat;

Paramètres

options
Excel.Interfaces.ChartLineFormatLoadOptions

Fournit des options pour lesquelles les propriétés de l’objet à charger.

Retours

load(propertyNames)

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.ChartLineFormat;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Exemples

// Set chart major gridlines on value axis to be red.
Excel.run(function (ctx) {
    var gridlines = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
    gridlines.format.line.color = "#FF0000";
    return ctx.sync().then(function () {
        console.log("Chart Gridlines Color Updated");
    });
}).catch(function (error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

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?: {
            select?: string;
            expand?: string;
        }): Excel.ChartLineFormat;

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre un objet simple avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties
Excel.Interfaces.ChartLineFormatUpdateData

Objet JavaScript avec des propriétés structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option pour supprimer les erreurs si l’objet propriétés tente de définir des propriétés en lecture seule.

Retours

void

Remarques

Cette méthode possède la signature supplémentaire suivante :

set(properties: Excel.ChartLineFormat): void

set(properties)

Définit plusieurs propriétés de l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.ChartLineFormat): void;

Paramètres

Retours

void

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que l’objet Excel.ChartLineFormat d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.ChartLineFormatData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartLineFormatData;

Retours