aspose.cells

Class PlotArea

Encapsulates the object that represents the plot area in a chart.

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()
Gets the chart to which this object belongs.
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 ChartFrame object.
functiongetHeight()
function
setHeight(value)
           Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.
functiongetInnerHeight()
function
           Gets or sets the height of plot area in units of 1/4000 of the chart area.
functiongetInnerWidth()
function
           Gets or sets the width of plot area in units of 1/4000 of the chart area.
functiongetInnerX()
function
setInnerX(value)
           Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
functiongetInnerY()
function
setInnerY(value)
           Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
functionisAutomaticSize()
function
           Indicates whether the plot area 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 width of plot-area bounding box in units of 1/4000 of the chart area.
functiongetX()
function
setX(value)
           Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of 1/4000 of the chart area.
functiongetY()
function
setY(value)
           Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of 1/4000 of the chart area.
 
Method Summary
functionsetPositionAuto()
Set position of the plot area to automatic
 

    • Property Getters/Setters Detail

      • getX/setX : Number 

        function getX() / function setX(value)
        
        Gets or gets the x coordinate of the upper left corner of plot-area bounding box in units of 1/4000 of the chart area.

        The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

        The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerX, InnerY, InnerWidth and InnerHeight properties.

        For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

      • getY/setY : Number 

        function getY() / function setY(value)
        
        Gets or gets the y coordinate of the upper top corner of plot-area bounding box in units of 1/4000 of the chart area.

        The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

        The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerX, InnerY, InnerWidth and InnerHeight properties.

        For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

      • getHeight/setHeight : Number 

        function getHeight() / function setHeight(value)
        
        Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.

        The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

        The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerX, InnerY, InnerWidth and InnerHeight properties.

        For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

      • getWidth/setWidth : Number 

        function getWidth() / function setWidth(value)
        
        Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area.

        The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

        The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerX, InnerY, InnerWidth and InnerHeight properties.

        For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

      • getInnerX/setInnerX : Number 

        function getInnerX() / function setInnerX(value)
        
        Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.

        The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

        The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerX, InnerY, InnerWidth and InnerHeight properties.

        For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

      • getInnerY/setInnerY : Number 

        function getInnerY() / function setInnerY(value)
        
        Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.

        The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

        The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerX, InnerY, InnerWidth and InnerHeight properties.

        For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

      • getInnerHeight/setInnerHeight : Number 

        function getInnerHeight() / function setInnerHeight(value)
        
        Gets or sets the height of plot area in units of 1/4000 of the chart area.

        The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

        The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerX, InnerY, InnerWidth and InnerHeight properties.

        For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

      • getInnerWidth/setInnerWidth : Number 

        function getInnerWidth() / function setInnerWidth(value)
        
        Gets or sets the width of plot area in units of 1/4000 of the chart area.

        The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

        The X, Y, Width and Height of PlotArea represents the plot-area bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. If you want to get actual size of plot area, you should call InnerX, InnerY, InnerWidth and InnerHeight properties.

        For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

      • isAutomaticSize/setAutomaticSize : boolean 

        function isAutomaticSize() / function setAutomaticSize(value)
        
        Indicates whether the plot area is automatic sized.
      • 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()
        
        Gets the chart to which this object belongs.
      • 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.
      • getFont : Font 

        function getFont()
        
        Gets a Font object of the specified ChartFrame object.
      • 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.
      • 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 plot area to automatic