Excel.ChartFont class

Cet objet représente les attributs de police (tels que le nom, la taille de police et la couleur) d’un objet graphique.

Extends

Remarques

Jeu d’API : ExcelApi 1.1

Utilisateur

Exemples

// Set the chart title font to Calibri, size 10, bold, and the color red.
await Excel.run(async (context) => { 
    const title = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title;
    title.format.font.name = "Calibri";
    title.format.font.size = 12;
    title.format.font.color = "#FF0000";
    title.format.font.italic =  false;
    title.format.font.bold = true;
    title.format.font.underline = "None";
    await context.sync();
});

Propriétés

bold

Représente le format de police Gras.

color

Code couleur HTML : représentation de la couleur du texte (par exemple, #FF0000 représente le rouge).

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

italic

Représente le format de police Italique.

name

Nom de la police (par exemple, « Calibri »)

size

Taille de la police (par exemple, 11)

underline

Type de soulignement appliqué à la police. Pour Excel.ChartUnderlineStyle plus de détails.

Méthodes

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 soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties)

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

toJSON()

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

Détails de la propriété

bold

Représente le format de police Gras.

bold: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

color

Code couleur HTML : représentation de la couleur du texte (par exemple, #FF0000 représente le rouge).

color: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.1

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

italic

Représente le format de police Italique.

italic: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

name

Nom de la police (par exemple, « Calibri »)

name: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.1

size

Taille de la police (par exemple, 11)

size: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.1

underline

Type de soulignement appliqué à la police. Pour Excel.ChartUnderlineStyle plus de détails.

underline: Excel.ChartUnderlineStyle | "None" | "Single";

Valeur de propriété

Excel.ChartUnderlineStyle | "None" | "Single"

Remarques

Jeu d’API : ExcelApi 1.1

Détails de la méthode

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.ChartFontLoadOptions): Excel.ChartFont;

Paramètres

options
Excel.Interfaces.ChartFontLoadOptions

Fournit des options pour 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.ChartFont;

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

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

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 propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

set(properties, options)

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

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

Paramètres

properties
Excel.Interfaces.ChartFontUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

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

Retours

void

set(properties)

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

set(properties: Excel.ChartFont): void;

Paramètres

properties
Excel.ChartFont

Retours

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartFontData;

Retours