Class DataPointHints

java.lang.Object
org.eclipse.birt.chart.computation.DataPointHints

public class DataPointHints extends Object
Holds the information necessary to render a DataPoint Label
  • Constructor Details

  • Method Details

    • getVirtualCopy

      public DataPointHints getVirtualCopy() throws ChartException
      Returns a copy of current DataPointHints object, which is virtual.
      Returns:
      copy instance
      Throws:
      ChartException
    • accumulate

      public void accumulate(Object _oBaseValue, Object _oOrthogonalValue, Object _oSeriesValue, Object _oPercentileOrthogonalValue)
      Accumulates values to current DataPointHintes.
      Parameters:
      _oBaseValue -
      _oOrthogonalValue -
      _oSeriesValue -
    • getBaseValue

      public final Object getBaseValue()
      Returns the base value of current DataPointHintes.
      Returns:
      base value
    • getOrthogonalValue

      public final Object getOrthogonalValue()
      Returns the orthogonal value of current DataPointHintes.
      Returns:
      orthogonal value
    • setOrthogonalValue

      public final void setOrthogonalValue(Object value)
      Sets orthogonal value.
      Parameters:
      value -
      Since:
      2.5
    • getStackOrthogonalValue

      public final Double getStackOrthogonalValue()
      Returns the stacked orthogonal value.
      Returns:
      stacked value or null if not stacked
    • setStackOrthogonalValue

      public final void setStackOrthogonalValue(Double stackOrthogonalValue)
    • markOutside

      public final void markOutside()
      Sets current data point is outside of plot area.
    • isOutside

      public final boolean isOutside()
      Invalidates if current data point is outside of plot area.
    • getSeriesValue

      public final Object getSeriesValue()
      Returns the series value of current DataPointHintes.
      Returns:
      series value
    • getPercentileOrthogonalValue

      public final Object getPercentileOrthogonalValue()
      Returns the percentile orthogonal value of current DataPointHintes.
      Returns:
      percentile orthogonal value
    • getLocation

      public final Location getLocation()
      Returns the location value of current DataPointHintes.
      Returns:
      location
    • getLocation3D

      public final Location3D getLocation3D()
      Returns the 3d location value of current DataPointHintes(only available in 3d mode).
      Returns:
      location
    • getIndex

      public final int getIndex()
      Returns the index of current DataPointHints.
      Returns:
      current index
    • getSize

      public final double getSize()
      Returns the size value of current DataPointHintes.
      Returns:
      size value
    • getSize2D

      public final Size getSize2D()
      Returns the size value of current DataPointHintes(only available in 3d mode).
      Returns:
      size value
    • getUserValue

      public final Object getUserValue(String key)
      Returns the user value of current DataPointHintes.
      Parameters:
      key -
      Returns:
      user value
    • setUserValue

      public final void setUserValue(String key, Object value)
      Sets the user value of current DataPointHintes.
      Parameters:
      key -
      value -
    • getOrthogonalDisplayValue

      public final String getOrthogonalDisplayValue()
      Returns the orthogonal display value of current DataPointHintes.
      Returns:
      orthogonal value with format
    • getBaseDisplayValue

      public String getBaseDisplayValue()
      Returns the base display value of current DataPointHintes.
      Returns:
      base value with format
    • getSeriesDisplayValue

      public final String getSeriesDisplayValue()
      Returns the series display value of current DataPointHintes.
      Returns:
      series value with format
    • getPercentileOrthogonalDisplayValue

      public final String getPercentileOrthogonalDisplayValue()
      Returns the percentile orthogonal display value of current DataPointHintes.
      Returns:
      percentile orthogonal value with format
    • getBaseDisplayValue

      public final String getBaseDisplayValue(FormatSpecifier formatSpecifier)
      Returns the base display value of current DataPointHintes using given format specifier.
      Parameters:
      formatSpecifier - format specifier of value to be displayed
      Returns:
      base value with format
    • getOrthogonalDisplayValue

      public final String getOrthogonalDisplayValue(FormatSpecifier formatSpecifier)
      Returns the orthogonal display value of current DataPointHintes using given format specifier.
      Parameters:
      formatSpecifier - format specifier of the value to be displayed
      Returns:
      orthogonal value with format
    • getSeriesDisplayValue

      public final String getSeriesDisplayValue(FormatSpecifier formatSpecifier)
      Returns the series display value of current DataPointHintes using given format specifier.
      Parameters:
      formatSpecifier - format specifier of the value to be displayed
      Returns:
      series value with format
    • getDisplayValue

      public final String getDisplayValue()
      Returns the display value of current DataPointHintes.
      Returns:
      display value
    • getDisplayValue

      public final String getDisplayValue(FormatSpecifier fs)
      Returns the display value of current DataPointHintes.
      Parameters:
      fs - format specifier of the value to be displayed
      Returns:
      display value
    • toString

      public final String toString()
      Overrides:
      toString in class Object
    • setBaseValue

      public final void setBaseValue(Object newBaseValue)
      Sets the base value.
      Parameters:
      newBaseValue - the new base value
    • setIndex

      public final void setIndex(int index)
    • isVirtual

      public boolean isVirtual()