uk.ac.starlink.ttools.plot2.layer

Class LineCombineArrayPlotter

java.lang.Object

uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<S>

uk.ac.starlink.ttools.plot2.layer.CombineArrayPlotter<LineCombineArrayPlotter.LineCombineArrayStyle>

uk.ac.starlink.ttools.plot2.layer.LineCombineArrayPlotter

All Implemented Interfaces:

Plotter<LineCombineArrayPlotter.LineCombineArrayStyle>

public class LineCombineArrayPlotter
extends CombineArrayPlotter<LineCombineArrayPlotter.LineCombineArrayStyle>

CombineArrayPlotter that plots a line between aggregated positions.

Since:

25 Jan 2022

Author:

Mark Taylor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineCombineArrayPlotter.LineCombineArrayStyle Style for use with this plotter.

Nested classes/interfaces inherited from class uk.ac.starlink.ttools.plot2.layer.CombineArrayPlotter

CombineArrayPlotter.CombineArrayStyle

Field Summary

Fields

Modifier and Type	Field and Description
static LineCombineArrayPlotter	INSTANCE Sole instance of this class.
static ConfigKey<Integer>	THICK_KEY Config key for line thickness.

Fields inherited from class uk.ac.starlink.ttools.plot2.layer.CombineArrayPlotter

XCOMBINER_KEY, XS_REPKEY, YCOMBINER_KEY, YS_REPKEY

Method Summary

Modifier and Type	Method and Description
LineCombineArrayPlotter.LineCombineArrayStyle	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.CombineArrayPlotter

createLayer, getRangeStyleKey

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

INSTANCE

public static final LineCombineArrayPlotter INSTANCE

Sole instance of this class.

THICK_KEY

public static ConfigKey<Integer> THICK_KEY

Config key for line thickness.

Method Detail

getPlotterDescription

public 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 LineCombineArrayPlotter.LineCombineArrayStyle createStyle(ConfigMap config)

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