Package quadbase.util

Interface IPlot

All Superinterfaces:
IGradientPropertySet, IGradientSupport
All Known Subinterfaces:
IAnnotation, ILegend
public interface IPlot extends IGradientPropertySet
This interface defines methods to modify properties associated with the plot area for the main chart as well as the legend.

A handle to an object that implements this interface can be obtained in two ways:

1. By calling the gethChartPlot method in QbChart. This returns a handle to the plot area containing the main chart.

2. By obtaining a handle to the ILegend interface, which extends IPlot.

See Also:

  • Method Details

    • getRelativeWidth

      float getRelativeWidth()
      Returns the width of the plot area relative to the main chart canvas.

      Associated QbChart property: PLOT_WIDTH

      Returns:
      The relative width of the plot area ( 0 - 1)

    • setRelativeWidth

      void setRelativeWidth(float width)
      Sets the width of the plot area relative to the main chart canvas.
      Parameters:
      width - The relative width of the chart plot area. Should be between 0 and 1.

    • getRelativeHeight

      float getRelativeHeight()
      Returns the height of the plot area relative to the main chart canvas.

      Associated QbChart property: PLOT_HEIGHT

      Returns:
      The relative height of the plot area (0 - 1)

    • setRelativeHeight

      void setRelativeHeight(float height)
      Sets the height of the plot area relative to the main chart canvas.
      Parameters:
      height - The relative height of the chart plot area. Should be between 0 and 1.

    • getPosition

      Position getPosition()
      Gets the x,y position of the chart/legend plot area relative to the main chart canvas.

      Associated QbChart property: 

       
   PLOT_XPOS
   PLOT_YPOS
   LEGEND_XPOS
   LEGEND_YPOS
      Returns:
      A Position object containing the relative x,y position of the plot area. The x and y values in the Position object are between 0 and 1.
      See Also:

    • setPosition

      void setPosition(Position p)
      Sets the x,y positon of the chart/legend plot area relative to the main chart window.
      Parameters:
      p - The Position object containing the relative positon.
      See Also:

    • isBorderVisible

      boolean isBorderVisible()
      Returns whether or not a border is drawn around the chart/legend plot area.

      Associated QbChart property: 

       
   DRAW_PLOTBORDER
   LEGEND_DRAWBORDER
      Returns:
      True if the plot area border is visible, false otherwise.

    • setBorderVisible

      void setBorderVisible(boolean b)
      Enable/Disable drawing of the border for chart/legend plot area.
      Parameters:
      b - The border drawing status.

    • getBorderColor

      Color getBorderColor()
      Returns the color of the chart/legend plot area border.

      Associated QbChart property: 

       
   PLOT_BORDERCOLOR
   LEGEND_BORDERCOLOR
      Returns:
      The Color object containing the border color.
      See Also:

    • setBorderColor

      void setBorderColor(Color c)
      Sets the border color for the chart/legend plot area.
      Parameters:
      c - The Color object containing the border color.

    • getBorderThickness

      int getBorderThickness()
      Returns the border thickness for the chart plot area.

      Associated QbChart property: PLOT_BORDER_THICKNESS

      Returns:
      The border thickness value.

    • setBorderThickness

      void setBorderThickness(int x)
      Sets the border thickness for the chart plot area.
      Parameters:
      x - The border thickness value.

    • isBackgroundVisible

      boolean isBackgroundVisible()
      Returns whether or not the background for the chart/legend plot area is visible.

      Associated QbChart property: 

       
   DRAW_PLOTBACKGROUND
   LEGEND_DRAWBACKGROUND
      Returns:
      The display status of the plot area background for 2D charts.

    • setBackgroundVisible

      void setBackgroundVisible(boolean b)
      Enables/Disables drawing of a background for the chart/legend plot area.
      Parameters:
      b - The display status for the background.

    • getBackgroundColor

      Color getBackgroundColor()
      Returns the color of the chart/legend plot area background.

      Associated QbChart property: 

       
   PLOT_BACKGROUNDCOLOR
   LEGEND_BACKGROUNDCOLOR
      Returns:
      The color of the plot area background.
      See Also:

    • setBackgroundColor

      void setBackgroundColor(Color c)
      Sets the color of the chart/legend plot area background.
      Parameters:
      c - The color value.

    • getAppearance

      int getAppearance()
      Returns the background appearance for the chart/legend plot area.

      Associated QbChart property: 

       
   PLOT_BACKGROUND_APPEARANCE
   LEGEND_APPEARANCE
      Returns:
      the background appearance. Valid values are: 
         QbChart.RAISE
   QbChart.LOWER
   QbChart.PLAIN
   QbChart.SHADOW
   QbChart.NONE

    • setAppearance

      void setAppearance(int x)
      Sets the background appearance for the chart/legend plot area.
      Parameters:
      x - The background appearance.
      See Also:

    • getDepth

      int getDepth()
      Returns the data plotting area depth.

      Associated QbChart property: 

       
   PLOT_BACKGROUND_DEPTH
   LEGEND_DEPTH
      Returns:
      The data plotting area depth

    • setDepth

      void setDepth(int x)
      Sets the data plotting area depth.
      Parameters:
      x - The data plotting area depth value.
      See Also:

    • setDialBGState

      void setDialBGState(boolean state)
      Enable or disables the dial chart plot background image.
      Parameters:
      state -

    • setDialBGImage

      void setDialBGImage(URL url, String relativeURL, int option)
      Sets the dial chart plot background image including relative URL.
      Parameters:
      url - Full URL of image
      relativeURL - Relative URL of image
      option - Image option, see ImageData class

    • setDialBGRatio

      void setDialBGRatio(double ratio)
      Sets the radius ratio for the dial chart plot background image.
      Parameters:
      ratio -

    • setDialBGImage

      void setDialBGImage(URL url, int option)
      Sets the dial chart plot background image
      Parameters:
      url - Full URL of image
      option - Image option, see ImageData class

    • getDialBGState

      boolean getDialBGState()
      Gets the state of dial chart plot background image
      Returns:
      Returns whether dial chart plot background image is enabled or disabled

    • getDialBGImageURL

      URL getDialBGImageURL()
      Gets the full URL of the dial chart plot background image
      Returns:
      The full URL of the dial chart plot background image

    • getDialBGImageRelativeURL

      String getDialBGImageRelativeURL()
      Gets the relative URL of the dial chart plot background image
      Returns:
      The relative URL of the dial chart plot background image

    • getDialBGRatio

      double getDialBGRatio()
      Gets the radius ratio of the dial chart plot background image to the plot area
      Returns:
      the radius ratio

    • setDialFGState

      void setDialFGState(boolean state)
      Enable or disables the dial chart plot foreground image.
      Parameters:
      state -

    • setDialFGImage

      void setDialFGImage(URL url, String relativeURL, int option)
      Sets the dial chart plot foreground image including relative URL.
      Parameters:
      url - Full URL of image
      relativeURL - Relative URL of image
      option - Image option, see ImageData class

    • setDialFGRatio

      void setDialFGRatio(double ratio)
      Sets the radius ratio for the dial chart plot foreground image.
      Parameters:
      ratio -

    • setDialFGImage

      void setDialFGImage(URL url, int option)
      Sets the dial chart plot foreground image
      Parameters:
      url - Full URL of image
      option - Image option, see ImageData class

    • getDialFGState

      boolean getDialFGState()
      Gets the state of dial chart plot foreground image
      Returns:
      Returns whether dial chart plot foreground image is enabled or disabled

    • getDialFGImageURL

      URL getDialFGImageURL()
      Gets the full URL of the dial chart plot foreground image
      Returns:
      The full URL of the dial chart plot foreground image

    • getDialFGImageRelativeURL

      String getDialFGImageRelativeURL()
      Gets the relative URL of the dial chart plot foreground image
      Returns:
      The relative URL of the dial chart plot foreground image

    • getDialFGRatio

      double getDialFGRatio()
      Gets the radius ratio of the dial chart plot foreground image to the plot area
      Returns:
      the radius ratio

    • setCutCornerWidth

      void setCutCornerWidth(int cutCorner)
      Gets the cut corner width for the cut corner appearance

    • getCutCornerWidth

      int getCutCornerWidth()
      Gets the cut corner width for the cut corner appearance (in pixel)