Excel.ChartAxisTitle class

  • Référence
Paquet:
excel

Représente le titre d’un axe de 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

Spécifie la mise en forme du titre de l’axe du graphique.
text

Spécifie le titre de l’axe.
textOrientation

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

Spécifie si le titre de l’axe est visible.

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 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)

Valeur de chaîne qui représente la formule de titre de l’axe 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.ChartAxisTitle d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.ChartAxisTitleDataque ) qui 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é

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

Spécifie la mise en forme du titre de l’axe du graphique.

readonly format: Excel.ChartAxisTitleFormat;

Valeur de propriété

Excel.ChartAxisTitleFormat

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

text

Spécifie le titre de l’axe.

text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

textOrientation

Spécifie l’angle auquel le texte est orienté pour le titre de l’axe 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.12 ]

Exemples

await Excel.run(async (context) => {
  // Get a chart named "Sales Chart" from the "Sample" worksheet.
  const sheet = context.workbook.worksheets.getItem("Sample");
  let chart = sheet.charts.getItem("Sales Chart");

  // Set the value axis title to "Profits".
  chart.axes.valueAxis.title.text = "Profits";

  /* Set the value axis text orientation to 0.
    For charts with a y-axis, this makes the label on the y-axis horizontal, 
    instead of the default look of rotated-vertically.
    */ 
  chart.axes.valueAxis.title.textOrientation = 0;
  await context.sync();
});

visible

Spécifie si le titre de l’axe est visible.

visible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle;

Paramètres

options
Excel.Interfaces.ChartAxisTitleLoadOptions

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

Retours

Excel.ChartAxisTitle

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

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

Exemples

// Add "Values" as the title for the value Axis.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); 
    chart.axes.valueAxis.title.text = "Values";
    await context.sync();
    
    console.log("Axis Title Added ");
});

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

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

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.ChartAxisTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.ChartAxisTitleUpdateData

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.ChartAxisTitle): void;

Paramètres

properties
Excel.ChartAxisTitle

Retours

void

setFormula(formula)

Valeur de chaîne qui représente la formule de titre de l’axe 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.8 ]

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

toJSON(): Excel.Interfaces.ChartAxisTitleData;

Retours

Excel.Interfaces.ChartAxisTitleData