IPlotterRegion

Documentation of 'hep.aida.IPlotterRegion' Java class IPlotterRegion

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

PlotterRegion
```
public interface IPlotterRegion
```
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. 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`applyStyle(IPlotterStyle style)` Set the style of a region and apply it to scene objects.
`java.lang.String[]`	`availableParameterOptions(java.lang.String parameter)` Get available options for a parameter.
`java.lang.String[]`	`availableParameters()` Get avaliable parameters.
`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...
`java.lang.String`	`parameterValue(java.lang.String parameter)` Get value of a parameter.
`void`	`plot(IBaseHistogram histogram)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IBaseHistogram histogram, IPlotterStyle style)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IBaseHistogram histogram, IPlotterStyle style, java.lang.String options)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IBaseHistogram histogram, java.lang.String options)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IDataPointSet dataPointSet)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IDataPointSet dataPointSet, IPlotterStyle style)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IDataPointSet dataPointSet, IPlotterStyle style, java.lang.String options)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IDataPointSet dataPointSet, java.lang.String options)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IFunction function)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IFunction function, IPlotterStyle style)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IFunction function, IPlotterStyle style, java.lang.String options)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IFunction function, java.lang.String options)` Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region.
`void`	`plot(IPlottable plottable)` Send a generic plottable object to the plotting region.
`void`	`plot(IPlottable plottable, IPlotterStyle style)` Send a generic plottable object to the plotting region.
`void`	`plot(IPlottable plottable, IPlotterStyle style, java.lang.String options)` Send a generic plottable object to the plotting region.
`void`	`plot(IPlottable plottable, java.lang.String options)` Send a generic plottable object to the plotting region.
`void`	`refresh()` Refresh the plotter region graphic.
`void`	`remove(IBaseHistogram histogram)` Remove a data analysis object in the list of things to plot in the region.
`void`	`remove(IDataPointSet dataPointSet)` Remove a data analysis object in the list of things to plot in the region.
`void`	`remove(IFunction function)` Remove a data analysis object in the list of things to plot in the region.
`void`	`remove(IPlottable plottable)` Generic entry point to remove some plotted scene part.
`void`	`setLayout(IPlotterLayout layout)` To customize axis position,etc...
`void`	`setParameter(java.lang.String parameter)` Set various plotting paramters for the region.
`void`	`setParameter(java.lang.String parameter, java.lang.String options)` Set various plotting paramters for the region.
`void`	`setStyle(IPlotterStyle style)` Set the style of a region.
`void`	`setTitle(java.lang.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()` Set limit of an axis representation the region area.
`void`	`setYLimits(double min)` Set limit of an axis representation the region area.
`void`	`setYLimits(double min, double max)` Set limit of an axis representation the region area.
`void`	`setZLimits()` Set limit of an axis representation the region area.
`void`	`setZLimits(double min)` Set limit of an axis representation the region area.
`void`	`setZLimits(double min, double max)` Set limit of an axis representation the region area.
`IPlotterStyle`	`style()` Get the style of the region.
`java.lang.String`	`title()` Get the title of the region.
`double`	`xLimitMax()` Get the max limit of x.
`double`	`xLimitMin()` Get the min limit of x.
`double`	`yLimitMax()` Get the max limit of y.
`double`	`yLimitMin()` Get the min limit of y.
`double`	`zLimitMax()` Get the max limit of z.
`double`	`zLimitMin()` Get the min limit of z.

- Method Detail
  - plot
```
void plot(IBaseHistogram histogram)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IBaseHistogram histogram,
          java.lang.String options)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IBaseHistogram histogram,
          IPlotterStyle style)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IBaseHistogram histogram,
          IPlotterStyle style,
          java.lang.String options)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IFunction function)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IFunction function,
          java.lang.String options)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IFunction function,
          IPlotterStyle style)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IFunction function,
          IPlotterStyle style,
          java.lang.String options)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IDataPointSet dataPointSet)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IDataPointSet dataPointSet,
          java.lang.String options)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IDataPointSet dataPointSet,
          IPlotterStyle style)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IDataPointSet dataPointSet,
          IPlotterStyle style,
          java.lang.String options)
   throws java.lang.IllegalArgumentException
```
    Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IPlottable plottable)
   throws java.lang.IllegalArgumentException
```
    Send a generic plottable object to the plotting region. See IPlottable for more.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IPlottable plottable,
          java.lang.String options)
   throws java.lang.IllegalArgumentException
```
    Send a generic plottable object to the plotting region. See IPlottable for more.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IPlottable plottable,
          IPlotterStyle style)
   throws java.lang.IllegalArgumentException
```
    Send a generic plottable object to the plotting region. See IPlottable for more.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - plot
