asposecells.api

Encapsulates the object that represents an area format.

Example:

# Instantiating a Workbook object
workbook = Workbook()
# Adding a new worksheet to the Workbook object
sheetIndex = workbook.getWorksheets().add()
# Obtaining the reference of the newly added worksheet by passing its sheet index
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
chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5)
# Accessing the instance of the newly added 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")

Property Getters/Setters Summary
methodgetBackgroundColor()
method
           Gets or sets the background com.aspose.cells.Color of the Area.
methodgetFillFormat()
Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
methodgetForegroundColor()
method
           Gets or sets the foreground com.aspose.cells.Color.
methodgetFormatting()
method
           Represents the formatting of the area. The value of the property is FormattingType integer constant.
methodgetInvertIfNegative()
method
           If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
methodgetTransparency()
method
           Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
 

    • Property Getters/Setters Detail

      • getBackgroundColor/setBackgroundColor : Color 

        Color getBackgroundColor() / setBackgroundColor(value)
        
        Gets or sets the background com.aspose.cells.Color of the Area.
      • getForegroundColor/setForegroundColor : Color 

        Color getForegroundColor() / setForegroundColor(value)
        
        Gets or sets the foreground com.aspose.cells.Color.
      • getFormatting/setFormatting : int 

        int getFormatting() / setFormatting(value)
        
        Represents the formatting of the area. The value of the property is FormattingType integer constant.
      • getInvertIfNegative/setInvertIfNegative : boolean 

        boolean getInvertIfNegative() / setInvertIfNegative(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.

        Example:

        # Instantiating a Workbook object
        workbook = Workbook()
        # Adding a new worksheet to the Workbook object
        sheetIndex = workbook.getWorksheets().add()
        # Obtaining the reference of the newly added worksheet by passing its sheet index
        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
        chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5)
        # Accessing the instance of the newly added 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")
      • getFillFormat : FillFormat 

        FillFormat getFillFormat()
        
        Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
      • getTransparency/setTransparency : float 

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