Field Detail

• SPACING_KEY

  public static final ConfigKey<java.lang.Integer> SPACING_KEY

  Config key to control minimum pixel label spacing.

• CROWDLIMIT_KEY

  public static final ConfigKey<java.lang.Integer> CROWDLIMIT_KEY

  Config key to control max label count in spacing region.

• CAPTIONER_KEYSET

  public static final CaptionerKeySet CAPTIONER_KEYSET

  Config key set for configuring text font.

Constructor Detail

• LabelPlotter

  public LabelPlotter​()

  Constructor.

Method Detail

• getPlotterDescription

  public java.lang.String 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

  public ConfigKey[] 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 the Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap) method.

  Returns:

  keys used when creating a style for this plotter.

• createStyle

  public LabelStyle createStyle​(ConfigMap config)
                         throws ConfigException

  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 by 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).

  Parameters:

  config - map of style configuration items

  Returns:

  plotter-specific plot style

  Throws:

  ConfigException

• createLayer

  public PlotLayer createLayer​(DataGeom geom,
                               DataSpec dataSpec,
                               LabelStyle style)

  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 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.

  Parameters:

  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 true

  dataSpec - specifies the data required for the plot

  style - data style as obtained from createStyle

  Returns:

  new plot layer, or null if no drawing will take place