Excel.ChartTitle class

  • Référence
Paquet:
excel

Représente un objet de titre pour un graphique.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

context

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

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

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.
horizontalAlignment

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

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.
overlay

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

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

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

Spécifie le texte du titre du graphique.
textOrientation

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.
top

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.
verticalAlignment

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

Spécifie si le titre du graphique est visible.
width

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

Méthodes

getSubstring(start, length)

Obtient la sous-chaîne d’un titre de graphique. Le saut de ligne '\n' compte un caractère.
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 passer un objet brut avec les propriétés appropriées ou 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.
setFormula(formula)

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

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.

Détails de la propriété

context

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é

Excel.RequestContext

format

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é

Excel.ChartTitleFormat

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

height

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é

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

horizontalAlignment

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

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

Valeur de propriété

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

left

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é

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

overlay

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

overlay: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

position

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é

Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

showShadow

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

showShadow: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

text

Spécifie le texte du titre du graphique.

text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

textOrientation

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é

number

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

top

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é

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

verticalAlignment

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é

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

visible

Spécifie si le titre du graphique est visible.

visible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

width

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é

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Détails de la méthode

getSubstring(start, length)

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

start

number

Position de début de la sous-chaîne à récupérer. Avec indice zéro.

length

number

Longueur de la sous-chaîne à récupérer.

Retours

Excel.ChartFormatString

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

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

Paramètres

options
Excel.Interfaces.ChartTitleLoadOptions

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

Retours

Excel.ChartTitle

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

Paramètres

propertyNames

string | string[]

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

Retours

Excel.ChartTitle

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

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

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

Excel.ChartTitle

set(properties, options)

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

properties
Excel.Interfaces.ChartTitleUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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.ChartTitle): void;

Paramètres

properties
Excel.ChartTitle

Retours

void

setFormula(formula)

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

formula

string

Chaîne qui représente la formule à définir.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

toJSON()

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

Excel.Interfaces.ChartTitleData