asposecells.api

Class ChartArea

Encapsulates the object that represents the chart area in the worksheet.

Example:

# Instantiating a Workbook object
workbook = Workbook()
# Obtaining the reference of the first worksheet
worksheet = workbook.getWorksheets().get(0)
# 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)
# Getting Chart Area
chartArea = chart.getChartArea()
# Setting the foreground color of the chart area
chartArea.getArea().setForegroundColor(Color.getYellow())
# Setting Chart Area Shadow
chartArea.setShadow(True)
# Saving the Excel file
workbook.save("Book1.xls")

Property Getters/Setters Summary
methodgetArea()
Gets the area.
methodgetAutoScaleFont()
method
           True if the text in the object changes font size when the object size changes. The default value is True.
methodgetBackground()
method
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
methodgetBackgroundMode()
method
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
methodgetBorder()
Gets the Line.
methodgetChart()
methodgetDefaultHeight()
Represents height of default position
methodgetDefaultWidth()
Represents width of default position
methodgetDefaultX()
Represents x of default position
methodgetDefaultY()
Represents y of default position
methodgetFont()
Gets a Font object of the specified chartarea object.
methodgetHeight()
method
setHeight(value)
           Gets or sets the vertical offset from its lower right corner row.
methodisAutomaticSize()
method
           Indicates whether the chart frame is automatic sized.
methodisDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
methodisInnerMode()
method
           Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
methodgetShadow()
method
setShadow(value)
           True if the frame has a shadow.
methodgetShapeProperties()
Gets the ShapeProperties object.
methodgetTextFont()
Gets a Font object of the specified ChartFrame object.
methodgetWidth()
method
setWidth(value)
           Gets or sets the horizontal offset from its lower right corner column.
methodgetX()
method
setX(value)
           Gets or gets the horizontal offset from its upper left corner column.
methodgetY()
method
setY(value)
           Gets or gets the vertical offset from its upper left corner row.
 
Method Summary
methodsetPositionAuto()
Set position of the frame to automatic
 

    • Property Getters/Setters Detail

      • getX/setX : int 

        int getX() / setX(value)
        
        Gets or gets the horizontal offset from its upper left corner column.
      • getY/setY : int 

        int getY() / setY(value)
        
        Gets or gets the vertical offset from its upper left corner row.
      • getHeight/setHeight : int 

        int getHeight() / setHeight(value)
        
        Gets or sets the vertical offset from its lower right corner row.
      • getWidth/setWidth : int 

        int getWidth() / setWidth(value)
        
        Gets or sets the horizontal offset from its lower right corner column.
      • getFont : Font 

        Font getFont()
        
        Gets a Font object of the specified chartarea object.
      • isInnerMode/setInnerMode : boolean 

        boolean isInnerMode() / setInnerMode(value)
        
        Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. Only for Xlsx file.
      • getTextFont : Font 

        Font getTextFont()
        
        Gets a Font object of the specified ChartFrame object. NOTE: This member is now obsolete. Instead, please use ChartFrame.Font property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
      • getAutoScaleFont/setAutoScaleFont : boolean 

        boolean getAutoScaleFont() / setAutoScaleFont(value)
        
        True if the text in the object changes font size when the object size changes. The default value is True.
      • getBackgroundMode/setBackgroundMode : int 

        int getBackgroundMode() / setBackgroundMode(value)
        
        Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
      • getBackground/setBackground : int 

        int getBackground() / setBackground(value)
        
        Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead, please use ChartFrame.BackgroundMode property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
      • isAutomaticSize/setAutomaticSize : boolean 

        boolean isAutomaticSize() / setAutomaticSize(value)
        
        Indicates whether the chart frame is automatic sized.
      • getShadow/setShadow : boolean 

        boolean getShadow() / setShadow(value)
        
        True if the frame has a shadow.
      • isDefaultPosBeSet : boolean 

        boolean isDefaultPosBeSet()
        
        Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
      • getDefaultX : int 

        int getDefaultX()
        
        Represents x of default position
      • getDefaultY : int 

        int getDefaultY()
        
        Represents y of default position
      • getDefaultWidth : int 

        int getDefaultWidth()
        
        Represents width of default position
      • getDefaultHeight : int 

        int getDefaultHeight()
        
        Represents height of default position
    • Method Detail

      • setPositionAuto

         setPositionAuto()
        Set position of the frame to automatic