Package uk.ac.starlink.ttools.plot2.task
Class PlotSpec<P,A>
java.lang.Object
uk.ac.starlink.ttools.plot2.task.PlotSpec<P,A>
Specifies a plot in sufficient detail to recreate it as a STILTS
command.
- Since:
- 17 Jul 2017
- Author:
- Mark Taylor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the external plot size supplied at construction time.Returns per-plot configuration settings.Returns the layer specification array supplied at construction time.Returns the external padding supplied at construction time.Returns the plot type supplied at construction time.Returns the aux shade axis specifications.Returns the trimming specifications.Returns the per-zone array of zone configuration settings.
-
Constructor Details
-
PlotSpec
public PlotSpec(PlotType<P, A> plotType, Dimension extSize, Padding padding, ConfigMap globalConfig, ConfigMap[] zoneConfigs, TrimmingSpec[] trimSpecs, ShadeSpec[] shadeSpecs, LayerSpec[] layerSpecs) Constructor.- Parameters:
plotType
- plot typeextSize
- total size of output graphic, or nullpadding
- padding within extSize, or nullglobalConfig
- per-plot configuration mapzoneConfigs
- per-zone configuration mapstrimSpecs
- trimming specification array, either nzone-element or 1-element for globalshadeSpecs
- aux shade axis specification array, either nzone-element or 1-element for globallayerSpecs
- specifications for each plot layer
-
-
Method Details
-
getPlotType
Returns the plot type supplied at construction time.- Returns:
- plot type
-
getExtSize
Returns the external plot size supplied at construction time.- Returns:
- total size of export graphic, or null
-
getPadding
Returns the external padding supplied at construction time.- Returns:
- padding within extSize, or null
-
getGlobalConfig
Returns per-plot configuration settings.- Returns:
- global config map
-
getZoneConfigs
Returns the per-zone array of zone configuration settings.- Returns:
- nzone-element config map array
-
getTrimmingSpecs
Returns the trimming specifications. This is either an nzone-element array for per-zone trimmings, or a 1-element array for global trimmings.- Returns:
- nz- or 1-element array of trimming specifications
-
getShadeSpecs
Returns the aux shade axis specifications. This is either an nzone-element array for per-zone aux axes, or a 1-element array for a global aux axis.- Returns:
- nz- or 1-element array of shader specifications
-
getLayerSpecs
Returns the layer specification array supplied at construction time.- Returns:
- specifications for each plot layer
-