ModePlotter.Form
, ShapeForm
SkyMultiPointForm
public abstract 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 | Description |
---|---|
MultiPointForm(java.lang.String name,
javax.swing.Icon icon,
java.lang.String description,
MultiPointCoordSet extraCoordSet,
MultiPointConfigKey rendererKey,
ConfigKey[] otherKeys) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
static MultiPointForm |
createDefaultForm(java.lang.String name,
javax.swing.Icon icon,
java.lang.String description,
MultiPointCoordSet extraCoordSet,
MultiPointConfigKey rendererKey,
boolean canScale) |
Returns a new MultiPointForm with scaling in one of two default
configurations, depending on the value of the supplied canScale
parameter.
|
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.
|
static java.lang.String |
getDefaultScalingDescription(java.lang.String shapename) |
Returns XML text suitable for inclusion in a MultiPointForm description
explaining how the scaling of marker sizes is controlled.
|
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.
|
protected abstract double |
getScaleFactor(ConfigMap config) |
Returns a fixed constant by which to scale all (autoscaled or not
autoscaled) offset values before plotting.
|
protected abstract boolean |
isAutoscale(ConfigMap config) |
Indicates whether autoscaling should be applied.
|
public MultiPointForm(java.lang.String name, javax.swing.Icon icon, java.lang.String description, MultiPointCoordSet extraCoordSet, MultiPointConfigKey rendererKey, ConfigKey[] otherKeys)
name
- shapeform nameicon
- shapeform icondescription
- XML descriptionextraCoordSet
- defines the extra positional coordinates
used to plot multipoint shapesrendererKey
- 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
parameterotherKeys
- additional config keysprotected abstract double getScaleFactor(ConfigMap config)
config
- config mapprotected abstract boolean isAutoscale(ConfigMap config)
config
- config mappublic 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 java.lang.String getDefaultScalingDescription(java.lang.String shapename)
createDefaultForm
method.shapename
- human-readable name of the shape being plotted
by this formpublic 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 rendererspublic static MultiPointForm createDefaultForm(java.lang.String name, javax.swing.Icon icon, java.lang.String description, MultiPointCoordSet extraCoordSet, MultiPointConfigKey rendererKey, boolean canScale)
name
- shapeform nameicon
- shapeform icondescription
- XML descriptionextraCoordSet
- defines the extra positional coordinates
used to plot multipoint shapesrendererKey
- 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
parametercanScale
- true for standard scaling configuration,
false for no scalingCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.