Package uk.ac.starlink.ttools.plot2.task
Class LayerSpec
java.lang.Object
uk.ac.starlink.ttools.plot2.task.LayerSpec
Specifies a plot layer in sufficient detail to recreate it as
part of a STILTS plotting command.
- Since:
- 17 Jul 2017
- Author:
- Mark Taylor
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns this layer's configuration options.Coordinate specifications used by this layer.Returns the data geom used by this layer.Returns the legend label associated with this layer.Plotter
<?> Returns this layer's plotter.Returns an expression that indicates row inclusion for the table.uk.ac.starlink.table.StarTable
getTable()
Returns the table supplying this layer's data.int
Returns the index of the zone in which this layer is placed.
-
Constructor Details
-
LayerSpec
Constructs a layer specification for a layer with no table data.- Parameters:
plotter
- plotterconfig
- per-layer configuration; superset is permittedleglabel
- legend label, or null to exclude from legendizone
- zone index
-
LayerSpec
public LayerSpec(Plotter<?> plotter, ConfigMap config, String leglabel, int izone, uk.ac.starlink.table.StarTable table, CoordSpec[] coordSpecs, DataGeom dataGeom, CredibleString selectExpr) Constructor.- Parameters:
plotter
- plotterconfig
- per-layer configuration; superset is permittedleglabel
- legend label, or null to exclude from legendizone
- zone indextable
- table supplying data points; where a string representation of the table is required, itsgetName
method will generally be usedcoordSpecs
- list of coordinate specificationsdataGeom
- data geomselectExpr
- boolean expression evaluated in the context of the supplied table; if non-null, only true rows are included
-
-
Method Details
-
getPlotter
Returns this layer's plotter.- Returns:
- plotter
-
getConfig
Returns this layer's configuration options.- Returns:
- config
-
getLegendLabel
Returns the legend label associated with this layer. If the return value is null, then this layer should not be represented in a legend, even if the legend is displayed.- Returns:
- legend label
-
getZoneIndex
public int getZoneIndex()Returns the index of the zone in which this layer is placed.- Returns:
- zone index
-
getTable
public uk.ac.starlink.table.StarTable getTable()Returns the table supplying this layer's data.- Returns:
- table, may be null
-
getCoordSpecs
Coordinate specifications used by this layer.- Returns:
- coordinate specification list, not null
-
getDataGeom
Returns the data geom used by this layer.- Returns:
- data geom
-
getSelectExpr
Returns an expression that indicates row inclusion for the table. This is an expression to be evaluated in the context of the supplied data table. If null, all rows are considered to be included.- Returns:
- row selection expression
-