Partager via

ExcelScript.DataBarConditionalFormat interface

  • Référence
Paquet:
ExcelScript

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

Remarques

Exemples

/**
 * This script creates data bar conditional formatting on the selected range.
 * The scale of the data bar goes from 0 to 1000.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  const selected = workbook.getSelectedRange();
  
  // Create new conditional formatting on the range.
  const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
  const dataBarFormat: ExcelScript.DataBarConditionalFormat = format.getDataBar();

  // Set the lower bound of the data bar formatting to be 0.
  const lowerBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "0"
  };
  dataBarFormat.setLowerBoundRule(lowerBound);

  // Set the upper bound of the data bar formatting to be 1000.
  const upperBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "1000"
  };
  dataBarFormat.setUpperBoundRule(upperBound);
}

Méthodes

getAxisColor()

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.
getAxisFormat()

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

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

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 = ...).
getNegativeFormat()

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

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

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

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 = ...).
setAxisColor(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.
setAxisFormat(axisFormat)

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

Spécifie la direction sur laquelle le graphique de barre de données doit être basé.
setLowerBoundRule(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 = ...).
setShowDataBarOnly(showDataBarOnly)

Si truela valeur est , masque les valeurs des cellules dans lesquelles la barre de données est appliquée.
setUpperBoundRule(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 = ...).

Détails de la méthode

getAxisColor()

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.

getAxisColor(): string;

Retours

string

getAxisFormat()

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

getAxisFormat(): ConditionalDataBarAxisFormat;

Retours

ExcelScript.ConditionalDataBarAxisFormat

getBarDirection()

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

getBarDirection(): ConditionalDataBarDirection;

Retours

ExcelScript.ConditionalDataBarDirection

getLowerBoundRule()

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

getLowerBoundRule(): ConditionalDataBarRule;

Retours

ExcelScript.ConditionalDataBarRule

getNegativeFormat()

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

getNegativeFormat(): ConditionalDataBarNegativeFormat;

Retours

ExcelScript.ConditionalDataBarNegativeFormat

getPositiveFormat()

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

getPositiveFormat(): ConditionalDataBarPositiveFormat;

Retours

ExcelScript.ConditionalDataBarPositiveFormat

getShowDataBarOnly()

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

getShowDataBarOnly(): boolean;

Retours

boolean

getUpperBoundRule()

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

getUpperBoundRule(): ConditionalDataBarRule;

Retours

ExcelScript.ConditionalDataBarRule

setAxisColor(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.

setAxisColor(axisColor: string): void;

Paramètres

axisColor

string

Retours

void

setAxisFormat(axisFormat)

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

setAxisFormat(axisFormat: ConditionalDataBarAxisFormat): void;

Paramètres

axisFormat
ExcelScript.ConditionalDataBarAxisFormat

Retours

void

setBarDirection(barDirection)

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

setBarDirection(barDirection: ConditionalDataBarDirection): void;

Paramètres

barDirection
ExcelScript.ConditionalDataBarDirection

Retours

void

setLowerBoundRule(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 = ...).

setLowerBoundRule(lowerBoundRule: ConditionalDataBarRule): void;

Paramètres

lowerBoundRule
ExcelScript.ConditionalDataBarRule

Retours

void

setShowDataBarOnly(showDataBarOnly)

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

setShowDataBarOnly(showDataBarOnly: boolean): void;

Paramètres

showDataBarOnly

boolean

Retours

void

setUpperBoundRule(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 = ...).

setUpperBoundRule(upperBoundRule: ConditionalDataBarRule): void;

Paramètres

upperBoundRule
ExcelScript.ConditionalDataBarRule

Retours

void