Package quadbase.util

Interface IDataLine

All Superinterfaces:
Cloneable, IReferenceObj
All Known Subinterfaces:
IControlLine, IFunctionLine, IHorzVertLine, ITrendLine
public interface IDataLine extends IReferenceObj, Cloneable

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CLOSE
     
    static final int
    DASH_STYLE
     
    static final int
    DOTTED_STYLE
     
    static final int
    HIGH
     
    static final int
    LOW
     
    static final int
    OPEN
     
    static final int
    SOLID_STYLE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCoeff()
    please see the derived classes for details
    Color
    getColor()
    Get the color of the data line
    int
    getLineStyle()
    Valid for horizontal lines and vertical lines only Get the line style of this line Please see setLineStyles method in quadbase.util.IDataPointSet for the definition of line style
    int
    getLineType()
    Get the line type
    double
    getLineValue()
    please see the derived classes for details
    String
    getSeries()
    Get the name data serie use of this data line for chart with data series.
    boolean
    getShowHintValue()
    Return true if the LineValue of data line show in hint box
    int
    getThickness()
    Gets the line thickness.
    String
    getTitle()
    Returns the title for this data line
    int
    getValueColumn()
    Get the value uses for fitting for HLCO and High Low chart
    String
    getValueHint()
    Return the string use in the LineValue hint
    boolean
    isSecondaryValueUsed()
    Get the state of using subvalue data
    boolean
    isTitleVisibleInLegend()
    Returns whether the data line title being displayed in legend
    void
    setCoeff(int coeff)
    please see the derived classes for details
    void
    setColor(Color color)
    Sets the line color.
    void
    setLineStyle(int lineStyle)
    Sets the line style.
    void
    setLineType(int lineType)
    please see the derived classes for details
    void
    setLineValue(double line_value)
    please see the derived classes for details
    void
    setSeries(String series)
    This is used for charts with data series only.
    void
    setShowHintValue(boolean bshow)
    Set true/false to show the LineValue of data line in hint dialog box
    void
    setThickness(int thickness)
    Sets the line thickness.
    void
    setTitle(String title)
    Sets the title for this data line
    void
    setTitleVisibleInLegend(boolean b)
    Makes the data line title visible in the legend.
    void
    setValueColumn(int hlco_value)
    This is used for HLCO and High Low chart only
    For this type of chart you can specify which values : HIGH, LOW, CLOSE, OPEN to use.
    void
    setValueHint(String hint)
    Set the string use in the LineValue hint
    void
    useSecondaryValue(boolean state)
    Set to use secondary value instead of primary value.

    Methods inherited from interface quadbase.util.IReferenceObj

    addAnnotation, getAnnotations, getReferencePosition, isVisible, removeAnnotation

  • Field Details

  • Method Details

    • setCoeff

      void setCoeff(int coeff)
      please see the derived classes for details

    • getCoeff

      int getCoeff()
      please see the derived classes for details

    • setTitle

      void setTitle(String title)
      Sets the title for this data line
      Parameters:
      title - the title for this line used in the legend. If the title is null or unspecified, the default name is used as described above.

    • getTitle

      String getTitle()
      Returns the title for this data line
      Returns:
      the title of the data line

    • useSecondaryValue

      void useSecondaryValue(boolean state)
      Set to use secondary value instead of primary value. This is valid only when the chart contains secondary axis (i.e. combo chart). Default is false.
      Parameters:
      state - set true to use secondary axis data value

    • isSecondaryValueUsed

      boolean isSecondaryValueUsed()
      Get the state of using subvalue data
      Returns:
      true if subvalue is used to plot data line

    • setValueColumn

      void setValueColumn(int hlco_value)
      This is used for HLCO and High Low chart only
      For this type of chart you can specify which values : HIGH, LOW, CLOSE, OPEN to use. The default is CLOSE, if it is not defined, HIGH is used instead.
      Parameters:
      hlco_value - one of HIGH, LOW, CLOSE, OPEN

    • getValueColumn

      int getValueColumn()
      Get the value uses for fitting for HLCO and High Low chart
      Returns:
      one of HIGH, LOW, CLOSE, OPEN

    • setSeries

      void setSeries(String series)
      This is used for charts with data series only. The data line is drawn for this particular series. If the series name is not defined or does not match the series name of data, the data line is not drawn. To get the series name, use the properties SERIES_ORDER.
      Parameters:
      series - data series name use to plot for this data line.

    • getSeries

      String getSeries()
      Get the name data serie use of this data line for chart with data series.
      Returns:
      name of data series

    • setShowHintValue

      void setShowHintValue(boolean bshow)
      Set true/false to show the LineValue of data line in hint dialog box

    • getShowHintValue

      boolean getShowHintValue()
      Return true if the LineValue of data line show in hint box

    • getValueHint

      String getValueHint()
      Return the string use in the LineValue hint

    • setValueHint

      void setValueHint(String hint)
      Set the string use in the LineValue hint

    • setLineType

      void setLineType(int lineType)
      please see the derived classes for details

    • getLineType

      int getLineType()
      Get the line type
      Returns:
      line type

    • setColor

      void setColor(Color color)
      Sets the line color. The default color is black.
      Parameters:
      color - line color

    • getColor

      Color getColor()
      Get the color of the data line
      Returns:
      line color

    • setLineValue

      void setLineValue(double line_value)
      please see the derived classes for details

    • getLineValue

      double getLineValue()
      please see the derived classes for details

    • setTitleVisibleInLegend

      void setTitleVisibleInLegend(boolean b)
      Makes the data line title visible in the legend. The default is true.
      Parameters:
      b - if true, the title is displayed, hidden otherwise.

    • isTitleVisibleInLegend

      boolean isTitleVisibleInLegend()
      Returns whether the data line title being displayed in legend
      Returns:
      true if title is displayed, false otherwise

    • getThickness

      int getThickness()
      Gets the line thickness.
      Returns:
      line thickness.

    • setThickness

      void setThickness(int thickness)
      Sets the line thickness. The default thickness is 1.
      Parameters:
      thickness - the line thickness.

    • getLineStyle

      int getLineStyle()
      Valid for horizontal lines and vertical lines only Get the line style of this line Please see setLineStyles method in quadbase.util.IDataPointSet for the definition of line style
      Returns:
      lineStyle
      See Also:

    • setLineStyle

      void setLineStyle(int lineStyle)
      Sets the line style. By default, the line style is SOLID_STYLE. Please see setLineStyles method in @see quadbase.util.IDataPointSet for the definition of line style.
      IDataLine.SOLID_STYLE, IDataLine.DASH_STYLE and IDataLine.DOTTED_STYLE are pre-defined styles.
      SOLID_STYLE = 0;
      DASH_STYLE = (20 invalid input: '<'invalid input: '<' 16 | 5 invalid input: '<'invalid input: '<' 8);
      DOTTED_STYLE = (5 invalid input: '<'invalid input: '<' 16 | 5 invalid input: '<'invalid input: '<' 8);
      Parameters:
      lineStyle - line style of this line 

       A line style number, z, satisfies the equation:
        z = 256*fill + empty
 where fill is the number of fill pixels (solid part of dashed line)
 and empty is the number of blank pixels (empty part of dashed line)
 with fill invalid input: '<' 256 and empty invalid input: '<' 256.
 By setting well-defined numbers for z, users can create different
 types of connect lines.
 
 
      

      See Also:
      

      


      

      

      

      • 

    

    

    •