Method Detail

• getLayers

  TopcatLayer[] getLayers()

  Returns the layers contributed by this control.

  Returns:

  layers

• getLegendEntries

  uk.ac.starlink.ttools.plot2.LegendEntry[] getLegendEntries()

  Returns legend entries associated with this control.

  Returns:

  legend entries

• submitReports

  void submitReports​(java.util.Map<LayerId,uk.ac.starlink.ttools.plot2.ReportMap> reports)

  Accepts report information generated by plotting layers. The submitted map may contain entries unrelated to this layer. Null map values are permitted, with the same meaning as an empty map.

  Parameters:

  reports - per-layer plot reports for layers generated on behalf of this and possibly other controls

• getCoordLabel

  java.lang.String getCoordLabel​(java.lang.String userCoordName)

  Returns a text label associated with one of the user coords for this control, typically the name of the column or expression supplying the data. Null may be returned if there's no good answer.

  Parameters:

  userCoordName - name of one of the user value infos of an input coord for this control

  Returns:

  text label associated with user coordinate

• getZoneSpecifier

  uk.ac.starlink.ttools.plot2.config.Specifier<ZoneId> getZoneSpecifier()

  Returns a specifier that determines which zone of a multi-zone plot this control's layers will be displayed in. If this control is known to be used in a single-zone context, null should be returned.

  Returns:

  zone id specifier, or null