ExcelScript.DataBarConditionalFormat interface

  • Referenz
Paket:
ExcelScript

Stellt einen bedingten Excel-Datentyp dar.

Hinweise

Beispiele

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

Methoden

getAxisColor()

HTML-Farbcode, der die Farbe der Achsenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt. Der Wert ist "" (eine leere Zeichenfolge), wenn keine Achse vorhanden oder festgelegt ist.
getAxisFormat()

Darstellung, wie die Achse für einen Excel-Datenbalken bestimmt wird.
getBarDirection()

Gibt die Richtung an, auf der die Datenbalkengrafik basieren soll.
getLowerBoundRule()

Die Regel, was die untere Grenze (und wie sie ggf. berechnet wird) für einen Datenbalken. Das ConditionalDataBarRule -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.lowerBoundRule = {...} anstelle von x.lowerBoundRule.formula = ...).
getNegativeFormat()

Darstellung aller Werte links von der Achse in einer Excel-Datenleiste.
getPositiveFormat()

Darstellung aller Werte rechts neben der Achse in einem Excel-Datenbalken.
getShowDataBarOnly()

Bei truewerden die Werte in den Zellen ausgeblendet, in denen der Datenbalken angewendet wird.
getUpperBoundRule()

Die Regel, die bestimmt, was die obere Grenze für einen Datenbalken darstellt (und wie diese ggf. berechnet wird). Das ConditionalDataBarRule -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.upperBoundRule = {...} anstelle von x.upperBoundRule.formula = ...).
setAxisColor(axisColor)

HTML-Farbcode, der die Farbe der Achsenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt. Der Wert ist "" (eine leere Zeichenfolge), wenn keine Achse vorhanden oder festgelegt ist.
setAxisFormat(axisFormat)

Darstellung, wie die Achse für einen Excel-Datenbalken bestimmt wird.
setBarDirection(barDirection)

Gibt die Richtung an, auf der die Datenbalkengrafik basieren soll.
setLowerBoundRule(lowerBoundRule)

Die Regel, was die untere Grenze (und wie sie ggf. berechnet wird) für einen Datenbalken. Das ConditionalDataBarRule -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.lowerBoundRule = {...} anstelle von x.lowerBoundRule.formula = ...).
setShowDataBarOnly(showDataBarOnly)

Bei truewerden die Werte in den Zellen ausgeblendet, in denen der Datenbalken angewendet wird.
setUpperBoundRule(upperBoundRule)

Die Regel, die bestimmt, was die obere Grenze für einen Datenbalken darstellt (und wie diese ggf. berechnet wird). Das ConditionalDataBarRule -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.upperBoundRule = {...} anstelle von x.upperBoundRule.formula = ...).

Details zur Methode

getAxisColor()

HTML-Farbcode, der die Farbe der Achsenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt. Der Wert ist "" (eine leere Zeichenfolge), wenn keine Achse vorhanden oder festgelegt ist.

getAxisColor(): string;

Gibt zurück

string

getAxisFormat()

Darstellung, wie die Achse für einen Excel-Datenbalken bestimmt wird.

getAxisFormat(): ConditionalDataBarAxisFormat;

Gibt zurück

ExcelScript.ConditionalDataBarAxisFormat

getBarDirection()

Gibt die Richtung an, auf der die Datenbalkengrafik basieren soll.

getBarDirection(): ConditionalDataBarDirection;

Gibt zurück

ExcelScript.ConditionalDataBarDirection

getLowerBoundRule()

Die Regel, was die untere Grenze (und wie sie ggf. berechnet wird) für einen Datenbalken. Das ConditionalDataBarRule -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.lowerBoundRule = {...} anstelle von x.lowerBoundRule.formula = ...).

getLowerBoundRule(): ConditionalDataBarRule;

Gibt zurück

ExcelScript.ConditionalDataBarRule

getNegativeFormat()

Darstellung aller Werte links von der Achse in einer Excel-Datenleiste.

getNegativeFormat(): ConditionalDataBarNegativeFormat;

Gibt zurück

ExcelScript.ConditionalDataBarNegativeFormat

getPositiveFormat()

Darstellung aller Werte rechts neben der Achse in einem Excel-Datenbalken.

getPositiveFormat(): ConditionalDataBarPositiveFormat;

Gibt zurück

ExcelScript.ConditionalDataBarPositiveFormat

getShowDataBarOnly()

Bei truewerden die Werte in den Zellen ausgeblendet, in denen der Datenbalken angewendet wird.

getShowDataBarOnly(): boolean;

Gibt zurück

boolean

getUpperBoundRule()

Die Regel, die bestimmt, was die obere Grenze für einen Datenbalken darstellt (und wie diese ggf. berechnet wird). Das ConditionalDataBarRule -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.upperBoundRule = {...} anstelle von x.upperBoundRule.formula = ...).

getUpperBoundRule(): ConditionalDataBarRule;

Gibt zurück

ExcelScript.ConditionalDataBarRule

setAxisColor(axisColor)

HTML-Farbcode, der die Farbe der Achsenlinie in form #RRGGBB (z. B. "FFA500") oder als benannte HTML-Farbe (z. B. "orange") darstellt. Der Wert ist "" (eine leere Zeichenfolge), wenn keine Achse vorhanden oder festgelegt ist.

setAxisColor(axisColor: string): void;

Parameter

axisColor

string

Gibt zurück

void

setAxisFormat(axisFormat)

Darstellung, wie die Achse für einen Excel-Datenbalken bestimmt wird.

setAxisFormat(axisFormat: ConditionalDataBarAxisFormat): void;

Parameter

axisFormat
ExcelScript.ConditionalDataBarAxisFormat

Gibt zurück

void

setBarDirection(barDirection)

Gibt die Richtung an, auf der die Datenbalkengrafik basieren soll.

setBarDirection(barDirection: ConditionalDataBarDirection): void;

Parameter

barDirection
ExcelScript.ConditionalDataBarDirection

Gibt zurück

void

setLowerBoundRule(lowerBoundRule)

Die Regel, was die untere Grenze (und wie sie ggf. berechnet wird) für einen Datenbalken. Das ConditionalDataBarRule -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.lowerBoundRule = {...} anstelle von x.lowerBoundRule.formula = ...).

setLowerBoundRule(lowerBoundRule: ConditionalDataBarRule): void;

Parameter

lowerBoundRule
ExcelScript.ConditionalDataBarRule

Gibt zurück

void

setShowDataBarOnly(showDataBarOnly)

Bei truewerden die Werte in den Zellen ausgeblendet, in denen der Datenbalken angewendet wird.

setShowDataBarOnly(showDataBarOnly: boolean): void;

Parameter

showDataBarOnly

boolean

Gibt zurück

void

setUpperBoundRule(upperBoundRule)

Die Regel, die bestimmt, was die obere Grenze für einen Datenbalken darstellt (und wie diese ggf. berechnet wird). Das ConditionalDataBarRule -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.upperBoundRule = {...} anstelle von x.upperBoundRule.formula = ...).

setUpperBoundRule(upperBoundRule: ConditionalDataBarRule): void;

Parameter

upperBoundRule
ExcelScript.ConditionalDataBarRule

Gibt zurück

void