Class SkyMultiPointForm
java.lang.Object
uk.ac.starlink.ttools.plot2.layer.MultiPointForm
uk.ac.starlink.ttools.plot2.layer.SkyMultiPointForm
- All Implemented Interfaces:
ModePlotter.Form
,ShapeForm
MultiPointForm for use with sky coordinates.
- Since:
- 2 Aug 2017
- Author:
- Mark Taylor
-
Field Summary
FieldsModifier and TypeFieldDescriptionConfig key for angular extent scaling.Config key for selecting angular extent units.Fields inherited from class uk.ac.starlink.ttools.plot2.layer.MultiPointForm
AUTOSCALE_PIXELS
-
Constructor Summary
ConstructorsConstructorDescriptionSkyMultiPointForm
(String name, Icon icon, String description, SkyMultiPointCoordSet extraCoordSet, MultiPointConfigKey rendererKey) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected MultiPointReader
createReader
(ConfigMap config) Returns an object that can read shapes for use by this form.static String
Returns a sentence of XML text describing the units of a scaled coordinate are specified.static String
getScalingDescription
(FloatingCoord[] scaledCoords, String shapename) Returns XML text suitable for inclusion in a MultiPointForm description explaining how the scaling of marker sizes is controlled.Methods inherited from class uk.ac.starlink.ttools.plot2.layer.MultiPointForm
adjustGeom, createOutliner, createThicknessKey, getBasicPositionCount, getConfigKeys, getDefaultScalingDescription, getExtraCoords, getExtraPositionCount, getExtrasCoordIndex, getFormDescription, getFormIcon, getFormName
-
Field Details
-
SCALE_KEY
Config key for angular extent scaling. -
UNIT_KEY
Config key for selecting angular extent units.
-
-
Constructor Details
-
SkyMultiPointForm
public SkyMultiPointForm(String name, Icon icon, String description, SkyMultiPointCoordSet extraCoordSet, MultiPointConfigKey rendererKey) Constructor.- Parameters:
name
- shapeform nameicon
- shapeform icondescription
- XML descriptionextraCoordSet
- defines the extra positional coordinates used to plot multipoint shapesrendererKey
- config key for the renderer, defining the plotted shape; any renderer specified must be expecting data corresponding to the extraCoordSet parameter
-
-
Method Details
-
createReader
Description copied from class:MultiPointForm
Returns an object that can read shapes for use by this form.- Specified by:
createReader
in classMultiPointForm
- Parameters:
config
- configuration options- Returns:
- reader
-
getCoordUnitText
Returns a sentence of XML text describing the units of a scaled coordinate are specified. This is suitable for inclusion in the description of the relevant FloatingCoord.- Returns:
- description text
-
getScalingDescription
Returns XML text suitable for inclusion in a MultiPointForm description explaining how the scaling of marker sizes is controlled.- Parameters:
scaledCoords
- coordinates that will be scaled by the scale and unit config optionsshapename
- human-readable name of the shape being plotted by this form- Returns:
- description text <p> element
-