Partager via

Excel.ChartAxis class

  • Référence
Paquet:
excel

Représente un axe unique dans 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 la mise en forme d’un objet de graphique, à savoir le format des lignes et de la police.
majorGridlines

Renvoie un objet qui représente le quadrillage principal de l’axe spécifié.
majorUnit

Représente l’intervalle entre deux graduations principales. Peut être défini sur une valeur numérique ou une chaîne vide. La valeur renvoyée est toujours un nombre.
maximum

Représente la valeur maximale sur l’axe des ordonnées. Peut être défini sur une valeur numérique ou une chaîne vide (pour les valeurs d’axe automatique). La valeur renvoyée est toujours un nombre.
minimum

Représente la valeur minimale sur l’axe des ordonnées. Peut être défini sur une valeur numérique ou une chaîne vide (pour les valeurs d’axe automatique). La valeur renvoyée est toujours un nombre.
minorGridlines

Renvoie un objet qui représente le quadrillage secondaire de l’axe spécifié.
minorUnit

Représente l’intervalle entre deux graduations secondaires. Peut être défini sur une valeur numérique ou une chaîne vide (pour les valeurs d’axe automatique). La valeur renvoyée est toujours un nombre.
title

Représente le titre de l’axe.

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.
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 d’origine Excel.ChartAxis est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ChartAxisDataque ) 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 la mise en forme d’un objet de graphique, à savoir le format des lignes et de la police.

readonly format: Excel.ChartAxisFormat;

Valeur de propriété

Excel.ChartAxisFormat

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

majorGridlines

Renvoie un objet qui représente le quadrillage principal de l’axe spécifié.

readonly majorGridlines: Excel.ChartGridlines;

Valeur de propriété

Excel.ChartGridlines

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

majorUnit

Représente l’intervalle entre deux graduations principales. Peut être défini sur une valeur numérique ou une chaîne vide. La valeur renvoyée est toujours un nombre.

majorUnit: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

maximum

Représente la valeur maximale sur l’axe des ordonnées. Peut être défini sur une valeur numérique ou une chaîne vide (pour les valeurs d’axe automatique). La valeur renvoyée est toujours un nombre.

maximum: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

minimum

Représente la valeur minimale sur l’axe des ordonnées. Peut être défini sur une valeur numérique ou une chaîne vide (pour les valeurs d’axe automatique). La valeur renvoyée est toujours un nombre.

minimum: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

minorGridlines

Renvoie un objet qui représente le quadrillage secondaire de l’axe spécifié.

readonly minorGridlines: Excel.ChartGridlines;

Valeur de propriété

Excel.ChartGridlines

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

minorUnit

Représente l’intervalle entre deux graduations secondaires. Peut être défini sur une valeur numérique ou une chaîne vide (pour les valeurs d’axe automatique). La valeur renvoyée est toujours un nombre.

minorUnit: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

title

Représente le titre de l’axe.

readonly title: Excel.ChartAxisTitle;

Valeur de propriété

Excel.ChartAxisTitle

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.ChartAxisLoadOptions): Excel.ChartAxis;

Paramètres

options
Excel.Interfaces.ChartAxisLoadOptions

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

Retours

Excel.ChartAxis

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

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

Exemples

// Get the maximum of Chart Axis from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const axis = chart.axes.valueAxis;
    axis.load('maximum');
    await context.sync();

    console.log(axis.maximum);
});

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

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

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

Paramètres

properties
Excel.Interfaces.ChartAxisUpdateData

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

Paramètres

properties
Excel.ChartAxis

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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ChartAxis est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ChartAxisDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartAxisData;

Retours

Excel.Interfaces.ChartAxisData