Class SkyGridPlotter
java.lang.Object
uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<SkyGridPlotter.GridStyle>
uk.ac.starlink.ttools.plot2.layer.SkyGridPlotter
- All Implemented Interfaces:
Plotter<SkyGridPlotter.GridStyle>
Plotter that can draw a sky axis grid on a sky surface.
This can be for a different sky system than that defined by
the sky surface itself.
- Since:
- 10 Apr 2017
- Author:
- Mark Taylor
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Style for configuring the grid plot. -
Field Summary
FieldsModifier and TypeFieldDescriptionConfig key for grid line colour.Config key for grid sky system.static final ConfigKey
<SkyAxisLabeller> Config key for grid label positioning.Config key for latitude grid line crowding.Config key for longitude grid line crowding.Config key for grid line transparency. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateLayer
(DataGeom geom, DataSpec dataSpec, SkyGridPlotter.GridStyle style) Creates a PlotLayer based on the given geometry, data and style.createStyle
(ConfigMap config) Creates a style that can be used when creating a plot layer.Returns an XML description of this plotter.ConfigKey<?>[]
Returns the configuration keys used to configure style for this plotter.Methods inherited from class uk.ac.starlink.ttools.plot2.layer.AbstractPlotter
getCoordGroup, getPlotterIcon, getPlotterName, getRangeStyleKey, hasReports
-
Field Details
-
COLOR_KEY
Config key for grid line colour. -
TRANSPARENCY_KEY
Config key for grid line transparency. -
LONCROWD_KEY
Config key for longitude grid line crowding. -
LATCROWD_KEY
Config key for latitude grid line crowding. -
GRIDSYS_KEY
Config key for grid sky system. -
LABELLER_KEY
Config key for grid label positioning.
-
-
Constructor Details
-
SkyGridPlotter
public SkyGridPlotter()Constructor.
-
-
Method Details
-
getPlotterDescription
Description copied from interface:Plotter
Returns an XML description of this plotter.Note: really this should appear at the LayerType level.
- Returns:
- one or more <p> elements
-
getStyleKeys
Description copied from interface:Plotter
Returns the configuration keys used to configure style for this plotter. The keys in the return value are used in the map supplied to thePlotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.- Returns:
- keys used when creating a style for this plotter.
-
createStyle
Description copied from interface:Plotter
Creates a style that can be used when creating a plot layer. The keys that are significant in the supplied config map are those returned byPlotter.getStyleKeys()
. The return value can be used as input toPlotter.createLayer(uk.ac.starlink.ttools.plot2.DataGeom, uk.ac.starlink.ttools.plot2.data.DataSpec, S)
.- Parameters:
config
- map of style configuration items- Returns:
- plotter-specific plot style
-
createLayer
Description copied from interface:Plotter
Creates a PlotLayer based on the given geometry, data and style.The
style
parameter is the result of a call toPlotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
.The
dataSpec
parameter must contain the coordinates defined by this plotter's CoordGroup.The
pointDataGeom
parameter is only used if theCoordGroup.getBasicPositionCount()
orCoordGroup.getExtraPositionCount()
method from this plotter's CoordGroup return a non-zero value, otherwise the plot does not have point positions.It is legal to supply null for any of the parameters; if insufficient data is supplied to generate a plot, then the method should return null.
Creating a layer should be cheap; layers may be created and not used.
- Parameters:
geom
- indicates base position coordinates and their mapping to points in the data spacedataSpec
- specifies the data required for the plotstyle
- data style as obtained fromcreateStyle
- Returns:
- new plot layer, or null if no drawing will take place
-