```
void plot(IPlottable plottable,
          IPlotterStyle style,
          java.lang.String options)
   throws java.lang.IllegalArgumentException
```
    Send a generic plottable object to the plotting region. See IPlottable for more.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - remove
```
void remove(IBaseHistogram histogram)
     throws java.lang.IllegalArgumentException
```
    Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - remove
```
void remove(IFunction function)
     throws java.lang.IllegalArgumentException
```
    Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - remove
```
void remove(IDataPointSet dataPointSet)
     throws java.lang.IllegalArgumentException
```
    Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - remove
```
void remove(IPlottable plottable)
     throws java.lang.IllegalArgumentException
```
    Generic entry point to remove some plotted scene part.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - clear
```
void clear()
```
    Clear the list of things to plot in the region. Clear the corresponding area on screen window(s).
  - refresh
```
void refresh()
      throws java.lang.RuntimeException
```
    Refresh the plotter region graphic. Can be used when a plotted data analysis object received new data.
    
    Throws:
    
    java.lang.RuntimeException
  - setParameter
```
void setParameter(java.lang.String parameter)
           throws java.lang.IllegalArgumentException
```
    Set various plotting paramters for the region. Activate the graphic layer and update the screen window(s) if needed.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setParameter
```
void setParameter(java.lang.String parameter,
                  java.lang.String options)
           throws java.lang.IllegalArgumentException
```
    Set various plotting paramters for the region. Activate the graphic layer and update the screen window(s) if needed.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - parameterValue
```
java.lang.String parameterValue(java.lang.String parameter)
```
    Get value of a parameter.
    
    Parameters:
    
    parameter - Name of the parameter.
    
    Returns:
    
    the value.
  - availableParameterOptions
```
java.lang.String[] availableParameterOptions(java.lang.String parameter)
```
    Get available options for a parameter.
    
    Parameters:
    
    parameter - Name of the parameter.
    
    Returns:
    
    options
  - availableParameters
```
java.lang.String[] availableParameters()
```
    Get avaliable parameters.
    
    Returns:
    
    parameters
  - style
```
IPlotterStyle style()
```
    Get the style of the region.
  - setStyle
```
void setStyle(IPlotterStyle style)
       throws java.lang.IllegalArgumentException
```
    Set the style of a region.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - applyStyle
```
void applyStyle(IPlotterStyle style)
         throws java.lang.IllegalArgumentException
```
    Set the style of a region and apply it to scene objects.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setTitle
```
void setTitle(java.lang.String title)
```
    Set the title of a region.
  - title
```
java.lang.String title()
```
    Get the title of the region.
  - setXLimits
```
void setXLimits()
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setXLimits
```
void setXLimits(double min)
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setXLimits
```
void setXLimits(double min,
                double max)
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setYLimits
```
void setYLimits()
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setYLimits
```
void setYLimits(double min)
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setYLimits
```
void setYLimits(double min,
                double max)
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setZLimits
```
void setZLimits()
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setZLimits
```
void setZLimits(double min)
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setZLimits
```
void setZLimits(double min,
                double max)
         throws java.lang.IllegalArgumentException
```
    Set limit of an axis representation the region area.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - xLimitMin
```
double xLimitMin()
```
    Get the min limit of x.
  - xLimitMax
```
double xLimitMax()
```
    Get the max limit of x.
  - yLimitMin
```
double yLimitMin()
```
    Get the min limit of y.
  - yLimitMax
```
double yLimitMax()
```
    Get the max limit of y.
  - zLimitMin
```
double zLimitMin()
```
    Get the min limit of z.
  - zLimitMax
```
double zLimitMax()
```
    Get the max limit of z.
  - layout
```
IPlotterLayout layout()
```
    To customize axis position,etc... Change object position in the scence.
  - setLayout
```
void setLayout(IPlotterLayout layout)
        throws java.lang.IllegalArgumentException
```
    To customize axis position,etc... Change object position in the scence.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - info
```
IInfo info()
```
    Return an IInfo object describing the info area.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Interface IPlotterRegion

Method Summary

Method Detail

plot

plot

plot

plot

plot

plot

plot

plot

plot

plot

plot

plot

plot

plot

plot

plot

remove

remove

remove

remove

clear

refresh

setParameter

setParameter

parameterValue

availableParameterOptions

availableParameters

style

setStyle

applyStyle

setTitle

title

setXLimits

setXLimits

setXLimits

setYLimits

setYLimits

setYLimits

setZLimits

setZLimits

setZLimits

xLimitMin

xLimitMax

yLimitMin

yLimitMax

zLimitMin

zLimitMax

layout

setLayout

info