Excel.ChartTitle 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é

Représente le format du titre d’un graphique, à savoir le format de remplissage et de la police.

readonly format: Excel.ChartTitleFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Représente la hauteur, exprimée en points, du titre du graphique. La valeur est null si le titre du graphique n’est pas visible.

readonly height: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie l’alignement horizontal du titre du graphique.

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie la distance, en points, entre le bord gauche du titre du graphique et le bord gauche de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.

left: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie si le titre du graphique va superposer le graphique.

overlay: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Représente la position du titre du graphique. Pour plus d’informations, consultez Excel.ChartTitlePosition .

position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Représente une valeur booléenne qui détermine si le titre du graphique possède une ombre.

showShadow: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie le texte du titre du graphique.

text: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie l’angle vers lequel le texte est orienté pour le titre du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.

textOrientation: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const title = sheet.charts.getItemAt(0).title;
    title.textOrientation = -45;

    await context.sync();
});

Spécifie la distance, en points, entre le bord supérieur du titre du graphique et le haut de la zone de graphique. La valeur est null si le titre du graphique n’est pas visible.

top: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie l’alignement vertical du titre du graphique. Pour plus d’informations, consultez Excel.ChartTextVerticalAlignment .

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie si le titre du graphique est visible.

visible: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie la largeur, en points, du titre du graphique. La valeur est null si le titre du graphique n’est pas visible.

readonly width: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Obtient la sous-chaîne d’un titre de graphique. Le saut de ligne '\n' compte un caractère.

getSubstring(start: number, length: number): Excel.ChartFormatString;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let chart = sheet.charts.getItemAt(0);

    // Get first seven characters of the title and color them green.
    chart.title.getSubstring(0, 7).font.color = "Yellow";
    await context.sync();
});

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.ChartTitleLoadOptions): Excel.ChartTitle;

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

Paramètres

Retours

Exemples

// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    
    chart.title.text= "My Chart"; 
    chart.title.visible=true;
    chart.title.overlay=true;
    
    await context.sync();
    console.log("Char Title Changed");
});

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

Paramètres

Retours

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

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

Paramètres

Retours

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

set(properties: Excel.ChartTitle): void;

Paramètres

Retours

Définit une valeur de chaîne qui représente la formule de titre de graphique à l’aide de la notation de style A1.

setFormula(formula: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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 Excel.ChartTitle d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.ChartTitleDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartTitleData;

Retours