Class FunctionPlotter

    • Field Detail

      • PLANE

        public static final FunctionPlotter PLANE
        FunctionPlotter instance for a 2-d plotting surface.
      • XNAME_KEY

        public static final ConfigKey<java.lang.String> XNAME_KEY
        Config key for the independent variable name.
      • FEXPR_KEY

        public static final ConfigKey<java.lang.String> FEXPR_KEY
        Config key for the function expression.
    • Constructor Detail

      • FunctionPlotter

        public FunctionPlotter​(FunctionPlotter.FuncAxis[] axes)
        Constructs a plotter with a given set of axis geometry options.
        Parameters:
        axes - options for function variable definitions
    • Method Detail

      • getPlotterDescription

        public java.lang.String getPlotterDescription()
        Description copied from interface: Plotter
        Returns an XML description of this plotter.

        Note: really this should appear at the LayerType level.

        Returns:
        one or more <p> elements
      • getFunctionStyleKeys

        public ConfigKey<?>[] getFunctionStyleKeys()
        Returns the subset of the style keys which defines the function itself.
        Returns:
        style keys for function definition
      • createLayer

        public PlotLayer createLayer​(DataGeom geom,
                                     DataSpec dataSpec,
                                     FunctionPlotter.FunctionStyle style)
        Description copied from interface: Plotter
        Creates a PlotLayer based on the given geometry, data and style.

        The style parameter is the result of a call to Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap).

        The dataSpec parameter must contain the coordinates defined by this plotter's CoordGroup.

        The pointDataGeom parameter is only used if getCoordGroup(). getPositionCount returns a non-zero value, otherwise the plot does not have point positions.

        It is legal to supply null for any of the parameters; if insufficient data is supplied to generate a plot, then the method should return null.

        Creating a layer should be cheap; layers may be created and not used.

        Parameters:
        geom - indicates base position coordinates and their mapping to points in the data space; if non-null, the data geom's DataGeom.hasPosition() method will return true
        dataSpec - specifies the data required for the plot
        style - data style as obtained from createStyle
        Returns:
        new plot layer, or null if no drawing will take place