Excel.DataBarConditionalFormat class

  • Référence
Paquet:
excel

Représente un type de barre de données conditionnelle Excel.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

Propriétés

axisColor

Code de couleur HTML représentant la couleur de la ligne Axe, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »). La valeur est « » (chaîne vide) si aucun axe n’est présent ou défini.
axisFormat

Représentation de la façon dont l’axe est déterminé pour une barre de données Excel.
barDirection

Spécifie la direction sur laquelle le graphique de barre de données doit être basé.
context

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

Règle de ce qui constitue la limite inférieure (et comment la calculer, le cas échéant) pour une barre de données. L’objet ConditionalDataBarRule doit être défini en tant qu’objet JSON (utilisez x.lowerBoundRule = {...} au lieu de x.lowerBoundRule.formula = ...).
negativeFormat

Représentation de toutes les valeurs à gauche de l’axe dans une barre de données Excel.
positiveFormat

Représentation de toutes les valeurs à droite de l’axe dans une barre de données Excel.
showDataBarOnly

Si truela valeur est , masque les valeurs des cellules dans lesquelles la barre de données est appliquée.
upperBoundRule

Règle de ce qui constitue la limite supérieure (et comment la calculer, le cas échéant) pour une barre de données. L’objet ConditionalDataBarRule doit être défini en tant qu’objet JSON (utilisez x.upperBoundRule = {...} au lieu de x.upperBoundRule.formula = ...).

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 Excel.DataBarConditionalFormat d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.DataBarConditionalFormatDataque ) 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é

axisColor

Code de couleur HTML représentant la couleur de la ligne Axe, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »). La valeur est « » (chaîne vide) si aucun axe n’est présent ou défini.

axisColor: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

axisFormat

Représentation de la façon dont l’axe est déterminé pour une barre de données Excel.

axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";

Valeur de propriété

Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

barDirection

Spécifie la direction sur laquelle le graphique de barre de données doit être basé.

barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";

Valeur de propriété

Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.dataBar);
    conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;

    await context.sync();
});

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

lowerBoundRule

Règle de ce qui constitue la limite inférieure (et comment la calculer, le cas échéant) pour une barre de données. L’objet ConditionalDataBarRule doit être défini en tant qu’objet JSON (utilisez x.lowerBoundRule = {...} au lieu de x.lowerBoundRule.formula = ...).

lowerBoundRule: Excel.ConditionalDataBarRule;

Valeur de propriété

Excel.ConditionalDataBarRule

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

negativeFormat

Représentation de toutes les valeurs à gauche de l’axe dans une barre de données Excel.

readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;

Valeur de propriété

Excel.ConditionalDataBarNegativeFormat

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

positiveFormat

Représentation de toutes les valeurs à droite de l’axe dans une barre de données Excel.

readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;

Valeur de propriété

Excel.ConditionalDataBarPositiveFormat

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

showDataBarOnly

Si truela valeur est , masque les valeurs des cellules dans lesquelles la barre de données est appliquée.

showDataBarOnly: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

upperBoundRule

Règle de ce qui constitue la limite supérieure (et comment la calculer, le cas échéant) pour une barre de données. L’objet ConditionalDataBarRule doit être défini en tant qu’objet JSON (utilisez x.upperBoundRule = {...} au lieu de x.upperBoundRule.formula = ...).

upperBoundRule: Excel.ConditionalDataBarRule;

Valeur de propriété

Excel.ConditionalDataBarRule

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

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.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat;

Paramètres

options
Excel.Interfaces.DataBarConditionalFormatLoadOptions

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

Retours

Excel.DataBarConditionalFormat

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

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

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

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

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

Paramètres

properties
Excel.Interfaces.DataBarConditionalFormatUpdateData

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

Paramètres

properties
Excel.DataBarConditionalFormat

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

toJSON(): Excel.Interfaces.DataBarConditionalFormatData;

Retours

Excel.Interfaces.DataBarConditionalFormatData