org.eclipse.birt.chart.computation.withaxes
Class SeriesRenderingHints
java.lang.Object
org.eclipse.birt.chart.computation.withaxes.SeriesRenderingHints
- All Implemented Interfaces:
- ISeriesRenderingHints
public final class SeriesRenderingHints
- extends java.lang.Object
- implements ISeriesRenderingHints
SeriesRenderingHints
Constructor Summary |
SeriesRenderingHints(PlotWith2DAxes _pwa,
double _dAxisLocation,
double _dPlotBaseLocation,
double _dZeroLocation,
double _dSeriesThickness,
AxisTickCoordinates _daTickCoordinates,
DataPointHints[] _dpa,
AutoScale _scBase,
AutoScale _scOrthogonal,
StackedSeriesLookup _ssl,
DataSetIterator _dsiBase,
DataSetIterator _dsiOrthogonal)
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SeriesRenderingHints
public SeriesRenderingHints(PlotWith2DAxes _pwa,
double _dAxisLocation,
double _dPlotBaseLocation,
double _dZeroLocation,
double _dSeriesThickness,
AxisTickCoordinates _daTickCoordinates,
DataPointHints[] _dpa,
AutoScale _scBase,
AutoScale _scOrthogonal,
StackedSeriesLookup _ssl,
DataSetIterator _dsiBase,
DataSetIterator _dsiOrthogonal)
- Parameters:
_dAxisLocation
- _dZeroLocation
- _daTickCoordinates
- _dpa
-
getAxisLocation
public final double getAxisLocation()
- Returns:
- The location (if vertical, then horizontal co-ordinate; if
horizontal, then vertical co-ordinate) of the category axis used
in the plot
getZeroLocation
public final double getZeroLocation()
- Returns:
- The location (if vertical, then horizontal co-ordinate; if
horizontal, then vertical co-ordinate) of zero along the primary
orthogonal (value) axis used in the plot
getLocationOnOrthogonal
public final double getLocationOnOrthogonal(java.lang.Object oValue)
throws ChartException,
java.lang.IllegalArgumentException
- Parameters:
oValue
- The value for which a rendering co-ordinate is being requested
for
- Returns:
- The co-ordinate on the scale that corresponds to the requested
value
- Throws:
ChartException
java.lang.IllegalArgumentException
getPlotBaseLocation
public final double getPlotBaseLocation()
- Returns:
getSeriesThickness
public final double getSeriesThickness()
- Returns:
- The thickness of the series element to be rendered in a 2.5D or
3D plot
getTickCoordinates
public final AxisTickCoordinates getTickCoordinates()
- Returns:
- The ticks' co-ordinates specified as a values along a horizontal
or vertical category axis. The other fixed co-ordinate is
obtained via the axis location.
getDataPoints
public final DataPointHints[] getDataPoints()
- Specified by:
getDataPoints
in interface ISeriesRenderingHints
- Returns:
- Detailed plotting information for the data points represented by
the series rendering
- See Also:
DataPointHints
isCategoryScale
public final boolean isCategoryScale()
- Returns:
getStackedSeriesLookup
public final StackedSeriesLookup getStackedSeriesLookup()
- Returns:
getLabelPosition
public final Position getLabelPosition(Series se)
throws ChartException,
java.lang.IllegalArgumentException
- Parameters:
se
-
- Returns:
-
- Throws:
UndefinedValueException
UnexpectedInputException
ChartException
java.lang.IllegalArgumentException
getLabelAttributes
public final Label getLabelAttributes(Series se)
throws java.lang.IllegalArgumentException
- Parameters:
se
-
- Returns:
-
- Throws:
UnexpectedInputException
java.lang.IllegalArgumentException
getClientAreaBounds
public final Bounds getClientAreaBounds(boolean bReduceByInsets)
- Description copied from interface:
ISeriesRenderingHints
- Returns current client area bounds.
- Specified by:
getClientAreaBounds
in interface ISeriesRenderingHints
- Parameters:
bReduceByInsets
-
- Returns:
getDataSetStructure
public int getDataSetStructure()
- Specified by:
getDataSetStructure
in interface ISeriesRenderingHints
- Returns:
- Returns the dataset structure state of current series rendering
hints. The value could be one of these defined in this interface:
getBaseDataSet
public DataSetIterator getBaseDataSet()
- Specified by:
getBaseDataSet
in interface ISeriesRenderingHints
- Returns:
- Returns the dataset bound to base series.
getOrthogonalDataSet
public DataSetIterator getOrthogonalDataSet()
- Specified by:
getOrthogonalDataSet
in interface ISeriesRenderingHints
- Returns:
- Returns the dataset bound to orthogonal series.
Copyright © 2005-2008 Actuate Corp. All rights reserved.