IVizCanvas

All Known Subinterfaces:

IMeshVizCanvas, IPlot

All Known Implementing Classes:

AbstractPlot, ConnectionPlot, CSVPlot, CSVProxyPlot, FakePlot, FXGeometryCanvas, FXMeshCanvas, FXVizCanvas, ParaViewPlot, ProxyPlot, VisItPlot
```
public interface IVizCanvas
```
This interface defines the principle type for canvases created and handled by the platform. Its primary purpose is to provide a specific interface for manipulating canvases and analysis data that is separated in purpose and scope from the IVizService (perhaps completely separate, in fact).
When implemented in tandem with an IVizService, the class that realizes this interface should encapsulate all details related to the internal workings of the IVizService and refrain from exposing them to the client. For example, service ids, credentials, window ids and other information should be stored as private variables and not exposed in the properties map unless absolutely necessary.

A proper implementation of IVizCanvas is one that can be used in standalone tools, workbench-based tools, and embedded in composites in larger, existing tools. Implementations should not be restricted to one usage scenario.

Author:

Jay Jay Billings, Alex McCaskey, Kasper Gammeltoft, Robert Smith

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.eclipse.swt.widgets.Composite`	`draw(org.eclipse.swt.widgets.Composite parent)` This operation draws the canvas contents onto the given parent Composite.
`java.net.URI`	`getDataSource()` This operation returns the data source that is plotted/drawn by this IPlot.
`int`	`getNumberOfAxes()` This operation returns the number of axes of the plot.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` This operation returns properties of this IPlot that can be safely modified and/or tuned by the client.
`IRenderElementHolder`	`getRenderElementHolder(Geometry geometry)` Get the list of render elements used to display the given geometry in this canvas.
`java.lang.String`	`getSourceHost()` This operation retrieves the hostname for this IPlot's data source.
`boolean`	`isSourceRemote()` This operation signifies whether or not the IPlot's host is local or remote.
`void`	`redraw()` This operation directs the IPlot to redraw its contents.
`void`	`setProperties(java.util.Map<java.lang.String,java.lang.String> props)` This operation updates the properties of the plot based on client-side modifications.

- Method Detail
  - draw
```
org.eclipse.swt.widgets.Composite draw(org.eclipse.swt.widgets.Composite parent)
                                throws java.lang.Exception
```
    This operation draws the canvas contents onto the given parent Composite. The exact details of how the plot is drawn and what is drawn inside the parent composite are left completely up to the implementation.
    
    Parameters:
    
    parent -
    
    Throws:
    
    java.lang.Exception
  - getDataSource
```
java.net.URI getDataSource()
```
    This operation returns the data source that is plotted/drawn by this IPlot.
    
    Returns:
    
    The data source
  - getNumberOfAxes
```
int getNumberOfAxes()
```
    This operation returns the number of axes of the plot.
    
    Returns:
    
    The number of axes or zero if the plot has not been drawn
  - getProperties
```
java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    This operation returns properties of this IPlot that can be safely modified and/or tuned by the client. These properties should contains things such as, for example, the axis labels, the title, the subtitle, etc.
    
    Returns:
    
    A map of the properties.
  - getRenderElementHolder
```
IRenderElementHolder getRenderElementHolder(Geometry geometry)
```
    Get the list of render elements used to display the given geometry in this canvas.
    
    Parameters:
    
    geometry - The geometry whose corresponding IRenderElements are sought.
    
    Returns:
    
    An array list of each of the top level IRenderElements in the hierarchy, corresponding to the geometry's nodes list from getNodes()
  - getSourceHost
```
java.lang.String getSourceHost()
```
    This operation retrieves the hostname for this IPlot's data source.
    
    Returns:
    
    the hostname
  - isSourceRemote
```
boolean isSourceRemote()
```
    This operation signifies whether or not the IPlot's host is local or remote.
    
    Returns:
    
    True if the source is on a remote machine, false otherwise
  - redraw
```
void redraw()
```
    This operation directs the IPlot to redraw its contents. This can be invoked when, for example, the data represented by this IPlot changes, and a change in the IPlot's UI must change accordingly. The exact details of how this IPlot is redrawn after a valid draw is left completely to the implementation.
  - setProperties
```
void setProperties(java.util.Map<java.lang.String,java.lang.String> props)
            throws java.lang.Exception
```
    This operation updates the properties of the plot based on client-side modifications. The IPlot should redraw itself as needed if the properties changed.
    
    Parameters:
    
    props - The updated properties
    
    Throws:
    
    java.lang.Exception - This exception indicates that the IPlot could not update its properties or redraw itself.

Interface IVizCanvas

Method Summary

Method Detail

draw

getDataSource

getNumberOfAxes

getProperties

getRenderElementHolder

getSourceHost

isSourceRemote

redraw

setProperties