Excel.DataBarConditionalFormat class
Stellt einen bedingten Excel-Datenbalkentyp dar.
- Extends
Eigenschaften
| axis |
HTML-Farbcode, der die Farbe der Achsenlinie im Format #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. |
| axis |
Darstellung der Bestimmung der Achse für einen Excel-Datenbalken. |
| bar |
Gibt die Richtung an, auf der die Datenbalkengrafik basieren soll. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| lower |
Die Regel, was die Untergrenze für einen Datenbalken darstellt (und wie sie berechnet wird, falls zutreffend) Das |
| negative |
Darstellung aller Werte links von der Achse in einem Excel-Datenbalken. |
| positive |
Darstellung aller Werte rechts von der Achse in einem Excel-Datenbalken. |
| show |
Wenn |
| upper |
Die Regel, die bestimmt, was die obere Grenze für einen Datenbalken darstellt (und wie diese ggf. berechnet wird). Das |
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 " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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 |
Details zur Eigenschaft
axisColor
HTML-Farbcode, der die Farbe der Achsenlinie im Format #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
axisFormat
Darstellung der Bestimmung der Achse für einen Excel-Datenbalken.
axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";Eigenschaftswert
Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"
Hinweise
barDirection
Gibt die Richtung an, auf der die Datenbalkengrafik basieren soll.
barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";Eigenschaftswert
Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"
Hinweise
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 dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
lowerBoundRule
Die Regel, was die Untergrenze für einen Datenbalken darstellt (und wie sie berechnet wird, falls zutreffend) Das ConditionalDataBarRule Objekt muss als JSON-Objekt festgelegt werden (verwenden x.lowerBoundRule = {...} Sie anstelle von x.lowerBoundRule.formula = ...).
lowerBoundRule: Excel.ConditionalDataBarRule;Eigenschaftswert
Hinweise
negativeFormat
Darstellung aller Werte links von der Achse in einem Excel-Datenbalken.
readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;Eigenschaftswert
Hinweise
positiveFormat
Darstellung aller Werte rechts von der Achse in einem Excel-Datenbalken.
readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;Eigenschaftswert
Hinweise
showDataBarOnly
Wenn true, blendet die Werte in den Zellen aus, auf die der Datenbalken angewendet wird.
showDataBarOnly: boolean;Eigenschaftswert
boolean
Hinweise
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 x.upperBoundRule = {...} Sie anstelle von x.upperBoundRule.formula = ...).
upperBoundRule: Excel.ConditionalDataBarRule;Eigenschaftswert
Hinweise
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas 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
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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
- properties
- Excel.DataBarConditionalFormat
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 sie übergeben wird.) Während das ursprüngliche Excel.DataBarConditionalFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.DataBarConditionalFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.DataBarConditionalFormatData;