Floor
Floor class
Encapsulates the object that represents the floor of a 3-D chart.
class Floor extends Area;
Example
const { License, Workbook, ChartType, Color, GradientPresetType, GradientStyleType } = require("aspose.cells.node");
//Instantiate the License class
var license = new License();
license.setLicense("input/Aspose.Cells.lic");
//Instantiate the workbook object
var workbook = new Workbook();
//Get cells collection
var cells = workbook.getWorksheets().get(0).getCells();
//Put values in cells
cells.get("A1").putValue(1);
cells.get("A2").putValue(2);
cells.get("A3").putValue(3);
//get charts colletion
var charts = workbook.getWorksheets().get(0).getCharts();
//add a new chart
var index = charts.add(ChartType.Column3DStacked, 5, 0, 15, 5);
//get the newly added chart
var chart = charts.get(index);
//set charts nseries
chart.getNSeries().add("A1:A3", true);
//Show data labels
chart.getNSeries().get(0).getDataLabels().setShowValue(true);
//Get chart's floor
var floor = chart.getFloor();
//set floor's border as red
floor.getBorder().setColor(new Color(0xff, 0, 0));
//set fill format
floor.getFillFormat().setPresetColorGradient(GradientPresetType.CalmWater, GradientStyleType.DiagonalDown, 2);
//save the file
workbook.save("output/ChartsFloor.xls");
Constructors
| Name | Description |
|---|---|
| constructor(Area) | Constructs from a parent object convertible to this. |
Methods
| Method | Description |
|---|---|
| getBorder() | Gets or sets the border Line. |
| setBorder(Line) | Gets or sets the border Line. |
| isNull() | Checks whether the implementation object is null. |
| getBackgroundColor() | Gets or sets the background Color of the Area. |
| setBackgroundColor(Color) | Gets or sets the background Color of the Area. |
| getForegroundColor() | Gets or sets the foreground Color. |
| setForegroundColor(Color) | Gets or sets the foreground Color. |
| getFormatting() | Represents the formatting of the area. |
| setFormatting(FormattingType) | Represents the formatting of the area. |
| getInvertIfNegative() | If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged. |
| setInvertIfNegative(boolean) | If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged. |
| getFillFormat() | Represents a FillFormat object that contains fill formatting properties for the specified chart or shape. |
| getTransparency() | Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). |
| setTransparency(number) | Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). |
constructor(Area)
Constructs from a parent object convertible to this.
constructor(obj: Area);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | Area | The parent object. |
getBorder()
Gets or sets the border Line.
getBorder() : Line;
Returns
setBorder(Line)
Gets or sets the border Line.
setBorder(value: Line) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Line | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getBackgroundColor()
Gets or sets the background Color of the Area.
getBackgroundColor() : Color;
Returns
setBackgroundColor(Color)
Gets or sets the background Color of the Area.
setBackgroundColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getForegroundColor()
Gets or sets the foreground Color.
getForegroundColor() : Color;
Returns
setForegroundColor(Color)
Gets or sets the foreground Color.
setForegroundColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getFormatting()
Represents the formatting of the area.
getFormatting() : FormattingType;
Returns
setFormatting(FormattingType)
Represents the formatting of the area.
setFormatting(value: FormattingType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FormattingType | The value to set. |
getInvertIfNegative()
If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
getInvertIfNegative() : boolean;
setInvertIfNegative(boolean)
If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
setInvertIfNegative(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getFillFormat()
Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
getFillFormat() : FillFormat;
Returns
getTransparency()
Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
getTransparency() : number;
setTransparency(number)
Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
setTransparency(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |