com.aspose.cells

com.aspose.cells

Class ChartArea

  • java.lang.Object 
public class ChartArea 
extends ChartFrame

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

Example:

//Instantiating a Workbook object
Workbook workbook = new Workbook();

//Obtaining the reference of the first worksheet
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
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);

//Getting Chart Area
ChartArea 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("D:\\book1.xls");

Property Getters/Setters Summary
AreagetArea()
Gets the area.
booleangetAutoScaleFont()
void
setAutoScaleFont(booleanvalue)
           True if the text in the object changes font size when the object size changes. The default value is True.
intgetBackground()
void
setBackground(intvalue)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
intgetBackgroundMode()
void
setBackgroundMode(intvalue)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
LinegetBorder()
Gets the Line.
ChartgetChart()
intgetDefaultHeight()
Represents height of default position
intgetDefaultWidth()
Represents width of default position
intgetDefaultX()
Represents x of default position
intgetDefaultY()
Represents y of default position
FontgetFont()
Gets a Font object of the specified chartarea object.
intgetHeight()
void
setHeight(intvalue)
           Gets or sets the vertical offset from its lower right corner row.
booleanisAutomaticSize()
void
setAutomaticSize(booleanvalue)
           Indicates whether the chart frame is automatic sized.
booleanisDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisInnerMode()
void
setInnerMode(booleanvalue)
           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.
booleangetShadow()
void
setShadow(booleanvalue)
           True if the frame has a shadow.
ShapePropertyCollectiongetShapeProperties()
Gets the ShapeProperties object.
FontgetTextFont()
Gets a Font object of the specified ChartFrame object.
intgetWidth()
void
setWidth(intvalue)
           Gets or sets the horizontal offset from its lower right corner column.
intgetX()
void
setX(intvalue)
           Gets or gets the horizontal offset from its upper left corner column.
intgetY()
void
setY(intvalue)
           Gets or gets the vertical offset from its upper left corner row.
 
Method Summary
voidsetPositionAuto()
Set position of the frame to automatic
 

    • Property Getters/Setters Detail

      • getX/setX

        public int getX() / public void setX(int value)
        Gets or gets the horizontal offset from its upper left corner column.

      • getY/setY

        public int getY() / public void setY(int value)
        Gets or gets the vertical offset from its upper left corner row.

      • getHeight/setHeight

        public int getHeight() / public void setHeight(int value)
        Gets or sets the vertical offset from its lower right corner row.

      • getWidth/setWidth

        public int getWidth() / public void setWidth(int value)
        Gets or sets the horizontal offset from its lower right corner column.

      • getFont

        public Font getFont()
        Gets a Font object of the specified chartarea object.

      • isInnerMode/setInnerMode

        public boolean isInnerMode() / public void setInnerMode(boolean 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.

      • getChart

        public Chart getChart()

      • getBorder

        public Line getBorder()
        Gets the Line.

      • getArea

        public Area getArea()
        Gets the area.

      • getTextFont

        public 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

        public boolean getAutoScaleFont() / public void setAutoScaleFont(boolean value)
        True if the text in the object changes font size when the object size changes. The default value is True.

      • getBackgroundMode/setBackgroundMode

        public int getBackgroundMode() / public void setBackgroundMode(int value)
        Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.

      • getBackground/setBackground

        public int getBackground() / public void setBackground(int 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

        public boolean isAutomaticSize() / public void setAutomaticSize(boolean value)
        Indicates whether the chart frame is automatic sized.

      • getShadow/setShadow

        public boolean getShadow() / public void setShadow(boolean value)
        True if the frame has a shadow.

      • isDefaultPosBeSet

        public boolean isDefaultPosBeSet()
        Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

      • getDefaultX

        public int getDefaultX()
        Represents x of default position

      • getDefaultY

        public int getDefaultY()
        Represents y of default position

      • getDefaultWidth

        public int getDefaultWidth()
        Represents width of default position

      • getDefaultHeight

        public int getDefaultHeight()
        Represents height of default position

    setX

    public voidsetX(intvalue)
    Gets or gets the horizontal offset from its upper left corner column.

    setY

    public voidsetY(intvalue)
    Gets or gets the vertical offset from its upper left corner row.

    setHeight

    public voidsetHeight(intvalue)
    Gets or sets the vertical offset from its lower right corner row.

    setWidth

    public voidsetWidth(intvalue)
    Gets or sets the horizontal offset from its lower right corner column.

    setInnerMode

    public voidsetInnerMode(booleanvalue)
    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.

    setAutoScaleFont

    public voidsetAutoScaleFont(booleanvalue)
    True if the text in the object changes font size when the object size changes. The default value is True.

    setBackgroundMode

    public voidsetBackgroundMode(intvalue)
    Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.

    setBackground

    public voidsetBackground(intvalue)
    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.

    setAutomaticSize

    public voidsetAutomaticSize(booleanvalue)
    Indicates whether the chart frame is automatic sized.

    setShadow

    public voidsetShadow(booleanvalue)
    True if the frame has a shadow.

    • Method Detail

      • setPositionAuto

        public void setPositionAuto()
        Set position of the frame to automatic