DataBar

DataBar class

Describe the DataBar conditional formatting rule. This conditional formatting rule displays a gradated data bar in the range of cells.

class DataBar;

Example

const { Workbook, CellArea, Color, FormatConditionType, FormatConditionValueType, SaveFormat } = AsposeCells;

//Instantiating a Workbook object
var workbook = new Workbook();
var sheet = workbook.worksheets.get(0);

//Adds an empty conditional formatting
var index = sheet.conditionalFormattings.add();
var fcs = sheet.conditionalFormattings.get(index);

//Sets the conditional format range.
var ca = new CellArea();
ca.startRow = 0;
ca.endRow = 2;
ca.startColumn = 0;
ca.endColumn = 0;
fcs.addArea(ca);

//Adds condition.
var idx = fcs.addCondition(FormatConditionType.DataBar);
fcs.addArea(ca);
var cond = fcs.get(idx);

//Get Databar
var dataBar = cond.dataBar;
var orange = Color.Orange;
dataBar.color = orange;

//Set Databar properties
dataBar.minCfvo.type = FormatConditionValueType.Percentile;
dataBar.minCfvo.value = 30;
dataBar.showValue = false;

//Put Cell Values
var cell1 = sheet.cells.get("A1");
cell1.putValue(10);
var cell2 = sheet.cells.get("A2");
cell2.putValue(120);
var cell3 = sheet.cells.get("A3");
cell3.putValue(260);

//Saving the Excel file
var uint8Array = workbook.save(SaveFormat.Xlsx);

Properties

Property	Type	Description
axisColor	Color	Gets the color of the axis for cells with conditional formatting as data bars.
axisPosition	DataBarAxisPosition	Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.
barFillType	DataBarFillType	Gets or sets how a data bar is filled with color.
direction	TextDirectionType	Gets or sets the direction the databar is displayed.
barBorder	DataBarBorder	Readonly. Gets an object that specifies the border of a data bar.
negativeBarFormat	NegativeBarFormat	Readonly. Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.
minCfvo	ConditionalFormattingValue	Readonly. Get or set this DataBar’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.
maxCfvo	ConditionalFormattingValue	Readonly. Get or set this DataBar’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.
color	Color	Get or set this DataBar’s Color.
minLength	number	Represents the min length of data bar .
maxLength	number	Represents the max length of data bar .
showValue	boolean	Get or set the flag indicating whether to show the values of the cells on which this data bar is applied. Default value is true.

Methods

Method	Description
toImage(Cell, ImageOrPrintOptions)	Render data bar in cell to image byte array.

axisColor

Gets the color of the axis for cells with conditional formatting as data bars.

axisColor : Color;

axisPosition

Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.

axisPosition : DataBarAxisPosition;

barFillType

Gets or sets how a data bar is filled with color.

barFillType : DataBarFillType;

direction

Gets or sets the direction the databar is displayed.

direction : TextDirectionType;

barBorder

Readonly. Gets an object that specifies the border of a data bar.

barBorder : DataBarBorder;

negativeBarFormat

Readonly. Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.

negativeBarFormat : NegativeBarFormat;

minCfvo

Readonly. Get or set this DataBar’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.

minCfvo : ConditionalFormattingValue;

maxCfvo

Readonly. Get or set this DataBar’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.

maxCfvo : ConditionalFormattingValue;

color

Get or set this DataBar’s Color.

color : Color;

minLength

Represents the min length of data bar .

minLength : number;

maxLength

Represents the max length of data bar .

maxLength : number;

showValue

Get or set the flag indicating whether to show the values of the cells on which this data bar is applied. Default value is true.

showValue : boolean;

toImage(Cell, ImageOrPrintOptions)

Render data bar in cell to image byte array.

toImage(cell: Cell, imgOpts: ImageOrPrintOptions) : Uint8Array;

Parameters:

Parameter	Type	Description
cell	Cell	Indicate the data bar in which cell to be rendered
imgOpts	ImageOrPrintOptions	ImageOrPrintOptions contains some property of output image