Freigeben über


Excel.DataBarConditionalFormat class

Stellt einen bedingten Excel-Datentyp dar.

Extends

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Eigenschaften

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.

axisFormat

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

barDirection

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

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

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

negativeFormat

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

positiveFormat

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

showDataBarOnly

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

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

Methoden

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.DataBarConditionalFormat-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DataBarConditionalFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

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.

axisColor: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.6 ]

axisFormat

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

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.6 ]

barDirection

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

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// 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

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

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

lowerBoundRule: Excel.ConditionalDataBarRule;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

negativeFormat

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

readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

positiveFormat

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

readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

showDataBarOnly

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

showDataBarOnly: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.6 ]

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

upperBoundRule: Excel.ConditionalDataBarRule;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Details zur Methode

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat;

Parameter

options
Excel.Interfaces.DataBarConditionalFormatLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.DataBarConditionalFormat;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.DataBarConditionalFormat;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.DataBarConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties
Excel.Interfaces.DataBarConditionalFormatUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.DataBarConditionalFormat): void;

Parameter

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.DataBarConditionalFormat-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DataBarConditionalFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.DataBarConditionalFormatData;

Gibt zurück