|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.example.PlotGenerator<P,A>
public class PlotGenerator<P,A>
Convenience class for generating plots. This allows you to set up the basic parameters of a plot, and use the same object to construct either a JComponent for live display, or a static Icon, or to export the graphics to a file in a graphic file format.
Although this class gives quite a lot of configurability, there are some options it does not provide, for instance related to the details of autoranging plot limits based on the data. To take full advantage of these, you can go back to the lower-level API taking the implementations here as a starting point.
Constructor Summary | |
---|---|
PlotGenerator(PlotLayer[] layers,
SurfaceFactory<P,A> surfFact,
P profile,
A aspect,
Icon legend,
float[] legPos,
String title,
ShadeAxisFactory shadeFact,
Range shadeFixRange,
PaperTypeSelector ptSel,
Compositor compositor,
DataStore dataStore,
int xpix,
int ypix,
Insets dataInsets)
Constructor. |
Method Summary | |
---|---|
Icon |
createIcon(boolean forceBitmap)
Returns a static icon that can be used to paint the plot. |
PlotDisplay |
createPlotDisplay(Navigator<A> navigator,
boolean surfaceAuxRange,
boolean caching)
Returns a JComponent containing a live plot. |
void |
exportPlot(GraphicExporter exporter,
OutputStream out)
Exports a plot to an output stream in a supported graphics format. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PlotGenerator(PlotLayer[] layers, SurfaceFactory<P,A> surfFact, P profile, A aspect, Icon legend, float[] legPos, String title, ShadeAxisFactory shadeFact, Range shadeFixRange, PaperTypeSelector ptSel, Compositor compositor, DataStore dataStore, int xpix, int ypix, Insets dataInsets)
layers
- layers constituting plot contentsurfFact
- surface factoryprofile
- surface profileaspect
- initial surface aspect (may get changed by zooming etc)legend
- legend icon, or null if none requiredlegPos
- 2-element array giving x,y fractional legend placement
position within plot (elements in range 0..1),
or null for external legendtitle
- plot title, or null if not requiredshadeFact
- creates shader axis, or null if not requiredshadeFixRange
- fixed shader range,
or null for auto-range where requiredptSel
- paper type selectorcompositor
- compositor for pixel compositiondataStore
- data storage objectxpix
- initial horizontal size in pixels
(may get changed by window resizing)ypix
- initial vertical size in pixels
(may get changed by window resizing)dataInsets
- extent of region outside plot data box,
used for axis labels etc;
if null, will be calculated automaticallyMethod Detail |
---|
public PlotDisplay createPlotDisplay(Navigator<A> navigator, boolean surfaceAuxRange, boolean caching)
surfaceAuxRange
- determines whether aux ranges are recalculated
when the surface changesnavigator
- user gesture navigation controller,
or null for a non-interactive plotcaching
- if true, plot image will be cached where applicable,
if false it will be regenerated from the data
on every repaint
public void exportPlot(GraphicExporter exporter, OutputStream out) throws IOException
exporter
- defines a graphics output formatout
- destination stream;
this method buffers it, but doesn't close it
IOException
public Icon createIcon(boolean forceBitmap)
forceBitmap
- true iff the plot layers should be forced to
a pixel map grid rather than (perhaps) being drawn using
vector graphics; usually not necessary
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |