asposecells.api

Class PlotArea

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

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 ChartFrame object.
methodgetHeight()
method
setHeight(value)
           Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.
methodgetInnerHeight()
method
           Gets or sets the height of plot area in units of 1/4000 of the chart area.
methodgetInnerWidth()
method
           Gets or sets the width of plot area in units of 1/4000 of the chart area.
methodgetInnerX()
method
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.
methodgetInnerY()
method
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.
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 width of plot-area bounding box in units of 1/4000 of the chart area.
methodgetX()
method
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.
methodgetY()
method
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
methodsetPositionAuto()
Set position of the plot area to automatic
 

    • Property Getters/Setters Detail

      • getX/setX : int 

        int getX() / 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 defaut value is zero. you should call get the value after calling Chart.Calculate().

      • getY/setY : int 

        int getY() / 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 defaut value is zero. you should call get the value after calling Chart.Calculate().

      • getHeight/setHeight : int 

        int getHeight() / 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 defaut value is zero. you should call get the value after calling Chart.Calculate().

      • getWidth/setWidth : int 

        int getWidth() / 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 defaut value is zero. you should call get the value after calling Chart.Calculate().

      • getInnerX/setInnerX : int 

        int getInnerX() / 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 defaut value is zero. you should call get the value after calling Chart.Calculate().

      • getInnerY/setInnerY : int 

        int getInnerY() / 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 defaut value is zero. you should call get the value after calling Chart.Calculate().

      • getInnerHeight/setInnerHeight : int 

        int getInnerHeight() / 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 defaut value is zero. you should call get the value after calling Chart.Calculate().

      • getInnerWidth/setInnerWidth : int 

        int getInnerWidth() / 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 defaut value is zero. you should call get the value after calling Chart.Calculate().

      • 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.
      • getFont : Font 

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