Class LabelPlotter
- All Implemented Interfaces:
Plotter<LabelStyle>
- Since:
- 15 Feb 2013
- Author:
- Mark Taylor
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final LabelPlotter
Instance of this class for use with Plane geometry Area positions.static final LabelPlotter
Instance of this class for use with Sky geometry Area positions.static final LabelPlotter
Instance of this class for use with Sphere geometry Area positions.static final CaptionerKeySet
Config key set for configuring text font.Config key to control max label count in spacing region.static final LabelPlotter
Instance of this class for use with point positions.Config key to control minimum pixel label spacing.Config key to control X pixel offset.Config key to control Y pixel offset. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
LabelPlotter
(CoordGroup cgrp, boolean isArea) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract DataGeom
adjustGeom
(DataGeom baseGeom) Provides a DataGeom to be used by the layer this form makes, given a DataGeom that characterises the plotting environment.createLayer
(DataGeom geom0, DataSpec dataSpec, LabelStyle 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
-
XOFF_KEY
Config key to control X pixel offset. -
YOFF_KEY
Config key to control Y pixel offset. -
SPACING_KEY
Config key to control minimum pixel label spacing. -
CROWDLIMIT_KEY
Config key to control max label count in spacing region. -
CAPTIONER_KEYSET
Config key set for configuring text font. -
POINT_INSTANCE
Instance of this class for use with point positions. -
AREA_PLANE_INSTANCE
Instance of this class for use with Plane geometry Area positions. -
AREA_SKY_INSTANCE
Instance of this class for use with Sky geometry Area positions. -
AREA_SPHERE_INSTANCE
Instance of this class for use with Sphere geometry Area positions.
-
-
Constructor Details
-
LabelPlotter
Constructor.- Parameters:
cgrp
- coord groupisArea
- true for area coordinates, false for point coords
-
-
Method Details
-
adjustGeom
Provides a DataGeom to be used by the layer this form makes, given a DataGeom that characterises the plotting environment. The output should be similar to the input, for instance implementing the same plotType-specific DataGeom subtype.In most cases the supplied instance can be returned unchanged, but instances with special requirements may want to adjust how the data is interpreted.
- Parameters:
baseGeom
- context geom- Returns:
- geom to use for data interpretation, the same or similar to the input
-
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
- Throws:
ConfigException
-
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:
geom0
- 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
-