uk.ac.starlink.ttools.plot2.layer
Interface ShapeForm

All Superinterfaces:
ModePlotter.Form
All Known Implementing Classes:
MarkForm, MultiPointForm, PairLinkForm, SizeForm, SizeXyForm

public interface ShapeForm
extends ModePlotter.Form

Plotter Form sub-interface for use with ShapeMode. This defines the shape of data points plotted, which may be influenced by data other than the actual point position(s), for instance error bar sizes.

Since:
18 Feb 2013
Author:
Mark Taylor

Method Summary
 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.
 int getPositionCount()
          Returns the number of data positions per tuple used by this form.
 
Methods inherited from interface uk.ac.starlink.ttools.plot2.layer.ModePlotter.Form
getFormIcon, getFormName
 

Method Detail

getFormDescription

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

Returns:
XML description of form

getPositionCount

int getPositionCount()
Returns the number of data positions per tuple used by this form.

Returns:
number of sets of positional coordinates

getExtraCoords

Coord[] getExtraCoords()
Returns data coordinates additional to the basic position which are required to plot a point.

Returns:
additional plot coordinates

getConfigKeys

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

Returns:
config keys

createOutliner

Outliner createOutliner(ConfigMap config)
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 getConfigKeys().

Parameters:
config - configuration map from which values for this form's config keys will be extracted
Returns:
new outliner object


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.