aspose.cells

Class ChartArea

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

Example:

//Instantiating a Workbook object
var workbook = new aspose.cells.Workbook();
//Obtaining the reference of the first worksheet
var 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
var chartIndex = worksheet.getCharts().add(aspose.cells.ChartType.COLUMN, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
var 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
var chartArea = chart.getChartArea();
//Setting the foreground color of the chart area
chartArea.getArea().setForegroundColor(aspose.cells.Color.getYellow());
//Setting Chart Area Shadow
chartArea.setShadow(true);
//Saving the Excel file
workbook.save("Book1.xls");

Property Getters/Setters Summary
functiongetArea()
Gets the area.
functiongetAutoScaleFont()
function
           True if the text in the object changes font size when the object size changes. The default value is True.
functiongetBackground()
function
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
functiongetBackgroundMode()
function
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
functiongetBorder()
Gets the Line.
functiongetChart()
functiongetDefaultHeight()
Represents height of default position
functiongetDefaultWidth()
Represents width of default position
functiongetDefaultX()
Represents x of default position
functiongetDefaultY()
Represents y of default position
functiongetFont()
Gets a Font object of the specified chartarea object.
functiongetHeight()
function
setHeight(value)
           Gets or sets the vertical offset from its lower right corner row.
functionisAutomaticSize()
function
           Indicates whether the chart frame is automatic sized.
functionisDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
functionisInnerMode()
function
           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.
functiongetShadow()
function
setShadow(value)
           True if the frame has a shadow.
functiongetShapeProperties()
Gets the ShapeProperties object.
functiongetTextFont()
Gets a Font object of the specified ChartFrame object.
functiongetWidth()
function
setWidth(value)
           Gets or sets the horizontal offset from its lower right corner column.
functiongetX()
function
setX(value)
           Gets or gets the horizontal offset from its upper left corner column.
functiongetY()
function
setY(value)
           Gets or gets the vertical offset from its upper left corner row.
 
Method Summary
functionsetPositionAuto()
Set position of the frame to automatic
 

    • Property Getters/Setters Detail

      • getX/setX : Number 

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

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

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

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

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

        function isInnerMode() / function 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.
      • getChart : Chart 

        function getChart()
        
      • getBorder : Line 

        function getBorder()
        
        Gets the Line.
      • getArea : Area 

        function getArea()
        
        Gets the area.
      • getTextFont : Font 

        function 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 

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

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

        function getBackground() / function 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 

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

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

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

        function getDefaultX()
        
        Represents x of default position
      • getDefaultY : Number 

        function getDefaultY()
        
        Represents y of default position
      • getDefaultWidth : Number 

        function getDefaultWidth()
        
        Represents width of default position
      • getDefaultHeight : Number 

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

      • setPositionAuto

        function setPositionAuto()
        Set position of the frame to automatic