com.metsci.glimpse.plot
Interface StackedPlot2D.PlotInfo

All Known Implementing Classes:
StackedPlot2D.PlotInfoImpl, TimePlotInfo
Enclosing class:
StackedPlot2D

public static interface StackedPlot2D.PlotInfo


Method Summary
 void addLayout(GlimpseAxisLayout2D childLayout)
          Adds the childLayout to the part of the StackedPlot2D represented by this LayoutInfo.
 Axis1D getCommonAxis()
          Returns the common axis shared by all the plots in a StackedPlot2D.
 Axis1D getCommonAxis(GlimpseTargetStack stack)
          Returns the common axis associated with the given GlimpseTargetStack.
 java.lang.String getId()
          Gets the unique identifier assigned to this plot.
 GlimpseAxisLayout2D getLayout()
          Returns the GlimpseLayout for this plot.
 int getOrder()
           
 Axis1D getOrthogonalAxis()
          Returns the data axis associated with this plot.
 Axis1D getOrthogonalAxis(GlimpseTargetStack stack)
          Returns the data axis associated with the given GlimpseTargetStack.
 int getSize()
           
 StackedPlot2D getStackedPlot()
          Gets a reference to the parent StackedPlot2D which this PlotInfo belongs to.
 void setOrder(int order)
          Sets the ordering of this plot relative to the other plots in the StackedPlot2D.
 void setSize(int size)
          Sets the size in pixels for this plot.
 

Method Detail

getStackedPlot

StackedPlot2D getStackedPlot()
Gets a reference to the parent StackedPlot2D which this PlotInfo belongs to.

Returns:
the parent StackedPlot2D

getId

java.lang.String getId()
Gets the unique identifier assigned to this plot. This identifier can be used to retrieve this plot handle from the StackedPlot2D.

Returns:
the plot unique identifier

getOrder

int getOrder()
Returns:
the ordering value for this plot

getSize

int getSize()
Returns:
the pixel size of this plot

setOrder

void setOrder(int order)
Sets the ordering of this plot relative to the other plots in the StackedPlot2D. The particular value does not matter, only the values relative to other plots. All plots start with order 0. Plots with the same order value are arranged in the order they were added to the StackedPlot2D.

Parameters:
order - the ordering value for this plot

setSize

void setSize(int size)
Sets the size in pixels for this plot. If size < 0, then the plot will attempt to fill all available space, sharing space evenly with other plots with negative size.

For a VERTICAL oriented plot, setSize( ) adjusts the plot height, for a HORIZONTAL oriented plot, the width is adjusted.

Parameters:
size - the size of the plot in pixels.

getLayout

GlimpseAxisLayout2D getLayout()
Returns the GlimpseLayout for this plot. This can be used to add subplots of painters to the plotting area.


getCommonAxis

Axis1D getCommonAxis(GlimpseTargetStack stack)
Returns the common axis associated with the given GlimpseTargetStack. Users generally should simply call getCommonAxis().


getOrthogonalAxis

Axis1D getOrthogonalAxis(GlimpseTargetStack stack)
Returns the data axis associated with the given GlimpseTargetStack. Users generally should simply call getOrthogonalAxis().


getCommonAxis

Axis1D getCommonAxis()
Returns the common axis shared by all the plots in a StackedPlot2D.

Returns:
the shared axis for this plot

getOrthogonalAxis

Axis1D getOrthogonalAxis()
Returns the data axis associated with this plot. The data axes for each GlimpseLayout in a StackedPlot2D are unlinked by default, but they can be linked if desired using Axis1D.setParent( Axis1D ).

Returns:
the data axis for this plot

addLayout

void addLayout(GlimpseAxisLayout2D childLayout)
Adds the childLayout to the part of the StackedPlot2D represented by this LayoutInfo. Also links the common axis of the child to the common axis of the parent layout.

Parameters:
childLayout -


Copyright © 2012 Metron, Inc.. All Rights Reserved.