com.aspose.cells

Class Area

java.lang.Object

com.aspose.cells.Area

Direct Known Subclasses:

Floor

public class Area
extends java.lang.Object

Encapsulates the object that represents an area format.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         //Adding a new worksheet to the Workbook object
         int sheetIndex = workbook.getWorksheets().add();
         //Obtaining the reference of the newly added worksheet by passing its sheet index
         Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
         //Adding a sample value to "A1" cell
         worksheet.getCells().get("A1").putValue(50);
         //Adding a sample value to "A2" cell
         worksheet.getCells().get("A2").putValue(100);
         //Adding a sample value to "A3" cell
         worksheet.getCells().get("A3").putValue(150);
         //Adding a sample value to "B1" cell
         worksheet.getCells().get("B1").putValue(60);
         //Adding a sample value to "B2" cell
         worksheet.getCells().get("B2").putValue(32);
         //Adding a sample value to "B3" cell
         worksheet.getCells().get("B3").putValue(50);
         //Adding a chart to the worksheet
         int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5);
         //Accessing the instance of the newly added chart
         Chart chart = worksheet.getCharts().get(chartIndex);
         //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
         chart.getNSeries().add("A1:B3", true);
         //Setting the foreground color of the plot area
         chart.getPlotArea().getArea().setForegroundColor(Color.getBlue());
         //Setting the foreground color of the chart area
         chart.getChartArea().getArea().setForegroundColor(Color.getYellow());
         //Setting the foreground color of the 1st NSeries area
         chart.getNSeries().get(0).getArea().setForegroundColor(Color.getRed());
         //Setting the foreground color of the area of the 1st NSeries point
         chart.getNSeries().get(0).getPoints().get(0).getArea().setForegroundColor(Color.getCyan());
         //Saving the Excel file
         workbook.save("book1.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
Color	getBackgroundColor() Gets the background Color of the Area.
FillFormat	getFillFormat() Represents a getFillFormat() object that contains fill formatting properties for the specified chart or shape.
Color	getForegroundColor() Gets the foreground Color.
int	getFormatting() Represents the formatting of the area.
boolean	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.
double	getTransparency() Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
boolean	isAuto() Deprecated. Use Aspose.Cells.Drawing.Area.Formatting property instead.
boolean	isVisible() Deprecated. Use Aspose.Cells.Drawing.Area.Formatting property instead.
void	setAuto(boolean isAuto) Deprecated. Use Aspose.Cells.Drawing.Area.Formatting property instead.
void	setBackgroundColor(Color value) Sets the background Color of the Area.
void	setForegroundColor(Color value) Sets the foreground Color.
void	setFormatting(int value) Represents the formatting of the area.
void	setInvertIfNegative(boolean value) If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
void	setTransparency(double value) Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBackgroundColor

public Color getBackgroundColor()

Gets the background Color of the Area.

setBackgroundColor

public void setBackgroundColor(Color value)

Sets the background Color of the Area.

getForegroundColor

public Color getForegroundColor()

Gets the foreground Color.

setForegroundColor

public void setForegroundColor(Color value)

Sets the foreground Color.

getFormatting

public int getFormatting()

Represents the formatting of the area.

See FormattingType.

setFormatting

public void setFormatting(int value)

Represents the formatting of the area.

See FormattingType.

getInvertIfNegative

public boolean 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.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         //Adding a new worksheet to the Workbook object
         int sheetIndex = workbook.getWorksheets().add();
         //Obtaining the reference of the newly added worksheet by passing its sheet index
         Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
         //Adding a sample value to "A1" cell
         worksheet.getCells().get("A1").putValue(50);
         //Adding a sample value to "A2" cell
         worksheet.getCells().get("A2").putValue(-100);
         //Adding a sample value to "A3" cell
         worksheet.getCells().get("A3").putValue(150);
         //Adding a chart to the worksheet
         int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5);
         //Accessing the instance of the newly added chart
         Chart chart = worksheet.getCharts().get(chartIndex);
         //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "A3"
         chart.getNSeries().add("A1:A3", true);
         chart.getNSeries().get(0).getArea().setInvertIfNegative(true);
         //Setting the foreground color of the 1st NSeries area
         chart.getNSeries().get(0).getArea().setForegroundColor(Color.getRed());
         //Setting the background color of the 1st NSeries area.
         //The displayed area color of second chart point will be the background color.
         chart.getNSeries().get(0).getArea().setBackgroundColor(Color.getYellow());
         //Saving the Excel file
         workbook.save("book1.xls");
 

setInvertIfNegative

public void setInvertIfNegative(boolean value)

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

public FillFormat getFillFormat()

Represents a getFillFormat() object that contains fill formatting properties for the specified chart or shape.

getTransparency

public double getTransparency()

Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

setTransparency

public void setTransparency(double value)

Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

isAuto

public boolean isAuto()

Deprecated. Use Aspose.Cells.Drawing.Area.Formatting property instead.

Indicates Microsoft Workbook automatically determines the area pattern.

isVisible

public boolean isVisible()

Deprecated. Use Aspose.Cells.Drawing.Area.Formatting property instead.

Indicates whether the area is visible in the chart.

setAuto

public void setAuto(boolean isAuto)

Deprecated. Use Aspose.Cells.Drawing.Area.Formatting property instead.

Sets whether Microsoft Workbook automatically determines the area pattern.

Parameters:

isAuto - isAuto whether Microsoft Workbook automatically determines the area pattern.