Class DataPointHints
java.lang.Object
org.eclipse.birt.chart.computation.DataPointHints
Holds the information necessary to render a DataPoint Label
-
Constructor Summary
ConstructorsConstructorDescriptionDataPointHints
(Object _oBaseValue, Object _oOrthogonalValue, Object _oSeriesValue, Object _oPercentileValue, DataPoint _dp, FormatSpecifier _fsBase, FormatSpecifier _fsOrthogonal, FormatSpecifier _fsSeries, FormatSpecifier _fsPercentile, int _idx, Location _lo, double[] _dSize, RunTimeContext _rtc) The constructor.DataPointHints
(Object _oBaseValue, Object _oOrthogonalValue, Object _oSeriesValue, Object _oPercentileValue, DataPoint _dp, FormatSpecifier _fsBase, FormatSpecifier _fsOrthogonal, FormatSpecifier _fsSeries, FormatSpecifier _fsPercentile, int _idx, Location _lo, double _dSize, RunTimeContext _rtc) DataPointHints constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
accumulate
(Object _oBaseValue, Object _oOrthogonalValue, Object _oSeriesValue, Object _oPercentileOrthogonalValue) Accumulates values to current DataPointHintes.Returns the base display value of current DataPointHintes.final String
getBaseDisplayValue
(FormatSpecifier formatSpecifier) Returns the base display value of current DataPointHintes using given format specifier.final Object
Returns the base value of current DataPointHintes.final String
Returns the display value of current DataPointHintes.final String
Returns the display value of current DataPointHintes.final int
getIndex()
Returns the index of current DataPointHints.final Location
Returns the location value of current DataPointHintes.final Location3D
Returns the 3d location value of current DataPointHintes(only available in 3d mode).final String
Returns the orthogonal display value of current DataPointHintes.final String
getOrthogonalDisplayValue
(FormatSpecifier formatSpecifier) Returns the orthogonal display value of current DataPointHintes using given format specifier.final Object
Returns the orthogonal value of current DataPointHintes.final String
Returns the percentile orthogonal display value of current DataPointHintes.final Object
Returns the percentile orthogonal value of current DataPointHintes.final String
Returns the series display value of current DataPointHintes.final String
getSeriesDisplayValue
(FormatSpecifier formatSpecifier) Returns the series display value of current DataPointHintes using given format specifier.final Object
Returns the series value of current DataPointHintes.final double
getSize()
Returns the size value of current DataPointHintes.final Size
Returns the size value of current DataPointHintes(only available in 3d mode).final Double
Returns the stacked orthogonal value.final Object
getUserValue
(String key) Returns the user value of current DataPointHintes.Returns a copy of current DataPointHints object, which is virtual.final boolean
Invalidates if current data point is outside of plot area.boolean
final void
Sets current data point is outside of plot area.final void
setBaseValue
(Object newBaseValue) Sets the base value.final void
setIndex
(int index) final void
setOrthogonalValue
(Object value) Sets orthogonal value.final void
setStackOrthogonalValue
(Double stackOrthogonalValue) final void
setUserValue
(String key, Object value) Sets the user value of current DataPointHintes.final String
toString()
-
Constructor Details
-
DataPointHints
public DataPointHints(Object _oBaseValue, Object _oOrthogonalValue, Object _oSeriesValue, 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(Object _oBaseValue, Object _oOrthogonalValue, Object _oSeriesValue, 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 Details
-
getVirtualCopy
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
Returns the base value of current DataPointHintes.- Returns:
- base value
-
getOrthogonalValue
Returns the orthogonal value of current DataPointHintes.- Returns:
- orthogonal value
-
setOrthogonalValue
Sets orthogonal value.- Parameters:
value
-- Since:
- 2.5
-
getStackOrthogonalValue
Returns the stacked orthogonal value.- Returns:
- stacked value or null if not stacked
-
setStackOrthogonalValue
-
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
Returns the series value of current DataPointHintes.- Returns:
- series value
-
getPercentileOrthogonalValue
Returns the percentile orthogonal value of current DataPointHintes.- Returns:
- percentile orthogonal value
-
getLocation
Returns the location value of current DataPointHintes.- Returns:
- location
-
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
Returns the size value of current DataPointHintes(only available in 3d mode).- Returns:
- size value
-
getUserValue
Returns the user value of current DataPointHintes.- Parameters:
key
-- Returns:
- user value
-
setUserValue
Sets the user value of current DataPointHintes.- Parameters:
key
-value
-
-
getOrthogonalDisplayValue
Returns the orthogonal display value of current DataPointHintes.- Returns:
- orthogonal value with format
-
getBaseDisplayValue
Returns the base display value of current DataPointHintes.- Returns:
- base value with format
-
getSeriesDisplayValue
Returns the series display value of current DataPointHintes.- Returns:
- series value with format
-
getPercentileOrthogonalDisplayValue
Returns the percentile orthogonal display value of current DataPointHintes.- Returns:
- percentile orthogonal value with format
-
getBaseDisplayValue
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
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
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
Returns the display value of current DataPointHintes.- Returns:
- display value
-
getDisplayValue
Returns the display value of current DataPointHintes.- Parameters:
fs
- format specifier of the value to be displayed- Returns:
- display value
-
toString
-
setBaseValue
Sets the base value.- Parameters:
newBaseValue
- the new base value
-
setIndex
public final void setIndex(int index) -
isVirtual
public boolean isVirtual()
-