uk.ac.starlink.ttools.plot2.layer

Class MarkArrayForm

java.lang.Object

uk.ac.starlink.ttools.plot2.layer.MarkArrayForm

All Implemented Interfaces:

ModePlotter.Form, ShapeForm

public class MarkArrayForm
extends Object
implements ShapeForm

Form for drawing an array of markers per row, given array-valued X and Y coordinates. Currently only supports X-Y plotting.

Singleton class.

Since:

27 Jan 2021

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<Integer>	SIZE_KEY Config key for marker size.

Method Summary

Modifier and Type	Method and Description
DataGeom	adjustGeom(DataGeom geom) Provides a DataGeom to be used by the layer this form makes, given a DataGeom that characterises the plotting environment.
Outliner	createOutliner(ConfigMap config) Returns an object which will do the work of drawing shapes when supplied with the appropriate style information and data.
ConfigKey<?>[]	getConfigKeys() Returns style configuration keys specific to this form.
Coord[]	getExtraCoords() Returns data coordinates additional to the basic position which are required to plot a point.
String	getFormDescription() Returns a description of this mode as an XML string.
Icon	getFormIcon() Returns an icon to identify this form in the GUI.
String	getFormName() Returns the user-directed name for this form.
static MarkArrayForm	getInstance() Returns the sole instance of this singleton class.
int	getPositionCount() Returns the number of data positions per tuple used by this form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SIZE_KEY

public static final ConfigKey<Integer> SIZE_KEY

Config key for marker size.

Method Detail

getPositionCount

public int getPositionCount()

Description copied from interface: ShapeForm

Returns the number of data positions per tuple used by this form.

Specified by:

getPositionCount in interface ShapeForm

Returns:

number of sets of positional coordinates

getFormName

public String getFormName()

Description copied from interface: ModePlotter.Form

Returns the user-directed name for this form.

Specified by:

getFormName in interface ModePlotter.Form

Returns:

form name

getFormDescription

public String getFormDescription()

Description copied from interface: ShapeForm

Returns a description of this mode as an XML string. The return value should be one or more <p> elements.

Specified by:

getFormDescription in interface ShapeForm

Returns:

XML description of form

getFormIcon

public Icon getFormIcon()

Description copied from interface: ModePlotter.Form

Returns an icon to identify this form in the GUI.

Specified by:

getFormIcon in interface ModePlotter.Form

Returns:

form icon

getExtraCoords

public Coord[] getExtraCoords()

Description copied from interface: ShapeForm

Returns data coordinates additional to the basic position which are required to plot a point.

Specified by:

getExtraCoords in interface ShapeForm

Returns:

additional plot coordinates

adjustGeom

public DataGeom adjustGeom(DataGeom geom)

Description copied from interface: ShapeForm

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.

Specified by:

adjustGeom in interface ShapeForm

Parameters:

geom - context geom

Returns:

geom to use for data interpretation, the same or similar to the input

getConfigKeys

public ConfigKey<?>[] getConfigKeys()

Description copied from interface: ShapeForm

Returns style configuration keys specific to this form. These keys will be used in the config map supplied to ShapeForm.createOutliner(uk.ac.starlink.ttools.plot2.config.ConfigMap).

Specified by:

getConfigKeys in interface ShapeForm

Returns:

config keys

createOutliner

public Outliner createOutliner(ConfigMap config)

Description copied from interface: ShapeForm

Returns an object which will do the work of drawing shapes when supplied with the appropriate style information and data. The significant keys in the supplied config map are those given by ShapeForm.getConfigKeys().

Specified by:

createOutliner in interface ShapeForm

Parameters:

config - configuration map from which values for this form's config keys will be extracted

Returns:

new outliner object

getInstance

public static MarkArrayForm getInstance()

Returns the sole instance of this singleton class.

Returns:

instance