Package uk.ac.starlink.ttools.plot2.task
Class ZoneSpec
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.task.ZoneSpec
-
public class ZoneSpec extends java.lang.Object
Specifies a plot zone in sufficient detail to recreate it as part of a STILTS plotting command.- Since:
- 20 Jul 2017
- Author:
- Mark Taylor
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ZoneSpec.LegendSpec
Specification for legend display options.static class
ZoneSpec.RampSpec
Specification for colour ramp display options.
-
Constructor Summary
Constructors Constructor Description ZoneSpec(ConfigMap config, boolean hasAux, java.lang.String title, ZoneSpec.LegendSpec legSpec, ZoneSpec.RampSpec auxSpec)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ZoneSpec.RampSpec
getAuxSpec()
Returns an object characterising the aux axis colour ramp display options for this zone.ConfigMap
getConfig()
Returns per-zone configuration options for this zone.boolean
getHasAux()
Indicates whether this zone (any of the layers in it) is going to use a global colour ramp.ZoneSpec.LegendSpec
getLegendSpec()
Returns an object characterising the legend display options for this zone.java.lang.String
getTitle()
Returns a title for this zone.
-
-
-
Constructor Detail
-
ZoneSpec
public ZoneSpec(ConfigMap config, boolean hasAux, java.lang.String title, ZoneSpec.LegendSpec legSpec, ZoneSpec.RampSpec auxSpec)
Constructor.- Parameters:
config
- per-zone configuration optionshasAux
- true iff this zone is going to use a global colour ramptitle
- per-zone plot title string, may be nulllegSpec
- legend specification, or null for no legendauxSpec
- aux axis colour ramp specification, or null for no ramp
-
-
Method Detail
-
getConfig
public ConfigMap getConfig()
Returns per-zone configuration options for this zone.- Returns:
- zone config map
-
getHasAux
public boolean getHasAux()
Indicates whether this zone (any of the layers in it) is going to use a global colour ramp.- Returns:
- true iff aux shading is used
-
getTitle
public java.lang.String getTitle()
Returns a title for this zone.- Returns:
- zone title or null
-
getLegendSpec
public ZoneSpec.LegendSpec getLegendSpec()
Returns an object characterising the legend display options for this zone.- Returns:
- legend specification, or null for no legend
-
getAuxSpec
public ZoneSpec.RampSpec getAuxSpec()
Returns an object characterising the aux axis colour ramp display options for this zone.- Returns:
- aux ramp specification, or null for no visible ramp
-
-