Excel.DataBarConditionalFormat class
Represents an Excel conditional data bar type.
- Extends
Remarks
Properties
| axis |
HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set. |
| axis |
Representation of how the axis is determined for an Excel data bar. |
| bar |
Specifies the direction that the data bar graphic should be based on. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| lower |
The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The |
| negative |
Representation of all values to the left of the axis in an Excel data bar. |
| positive |
Representation of all values to the right of the axis in an Excel data bar. |
| show |
If |
| upper |
The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
Property Details
axisColor
HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set.
axisColor: string;Property Value
string
Remarks
axisFormat
Representation of how the axis is determined for an Excel data bar.
axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";Property Value
Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"
Remarks
barDirection
Specifies the direction that the data bar graphic should be based on.
barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";Property Value
Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"
Remarks
Examples
// 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
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
lowerBoundRule
The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The ConditionalDataBarRule object must be set as a JSON object (use x.lowerBoundRule = {...} instead of x.lowerBoundRule.formula = ...).
lowerBoundRule: Excel.ConditionalDataBarRule;Property Value
Remarks
negativeFormat
Representation of all values to the left of the axis in an Excel data bar.
readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;Property Value
Remarks
positiveFormat
Representation of all values to the right of the axis in an Excel data bar.
readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;Property Value
Remarks
showDataBarOnly
If true, hides the values from the cells where the data bar is applied.
showDataBarOnly: boolean;Property Value
boolean
Remarks
upperBoundRule
The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The ConditionalDataBarRule object must be set as a JSON object (use x.upperBoundRule = {...} instead of x.upperBoundRule.formula = ...).
upperBoundRule: Excel.ConditionalDataBarRule;Property Value
Remarks
Method Details
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.DataBarConditionalFormat;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DataBarConditionalFormat;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.DataBarConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.DataBarConditionalFormat): void;Parameters
- properties
- Excel.DataBarConditionalFormat
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.DataBarConditionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DataBarConditionalFormatData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.DataBarConditionalFormatData;