Class FunctionPlotter

Method Details

• setConstantMap

  public void setConstantMap(Map<String, ? extends Constant<?>> constMap)

  Sets a map from constant name to constant objects for values that may be referenced by expressions plotted here. The identity and/or content of this map may change over the lifetime of this plotter.

  Parameters:

  constMap - map of JEL constants by name, may be null

• getConstantMap

  public Map<String, ? extends Constant<?>> getConstantMap()

  Returns the map of constant objects for values that may be referenced by expressions plotted here. The identity and/or content of this map may change over the lifetime of this plotter.

  Returns:

  map of JEL constants by name, may be null

• getPlotterDescription

  public 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

• getStyleKeys

  public ConfigKey<?>[] getStyleKeys()

  Description copied from interface: Plotter

  Returns the configuration keys used to configure style for this plotter. The keys in the return value are used in the map supplied to the Plotter.createStyle(ConfigMap) method.

  Returns:

  keys used when creating a style for this plotter.

• getFunctionStyleKeys

  public ConfigKey<?>[] getFunctionStyleKeys()

  Returns the subset of the style keys which defines the function itself.

  Returns:

  style keys for function definition

• createStyle

  public FunctionPlotter.FunctionStyle createStyle(ConfigMap config) throws ConfigException

  Description copied from interface: Plotter

  Creates a style that can be used when creating a plot layer. The keys that are significant in the supplied config map are those returned by Plotter.getStyleKeys(). The return value can be used as input to Plotter.createLayer(DataGeom, DataSpec, S).

  Parameters:

  config - map of style configuration items

  Returns:

  plotter-specific plot style

  Throws:

  ConfigException

• 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(ConfigMap).

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

  The pointDataGeom parameter is only used if the CoordGroup.getBasicPositionCount() or CoordGroup.getExtraPositionCount() method from this plotter's CoordGroup return 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

  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