Excel.ChartAxis class

Spécifie l’alignement de l’étiquette de graduation d’axe spécifiée. Consultez pour plus Excel.ChartTextHorizontalAlignment d’informations.

alignment: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie le groupe pour l’axe spécifié. Pour plus d’informations, consultez Excel.ChartAxisGroup .

readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie l’unité de base pour l’axe des catégories spécifié.

baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie le type d’axe des catégories.

categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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é

Spécifie la valeur d’unité d’affichage de l’axe personnalisé. Pour définir cette propriété, utilisez la SetCustomDisplayUnit(double) méthode .

readonly customDisplayUnit: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Représente l’unité d’affichage de l’axe. Pour plus d’informations, consultez Excel.ChartAxisDisplayUnit .

displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom";

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-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let chart = sheet.charts.getItemAt(0);
    let categoryAxis = chart.axes.categoryAxis;
    let valueAxis = chart.axes.valueAxis;

    // Load to get display unit.
    valueAxis.load("displayUnit");

    await context.sync();

    console.log("The vertical axis display unit is: " + valueAxis.displayUnit);
});

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é

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie la hauteur, en points, de l’axe du graphique. Retourne null si l’axe n’est pas visible.

readonly height: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie si l’axe des valeurs traverse l’axe des catégories entre les catégories.

isBetweenCategories: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie la distance, en points, entre le bord gauche de l’axe et la gauche de la zone de graphique. Retourne null si l’axe n’est pas visible.

readonly left: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie si le format de nombre est lié aux cellules. Si truela valeur est , le format numérique change dans les étiquettes lorsqu’il change dans les cellules.

linkNumberFormat: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Spécifie la base du logarithme lors de l’utilisation d’échelles logarithmiques.

logBase: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

readonly majorGridlines: Excel.ChartGridlines;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie le type de graduation principale pour l’axe spécifié. Pour plus d’informations, consultez Excel.ChartAxisTickMark .

majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie la valeur d’échelle d’unité principale pour l’axe des catégories lorsque la propriété a la categoryType valeur dateAxis.

majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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é

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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é

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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é

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

readonly minorGridlines: Excel.ChartGridlines;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie le type de graduation mineure pour l’axe spécifié. Pour plus d’informations, consultez Excel.ChartAxisTickMark .

minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie la valeur d’échelle d’unité mineure pour l’axe des catégories lorsque la propriété a la categoryType valeur dateAxis.

minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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é

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie si un axe est multiniveau.

multiLevel: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie le code de format de l’étiquette de graduation de l’axe.

numberFormat: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie la distance entre les niveaux des étiquettes et la distance entre le premier niveau et la ligne d’axe. La valeur doit être un entier compris entre 0 et 1000.

offset: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie la position d’axe spécifiée où l’autre axe se croise. Pour plus d’informations, consultez Excel.ChartAxisPosition .

position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie la position de l’axe où l’autre axe se croise. Vous devez utiliser la SetPositionAt(double) méthode pour définir cette propriété.

readonly positionAt: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie si Excel trace les points de données du dernier au premier.

reversePlotOrder: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie le type d’échelle de l’axe des valeurs. Pour plus d’informations, consultez Excel.ChartAxisScaleType .

scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie si l’étiquette d’unité d’affichage de l’axe est visible.

showDisplayUnitLabel: boolean;

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-axis.yaml

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

    // Remove display unit.
    axis.showDisplayUnitLabel = false;

    await context.sync();
});

Spécifie l’angle auquel le texte est orienté pour l’étiquette de graduation 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: any;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Spécifie la position des étiquettes de graduation sur l'axe spécifié. Pour plus d’informations, consultez Excel.ChartAxisTickLabelPosition .

tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie le nombre de catégories ou de séries entre les étiquettes de graduation. Peut être une valeur de 1 à 31999 ou une chaîne vide pour le paramètre automatique. La valeur renvoyée est toujours un nombre.

tickLabelSpacing: any;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie le nombre de catégories ou de séries entre les graduations.

tickMarkSpacing: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Représente le titre de l’axe.

readonly title: Excel.ChartAxisTitle;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Spécifie la distance, en points, entre le bord supérieur de l’axe et le haut de la zone de graphique. Retourne null si l’axe n’est pas visible.

readonly top: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie le type d’axe. Pour plus d’informations, consultez Excel.ChartAxisType .

readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie si l’axe est visible.

visible: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Spécifie la largeur, en points, de l’axe du graphique. Retourne null si l’axe n’est pas visible.

readonly width: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

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

Paramètres

Retours

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

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

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

Paramètres

Retours

Définit tous les noms de catégorie pour l’axe spécifié.

setCategoryNames(sourceData: Range): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Définit l’unité d’affichage axe sur une valeur personnalisée.

setCustomDisplayUnit(value: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Définit la position d’axe spécifiée où l’autre axe se croise.

setPositionAt(value: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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.ChartAxis d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé 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