|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.layer.AbstractPlotter<LabelStyle>
uk.ac.starlink.ttools.plot2.layer.LabelPlotter
public class LabelPlotter
Plotter that writes a text label at each graphics position.
Field Summary | |
---|---|
static CaptionerKeySet |
CAPTIONER_KEYSET
Config key set for configuring text font. |
static ConfigKey<Integer> |
CROWDLIMIT_KEY
Config key to control max label count in spacing region. |
static ConfigKey<Integer> |
SPACING_KEY
Config key to control minimum pixel label spacing. |
Constructor Summary | |
---|---|
LabelPlotter()
Constructor. |
Method Summary | |
---|---|
PlotLayer |
createLayer(DataGeom geom,
DataSpec dataSpec,
LabelStyle style)
Creates a PlotLayer based on the given geometry, data and style. |
LabelStyle |
createStyle(ConfigMap config)
Creates a style that can be used when creating a plot layer. |
String |
getPlotterDescription()
Returns an XML description of this plotter. |
ConfigKey[] |
getStyleKeys()
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, hasReports |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ConfigKey<Integer> SPACING_KEY
public static final ConfigKey<Integer> CROWDLIMIT_KEY
public static final CaptionerKeySet CAPTIONER_KEYSET
Constructor Detail |
---|
public LabelPlotter()
Method Detail |
---|
public String getPlotterDescription()
Plotter
Note: really this should appear at the LayerType level.
public ConfigKey[] getStyleKeys()
Plotter
Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.
public LabelStyle createStyle(ConfigMap config) throws ConfigException
Plotter
Plotter.getStyleKeys()
.
The return value can be used as input to Plotter.createLayer(uk.ac.starlink.ttools.plot2.DataGeom, uk.ac.starlink.ttools.plot2.data.DataSpec, S)
.
config
- map of style configuration items
ConfigException
public PlotLayer createLayer(DataGeom geom, DataSpec dataSpec, LabelStyle style)
Plotter
The style
parameter is the result of a call to
Plotter.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
getCoordGroup()
.
getPositionCount
returns 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.
geom
- indicates base position coordinates and their
mapping to points in the data space;
if non-null, the data geom's
DataGeom.hasPosition()
method will return truedataSpec
- specifies the data required for the plotstyle
- data style as obtained from createStyle
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |