|
FreeHEP API Version 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
User level interface to a plotter region. A region is managed by a plotter. A region must be seen as a scene manager handling a custome "plotting" scene. In general this kind of scene may be in 2D or 3D. In 2D, the scene have "coarse graining parts" like two axis, data representations within the axis. It may have various other parts like a grid, a title, an info area. In 3D, the scene have in general three axis, a different global layout, some data representations within the axis area and also scene parts like title, grid, etc... To customize all these, some "style" interfaces had been introduced. In general there is one style interface per "scene part" ; then IAxisStyle, IDataStyle, ITitleStyle, IInfoStyle. Oftenly a "scene part" contains text, line, fill area, etc.... For example an "axis" have a line, ticks, text for tick labels, text for the label of the axis, the magnitude, etc... A "coarse graining scene part" style contains various accessor to "atomic" styles like IMarkerStyle, ILineStyle, IFillStyle that permits to build a "customization block" to modify a scene part. A global style "block", the IPlotterStyle, could be retreived from a plotting region. This global style block have accessors to the various "coarse graining scene parts" of the plotting scene. Through it, we hope to offer a lot of customization in a convenient way... The keywords "scene" and "part" had been borrowed from the OpenInventor terminology.
Method Summary | |
void |
applyStyle(IPlotterStyle style)
Set the style of a region and apply it to scene objects. |
String[] |
availableParameterOptions(String parameter)
|
String[] |
availableParameters()
|
void |
clear()
Clear the list of things to plot in the region. |
IInfo |
info()
Return an IInfo object describing the info area. |
IPlotterLayout |
layout()
To customize axis position,etc... |
String |
parameterValue(String parameter)
Get value of a parameter. |
void |
plot(IBaseHistogram histogram)
Add a data analysis object (histogram, function, cloud,...) |
void |
plot(IBaseHistogram histogram,
IPlotterStyle style)
|
void |
plot(IBaseHistogram histogram,
IPlotterStyle style,
String options)
|
void |
plot(IBaseHistogram histogram,
String options)
Add a data analysis object (histogram, function, cloud,...) |
void |
plot(IDataPointSet dataPointSet)
|
void |
plot(IDataPointSet dataPointSet,
IPlotterStyle style)
|
void |
plot(IDataPointSet dataPointSet,
IPlotterStyle style,
String options)
|
void |
plot(IDataPointSet dataPointSet,
String options)
|
void |
plot(IFunction function)
|
void |
plot(IFunction function,
IPlotterStyle style)
|
void |
plot(IFunction function,
IPlotterStyle style,
String options)
|
void |
plot(IFunction function,
String options)
|
void |
remove(IBaseHistogram histogram)
Remove a data analysis object in the list of things to plot in the region. |
void |
remove(IDataPointSet dataPointSet)
|
void |
remove(IFunction function)
|
void |
setLayout(IPlotterLayout layout)
|
void |
setParameter(String parameter)
Set various plotting paramters for the region. |
void |
setParameter(String parameter,
String options)
Set various plotting paramters for the region. |
void |
setStyle(IPlotterStyle style)
Set the style of a region. |
void |
setTitle(String title)
Set the title of a region. |
void |
setXLimits()
Set limit of an axis representation the region area. |
void |
setXLimits(double min)
Set limit of an axis representation the region area. |
void |
setXLimits(double min,
double max)
Set limit of an axis representation the region area. |
void |
setYLimits()
|
void |
setYLimits(double min)
|
void |
setYLimits(double min,
double max)
|
void |
setZLimits()
|
void |
setZLimits(double min)
|
void |
setZLimits(double min,
double max)
|
IPlotterStyle |
style()
Get the style of the region. |
Method Detail |
public void plot(IBaseHistogram histogram) throws IllegalArgumentException
IllegalArgumentException
public void plot(IBaseHistogram histogram, String options) throws IllegalArgumentException
IllegalArgumentException
public void plot(IBaseHistogram histogram, IPlotterStyle style) throws IllegalArgumentException
IllegalArgumentException
public void plot(IBaseHistogram histogram, IPlotterStyle style, String options) throws IllegalArgumentException
IllegalArgumentException
public void plot(IFunction function) throws IllegalArgumentException
IllegalArgumentException
public void plot(IFunction function, String options) throws IllegalArgumentException
IllegalArgumentException
public void plot(IFunction function, IPlotterStyle style) throws IllegalArgumentException
IllegalArgumentException
public void plot(IFunction function, IPlotterStyle style, String options) throws IllegalArgumentException
IllegalArgumentException
public void plot(IDataPointSet dataPointSet) throws IllegalArgumentException
IllegalArgumentException
public void plot(IDataPointSet dataPointSet, String options) throws IllegalArgumentException
IllegalArgumentException
public void plot(IDataPointSet dataPointSet, IPlotterStyle style) throws IllegalArgumentException
IllegalArgumentException
public void plot(IDataPointSet dataPointSet, IPlotterStyle style, String options) throws IllegalArgumentException
IllegalArgumentException
public void remove(IBaseHistogram histogram) throws IllegalArgumentException
IllegalArgumentException
public void remove(IFunction function) throws IllegalArgumentException
IllegalArgumentException
public void remove(IDataPointSet dataPointSet) throws IllegalArgumentException
IllegalArgumentException
public void clear()
public void setParameter(String parameter) throws IllegalArgumentException
IllegalArgumentException
public void setParameter(String parameter, String options) throws IllegalArgumentException
IllegalArgumentException
public String parameterValue(String parameter)
public String[] availableParameterOptions(String parameter)
public String[] availableParameters()
public IPlotterStyle style()
public void setStyle(IPlotterStyle style) throws IllegalArgumentException
IllegalArgumentException
public void applyStyle(IPlotterStyle style) throws IllegalArgumentException
IllegalArgumentException
public void setTitle(String title)
public void setXLimits() throws IllegalArgumentException
IllegalArgumentException
public void setXLimits(double min) throws IllegalArgumentException
IllegalArgumentException
public void setXLimits(double min, double max) throws IllegalArgumentException
IllegalArgumentException
public void setYLimits() throws IllegalArgumentException
IllegalArgumentException
public void setYLimits(double min) throws IllegalArgumentException
IllegalArgumentException
public void setYLimits(double min, double max) throws IllegalArgumentException
IllegalArgumentException
public void setZLimits() throws IllegalArgumentException
IllegalArgumentException
public void setZLimits(double min) throws IllegalArgumentException
IllegalArgumentException
public void setZLimits(double min, double max) throws IllegalArgumentException
IllegalArgumentException
public IPlotterLayout layout()
public void setLayout(IPlotterLayout layout) throws IllegalArgumentException
IllegalArgumentException
public IInfo info()
|
FreeHEP API Version 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |