uk.ac.starlink.topcat.plot2

Class TopcatLayer

java.lang.Object

uk.ac.starlink.topcat.plot2.TopcatLayer

public class TopcatLayer
extends Object

Aggregates information about gang of PlotLayers and some additional information about how it was configured. The plot layer array has one entry per plot zone, but some entries may be null.

The resulting object is able to come up with a suitable LayerSpec.

Since:

14 Jul 2017

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
TopcatLayer(uk.ac.starlink.ttools.plot2.PlotLayer[] plotLayers, uk.ac.starlink.ttools.plot2.config.ConfigMap config, String leglabel) Constructs a layer with no table data.
TopcatLayer(uk.ac.starlink.ttools.plot2.PlotLayer[] plotLayers, uk.ac.starlink.ttools.plot2.config.ConfigMap config, String leglabel, TopcatModel tcModel, GuiCoordContent[] contents, RowSubset rset) Constructs a layer based on a table.

Method Summary

Modifier and Type	Method and Description
uk.ac.starlink.ttools.plot2.DataGeom	getDataGeom() Returns the DataGeom used by this layer.
uk.ac.starlink.ttools.plot2.task.LayerSpec	getLayerSpec() Returns a layer specification for this layer placed within a given zone.
uk.ac.starlink.ttools.plot2.PlotLayer[]	getPlotLayers() Returns the plot layers stored by this object.
uk.ac.starlink.ttools.plot2.Plotter<?>	getPlotter() Returns the plotter used by this layer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TopcatLayer

public TopcatLayer(uk.ac.starlink.ttools.plot2.PlotLayer[] plotLayers,
                   uk.ac.starlink.ttools.plot2.config.ConfigMap config,
                   String leglabel,
                   TopcatModel tcModel,
                   GuiCoordContent[] contents,
                   RowSubset rset)

Constructs a layer based on a table.

Parameters:

plotLayers - per-zone array of plot layers, at least one non-null member

config - configuration used to set up the plot layers (superset is permitted)

leglabel - label used in the legend; if null, excluded from the legend

tcModel - TopcatModel containing the table

contents - information about data columns used to construct plot (superset is not permitted)

rset - row subset for which layer is plotted

TopcatLayer

public TopcatLayer(uk.ac.starlink.ttools.plot2.PlotLayer[] plotLayers,
                   uk.ac.starlink.ttools.plot2.config.ConfigMap config,
                   String leglabel)

Constructs a layer with no table data.

Parameters:

plotLayers - per-zone array of plot layers, at least one non-null member

config - configuration used to set up the plot layer (superset is permitted)

leglabel - label used in the legend; if null, excluded from the legend

Method Detail

getPlotter

public uk.ac.starlink.ttools.plot2.Plotter<?> getPlotter()

Returns the plotter used by this layer.

Returns:

plotter

getDataGeom

public uk.ac.starlink.ttools.plot2.DataGeom getDataGeom()

Returns the DataGeom used by this layer.

Returns:

dataGeom, may be null

getPlotLayers

public uk.ac.starlink.ttools.plot2.PlotLayer[] getPlotLayers()

Returns the plot layers stored by this object.

Returns:

per-zone array of plot layers, at least one non-null member

getLayerSpec

public uk.ac.starlink.ttools.plot2.task.LayerSpec getLayerSpec()

Returns a layer specification for this layer placed within a given zone.

It shouldn't be null, unless it was impossible to write the specification for some reason??

Returns:

layer specification, hopefully not null??