Area

Inheritance: java.lang.Object

public class Area

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");

Methods

Method	Description
equals(Object arg0)
getBackgroundColor()	Gets the background Color of the Area.
getClass()
getFillFormat()	Represents a getFillFormat() object that contains fill formatting properties for the specified chart or shape.
getForegroundColor()	Gets the foreground Color.
getFormatting()	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.
getTransparency()	Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
hashCode()
notify()
notifyAll()
setBackgroundColor(Color value)	Sets the background Color of the Area.
setForegroundColor(Color value)	Sets the foreground Color.
setFormatting(int value)	Represents the formatting of the area.
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.
setTransparency(double value)	Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getBackgroundColor()

public Color getBackgroundColor()

Gets the background Color of the Area.

Returns: Color

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getFillFormat()

public FillFormat getFillFormat()

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

Returns: FillFormat

getForegroundColor()

public Color getForegroundColor()

Gets the foreground Color.

Returns: Color

getFormatting()

public int getFormatting()

Represents the formatting of the area.

See FormattingType.

Returns: int

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");

Returns: boolean

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).

Returns: double

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setBackgroundColor(Color value)

public void setBackgroundColor(Color value)

Sets the background Color of the Area.

Parameters:

Parameter	Type	Description
value	Color

setForegroundColor(Color value)

public void setForegroundColor(Color value)

Sets the foreground Color.

Parameters:

Parameter	Type	Description
value	Color

setFormatting(int value)

public void setFormatting(int value)

Represents the formatting of the area.

See FormattingType.

Parameters:

Parameter	Type	Description
value	int

setInvertIfNegative(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setTransparency(double value)

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).

Parameters:

Parameter	Type	Description
value	double

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int