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
-
-
Field Summary
-
Fields inherited from interface org.eclipse.birt.chart.render.ISeriesRenderingHints
ANCILLARY_EMPTY, BASE_ANCILLARY_IN_SYNC, BASE_ANCILLARY_OUT_OF_SYNC, BASE_EMPTY, BASE_ORTHOGONAL_IN_SYNC, BASE_ORTHOGONAL_OUT_OF_SYNC, ORTHOGONAL_EMPTY, UNDEFINED
-
-
Constructor Summary
Constructors Constructor Description 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)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description doublegetAxisLocation()DataSetIteratorgetBaseDataSet()BoundsgetClientAreaBounds(boolean bReduceByInsets)Returns client area bounds for current series.DataPointHints[]getDataPoints()intgetDataSetStructure()LabelgetLabelAttributes(Series se)PositiongetLabelPosition(Series se)doublegetLocationOnOrthogonal(java.lang.Object oValue)DataSetIteratorgetOrthogonalDataSet()AutoScalegetOrthogonalScale()Returns Orthogonal axis's AutoScale object.doublegetPlotBaseLocation()doublegetSeriesThickness()StackedSeriesLookupgetStackedSeriesLookup()AxisTickCoordinatesgetTickCoordinates()doublegetZeroLocation()booleanisCategoryScale()voidsetClientAreaBounds(Bounds bounds)Set client area bounds for current series.
-
-
-
Constructor Detail
-
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-
-
-
Method Detail
-
getAxisLocation
public 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 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 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:
ChartExceptionjava.lang.IllegalArgumentException
-
getPlotBaseLocation
public double getPlotBaseLocation()
- Returns:
-
getSeriesThickness
public double getSeriesThickness()
- Returns:
- The thickness of the series element to be rendered in a 2.5D or 3D plot
-
getTickCoordinates
public 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 DataPointHints[] getDataPoints()
- Specified by:
getDataPointsin interfaceISeriesRenderingHints- Returns:
- Detailed plotting information for the data points represented by the series rendering
- See Also:
DataPointHints
-
isCategoryScale
public boolean isCategoryScale()
- Returns:
-
getStackedSeriesLookup
public StackedSeriesLookup getStackedSeriesLookup()
- Returns:
-
getLabelPosition
public Position getLabelPosition(Series se) throws ChartException, java.lang.IllegalArgumentException
- Parameters:
se-- Returns:
- Throws:
ChartExceptionjava.lang.IllegalArgumentException
-
getLabelAttributes
public Label getLabelAttributes(Series se) throws java.lang.IllegalArgumentException
- Parameters:
se-- Returns:
- Throws:
java.lang.IllegalArgumentException
-
getClientAreaBounds
public Bounds getClientAreaBounds(boolean bReduceByInsets)
Returns client area bounds for current series.- Specified by:
getClientAreaBoundsin interfaceISeriesRenderingHints- Parameters:
bReduceByInsets-- Returns:
-
setClientAreaBounds
public void setClientAreaBounds(Bounds bounds)
Set client area bounds for current series.- Parameters:
bounds-
-
getDataSetStructure
public int getDataSetStructure()
- Specified by:
getDataSetStructurein interfaceISeriesRenderingHints- Returns:
- Returns the dataset structure state of current series rendering
hints. The value could be one of these defined in this interface:
ISeriesRenderingHints.BASE_ORTHOGONAL_IN_SYNCISeriesRenderingHints.BASE_ORTHOGONAL_OUT_OF_SYNCISeriesRenderingHints.BASE_ANCILLARY_IN_SYNCISeriesRenderingHints.BASE_ANCILLARY_OUT_OF_SYNCISeriesRenderingHints.BASE_EMPTYISeriesRenderingHints.ORTHOGONAL_EMPTYISeriesRenderingHints.ANCILLARY_EMPTYISeriesRenderingHints.UNDEFINED
-
getBaseDataSet
public DataSetIterator getBaseDataSet()
- Specified by:
getBaseDataSetin interfaceISeriesRenderingHints- Returns:
- Returns the dataset bound to base series.
-
getOrthogonalDataSet
public DataSetIterator getOrthogonalDataSet()
- Specified by:
getOrthogonalDataSetin interfaceISeriesRenderingHints- Returns:
- Returns the dataset bound to orthogonal series.
-
getOrthogonalScale
public AutoScale getOrthogonalScale()
Returns Orthogonal axis's AutoScale object.- Returns:
- Since:
- 2.5
-
-