public class MultiPointForm extends java.lang.Object implements ShapeForm
extra
coordinates.
The extra coordinates required (defining one or more non-central
data positions) are defined by a supplied MultiPointCoordSet
and those coordinates are then plotted by a corresponding
ErrorRenderer
.
ErrorRenderer may be a slightly misleading name in this context, but you
can think of any of these multi-point shapes as a generalisation of
error bars.Constructor and Description |
---|
MultiPointForm(java.lang.String name,
javax.swing.Icon icon,
java.lang.String description,
MultiPointCoordSet extraCoordSet,
boolean canScale,
MultiPointConfigKey rendererKey)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static MultiPointForm |
createEllipseForm(java.lang.String name,
MultiPointCoordSet extraCoordSet,
boolean canScale)
Returns a MultiPointForm instance for drawing ellipses around the
central position.
|
static MultiPointForm |
createErrorForm(java.lang.String name,
MultiPointCoordSet extraCoordSet,
MultiPointConfigKey rendererKey)
Returns a MultiPointForm for drawing error bars.
|
Outliner |
createOutliner(ConfigMap config)
Returns an object which will do the work of drawing shapes
when supplied with the appropriate style information and data.
|
static MultiPointForm |
createVectorForm(java.lang.String name,
MultiPointCoordSet extraCoordSet,
boolean canScale)
Returns a MultiPointForm instance for drawing arrows from the
central position to another position.
|
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.
|
java.lang.String |
getFormDescription()
Returns a description of this mode as an XML string.
|
javax.swing.Icon |
getFormIcon()
Returns an icon to identify this form in the GUI.
|
java.lang.String |
getFormName()
Returns the user-directed name for this form.
|
int |
getPositionCount()
Returns the number of data positions per tuple used by this form.
|
public MultiPointForm(java.lang.String name, javax.swing.Icon icon, java.lang.String description, MultiPointCoordSet extraCoordSet, boolean canScale, MultiPointConfigKey rendererKey)
name
- shapeform nameicon
- shapeform icondescription
- XML descriptionextraCoordSet
- defines the extra positional coordinates
used to plot multipoint shapescanScale
- true if a configuration option to scale the shapes
should be suppliedrendererKey
- config key for the renderer; provides option to
vary the shape, but any renderer specified by it
must be expecting data corresponding to the
extraCoordSet
parameterpublic int getPositionCount()
ShapeForm
getPositionCount
in interface ShapeForm
public java.lang.String getFormName()
ModePlotter.Form
getFormName
in interface ModePlotter.Form
public javax.swing.Icon getFormIcon()
ModePlotter.Form
getFormIcon
in interface ModePlotter.Form
public java.lang.String getFormDescription()
ShapeForm
getFormDescription
in interface ShapeForm
public Coord[] getExtraCoords()
ShapeForm
getExtraCoords
in interface ShapeForm
public ConfigKey[] getConfigKeys()
ShapeForm
ShapeForm.createOutliner(uk.ac.starlink.ttools.plot2.config.ConfigMap)
.getConfigKeys
in interface ShapeForm
public Outliner createOutliner(ConfigMap config)
ShapeForm
ShapeForm.getConfigKeys()
.createOutliner
in interface ShapeForm
config
- configuration map from which values for this
form's config keys will be extractedpublic static MultiPointForm createVectorForm(java.lang.String name, MultiPointCoordSet extraCoordSet, boolean canScale)
name
- form nameextraCoordSet
- nDataDim-element coord set that defines one
extra data position, the (unscaled) endpoint
of the vectorcanScale
- whether to offer vector size scalingpublic static MultiPointForm createEllipseForm(java.lang.String name, MultiPointCoordSet extraCoordSet, boolean canScale)
name
- form nameextraCoordSet
- 3-element coord set containing major/minor
radius (order not significant) and
position angle in degreescanScale
- whether to offer vector size scalingpublic static MultiPointForm createErrorForm(java.lang.String name, MultiPointCoordSet extraCoordSet, MultiPointConfigKey rendererKey)
name
- form nameextraCoordSet
- coord set specifying error bar position endpointsrendererKey
- config key for specifying error renderersCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.