com.aspose.cells

Class PlotArea

  • java.lang.Object
public class PlotArea 
extends ChartFrame

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

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
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 ChartFrame object.
intgetHeight()
void
setHeight(intvalue)
Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area.
intgetInnerHeight()
void
setInnerHeight(intvalue)
Gets or sets the height of plot area in units of 1/4000 of the chart area.
intgetInnerWidth()
void
setInnerWidth(intvalue)
Gets or sets the width of plot area in units of 1/4000 of the chart area.
intgetInnerX()
void
setInnerX(intvalue)
Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
intgetInnerY()
void
setInnerY(intvalue)
Gets or gets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area.
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 width of plot-area bounding box in units of 1/4000 of the chart area.
intgetX()
void
setX(intvalue)
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.
intgetY()
void
setY(intvalue)
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
voidsetPositionAuto()
Set position of the plot area to automatic
 

    • Property Getters/Setters Detail

      • getX/setX

        public int getX() / public void setX(int 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

        public int getY() / public void setY(int 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

        public int getHeight() / public void setHeight(int 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

        public int getWidth() / public void setWidth(int 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

        public int getInnerX() / public void setInnerX(int 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

        public int getInnerY() / public void setInnerY(int 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

        public int getInnerHeight() / public void setInnerHeight(int 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

        public int getInnerWidth() / public void setInnerWidth(int 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

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

        public Font getFont()
        
        Gets a Font object of the specified ChartFrame object.
      • 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
    • Method Detail

      • setPositionAuto

        public void setPositionAuto()
        Set position of the plot area to automatic