Class DataPointHints


  • public class DataPointHints
    extends java.lang.Object
    Holds the information necessary to render a DataPoint Label
    • Constructor Detail

      • DataPointHints

        public DataPointHints​(java.lang.Object _oBaseValue,
                              java.lang.Object _oOrthogonalValue,
                              java.lang.Object _oSeriesValue,
                              java.lang.Object _oPercentileValue,
                              DataPoint _dp,
                              FormatSpecifier _fsBase,
                              FormatSpecifier _fsOrthogonal,
                              FormatSpecifier _fsSeries,
                              FormatSpecifier _fsPercentile,
                              int _idx,
                              Location _lo,
                              double _dSize,
                              RunTimeContext _rtc)
                       throws ChartException
        DataPointHints constructor.
        Parameters:
        _oBaseValue - Category data
        _oOrthogonalValue - Value data
        _sSeriesValue - Value Series Name
        _dp - DataPoint for combined value retrieval
        _fsBase - Category Format Specifier
        _fsOrthogonal - Value Format Specifier
        _fsSeries - Value Series Name Format Specifier
        _idx - Category Series index
        _lo - Location
        _dSize - Size
        _rtc - Runtime Context
        Throws:
        ChartException
      • DataPointHints

        public DataPointHints​(java.lang.Object _oBaseValue,
                              java.lang.Object _oOrthogonalValue,
                              java.lang.Object _oSeriesValue,
                              java.lang.Object _oPercentileValue,
                              DataPoint _dp,
                              FormatSpecifier _fsBase,
                              FormatSpecifier _fsOrthogonal,
                              FormatSpecifier _fsSeries,
                              FormatSpecifier _fsPercentile,
                              int _idx,
                              Location _lo,
                              double[] _dSize,
                              RunTimeContext _rtc)
                       throws ChartException
        The constructor.
        Parameters:
        _oBaseValue -
        _oOrthogonalValue -
        _oSeriesValue -
        _dp -
        _fsBase -
        _fsOrthogonal -
        _fsSeries -
        _idx - base Series index
        _lo -
        _dSize -
        _rtc -
        Throws:
        ChartException
    • Method Detail

      • accumulate

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

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

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

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

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

        public final void setStackOrthogonalValue​(java.lang.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 java.lang.Object getSeriesValue()
        Returns the series value of current DataPointHintes.
        Returns:
        series value
      • getPercentileOrthogonalValue

        public final java.lang.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 java.lang.Object getUserValue​(java.lang.String key)
        Returns the user value of current DataPointHintes.
        Parameters:
        key -
        Returns:
        user value
      • setUserValue

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

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

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

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

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

        public final java.lang.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 java.lang.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 java.lang.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 java.lang.String getDisplayValue()
        Returns the display value of current DataPointHintes.
        Returns:
        display value
      • getDisplayValue

        public final java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • setBaseValue

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

        public final void setIndex​(int index)
      • isVirtual

        public boolean isVirtual()