Class SeriesRenderingHints
java.lang.Object
org.eclipse.birt.chart.computation.withaxes.SeriesRenderingHints
- All Implemented Interfaces:
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
ConstructorsConstructorDescriptionSeriesRenderingHints
(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
Modifier and TypeMethodDescriptiondouble
getClientAreaBounds
(boolean bReduceByInsets) Returns client area bounds for current series.int
double
getLocationOnOrthogonal
(Object oValue) Returns Orthogonal axis's AutoScale object.double
double
double
boolean
void
setClientAreaBounds
(Bounds bounds) Set client area bounds for current series.
-
Constructor Details
-
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 Details
-
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(Object oValue) throws ChartException, 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
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
- 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
- Specified by:
getDataPoints
in interfaceISeriesRenderingHints
- Returns:
- Detailed plotting information for the data points represented by the series rendering
- See Also:
-
isCategoryScale
public boolean isCategoryScale()- Returns:
-
getStackedSeriesLookup
- Returns:
-
getLabelPosition
- Parameters:
se
-- Returns:
- Throws:
ChartException
IllegalArgumentException
-
getLabelAttributes
- Parameters:
se
-- Returns:
- Throws:
IllegalArgumentException
-
getClientAreaBounds
Returns client area bounds for current series.- Specified by:
getClientAreaBounds
in interfaceISeriesRenderingHints
- Parameters:
bReduceByInsets
-- Returns:
-
setClientAreaBounds
Set client area bounds for current series.- Parameters:
bounds
-
-
getDataSetStructure
public int getDataSetStructure()- Specified by:
getDataSetStructure
in 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_SYNC
ISeriesRenderingHints.BASE_ORTHOGONAL_OUT_OF_SYNC
ISeriesRenderingHints.BASE_ANCILLARY_IN_SYNC
ISeriesRenderingHints.BASE_ANCILLARY_OUT_OF_SYNC
ISeriesRenderingHints.BASE_EMPTY
ISeriesRenderingHints.ORTHOGONAL_EMPTY
ISeriesRenderingHints.ANCILLARY_EMPTY
ISeriesRenderingHints.UNDEFINED
-
getBaseDataSet
- Specified by:
getBaseDataSet
in interfaceISeriesRenderingHints
- Returns:
- Returns the dataset bound to base series.
-
getOrthogonalDataSet
- Specified by:
getOrthogonalDataSet
in interfaceISeriesRenderingHints
- Returns:
- Returns the dataset bound to orthogonal series.
-
getOrthogonalScale
Returns Orthogonal axis's AutoScale object.- Returns:
- Since:
- 2.5
-