Class SeriesRenderingHints3D
- java.lang.Object
-
- org.eclipse.birt.chart.computation.withaxes.SeriesRenderingHints3D
-
- All Implemented Interfaces:
ISeriesRenderingHints,ISeriesRenderingHints3D
public final class SeriesRenderingHints3D extends java.lang.Object implements ISeriesRenderingHints3D
SeriesRenderingHints3D
-
-
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 SeriesRenderingHints3D(PlotWith3DAxes _pwa, double _dXAxisLocation, double _dZAxisLocation, double _dPlotBaseLocation, double _dPlotZeroLocation, double _dPlotHeight, AxisTickCoordinates _daXTickCoordinates, AxisTickCoordinates _daZTickCoordinates, DataPointHints[] _dpa, AutoScale _scBase, AutoScale _scOrthogonal, AutoScale _scAncillary, DataSetIterator _dsiBase, DataSetIterator _dsiOrthogonal, DataSetIterator _dsiAncillary)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataSetIteratorgetBaseDataSet()BoundsgetClientAreaBounds(boolean bReduceByInsets)Returns current client area bounds.DataPointHints[]getDataPoints()intgetDataSetStructure()LabelgetLabelAttributes(Series se)PositiongetLabelPosition(Series se)doublegetLocationOnOrthogonal(java.lang.Object oValue)DataSetIteratorgetOrthogonalDataSet()doublegetPlotBaseLocation()doublegetPlotHeight()doublegetPlotZeroLocation()DataSetIteratorgetSeriesDataSet()Returns the dataset bound to Series.doublegetXAxisLocation()AxisTickCoordinatesgetXTickCoordinates()doublegetZAxisLocation()AxisTickCoordinatesgetZTickCoordinates()booleanisXCategoryScale()booleanisZCategoryScale()
-
-
-
Constructor Detail
-
SeriesRenderingHints3D
public SeriesRenderingHints3D(PlotWith3DAxes _pwa, double _dXAxisLocation, double _dZAxisLocation, double _dPlotBaseLocation, double _dPlotZeroLocation, double _dPlotHeight, AxisTickCoordinates _daXTickCoordinates, AxisTickCoordinates _daZTickCoordinates, DataPointHints[] _dpa, AutoScale _scBase, AutoScale _scOrthogonal, AutoScale _scAncillary, DataSetIterator _dsiBase, DataSetIterator _dsiOrthogonal, DataSetIterator _dsiAncillary)
- Parameters:
_pwa-_dXAxisLocation-_dZAxisLocation-_dPlotBaseLocation-_dPlotZeroLocation-_daXTickCoordinates-_daZTickCoordinates-_dpa-_scBase-_scOrthogonal-_scAncillary-_dsiBase-_dsiOrthogonal-_dsiAncillary-
-
-
Method Detail
-
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.
-
getSeriesDataSet
public DataSetIterator getSeriesDataSet()
Description copied from interface:ISeriesRenderingHints3DReturns the dataset bound to Series.- Specified by:
getSeriesDataSetin interfaceISeriesRenderingHints3D- Returns:
-
getXAxisLocation
public double getXAxisLocation()
- Returns:
- The location (if vertical, then horizontal co-ordinate; if horizontal, then vertical co-ordinate) of the category axis used in the plot
-
getZAxisLocation
public double getZAxisLocation()
- Returns:
-
getPlotZeroLocation
public double getPlotZeroLocation()
- 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:
-
getPlotHeight
public double getPlotHeight()
- Returns:
-
getXTickCoordinates
public AxisTickCoordinates getXTickCoordinates()
- 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.
-
getZTickCoordinates
public AxisTickCoordinates getZTickCoordinates()
- Returns:
- The ticks' co-ordinates specified as a values along the Z 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
-
isXCategoryScale
public boolean isXCategoryScale()
- Returns:
-
isZCategoryScale
public boolean isZCategoryScale()
- 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)
Description copied from interface:ISeriesRenderingHintsReturns current client area bounds.- Specified by:
getClientAreaBoundsin interfaceISeriesRenderingHints- Parameters:
bReduceByInsets-- Returns:
-
-