Package net.pricefx.common.apibuilder.chart

Class AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends AbstractChartOptions<C,O>>

Object
ObjectIdentity
BacklinkBuilder<C>
AbstractChartOptions<C,O>
Direct Known Subclasses:
ChartOptions.Basic, DataTableChart.DataTableOptions
public abstract class AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends AbstractChartOptions<C,O>> extends BacklinkBuilder<C>
Common base class for the Options object returned by every chart type's AbstractChartBuilder.getOptions(), for example ScatterChart.ScatterOptions or BarLineChart.BarLineOptions. You never instantiate this class or a concrete subclass of it directly.

Options control chart-wide display settings: title and legend, axis labels and bounds, an optional Z axis and embedded boxplot overlay, period comparison, and interaction toggles such as drilldown and zoom. Every method here is declared protected and selectively re-exposed as public by intermediate tier classes in ChartOptions (ChartOptions.Basic, ChartOptions.XYLabels, ChartOptions.XYMinMax, ChartOptions.ZAxis, ChartOptions.EmbeddedBoxplot), mirroring how AbstractChartSeries exposes its own optional methods, plus a few methods each concrete Options type re-exposes directly rather than through one of those tiers. Not every chart type extends one of these tiers at all: DataTableChart.DataTableOptions extends this class directly and exposes almost none of these methods. Consult a concrete Options type's own public methods to see which of these are actually available on it.

See Also:

  • Constructor Details

    • AbstractChartOptions

      protected AbstractChartOptions(C backLink, String instanceId)

  • Method Details

    • getThis

      protected O getThis()

    • setTitle

      protected O setTitle(String title)
      Sets the chart's title. Declared protected here; re-exposed as public via ChartOptions.Basic (and every tier built on top of it).
      Parameters:
      title - the title to display above the chart
      Returns:
      this Options object, for chaining further configuration

    • setSubtitle

      protected O setSubtitle(String subtitle)
      Sets the chart's subtitle, shown below the title. Declared protected here; re-exposed as public via ChartOptions.Basic (and every tier built on top of it).
      Parameters:
      subtitle - the subtitle to display
      Returns:
      this Options object, for chaining further configuration

    • setHideLegend

      protected O setHideLegend(Boolean hideLegend)
      Hides the chart's legend. Declared protected here; re-exposed as public via ChartOptions.Basic (and every tier built on top of it).
      Parameters:
      hideLegend - true to hide the legend; false or null to show it
      Returns:
      this Options object, for chaining further configuration

    • setHideTooltips

      protected O setHideTooltips(Boolean hideTooltips)
      Hides the chart's tooltips. Declared protected here; re-exposed as public via ChartOptions.Basic (and every tier built on top of it).
      Parameters:
      hideTooltips - true to hide tooltips; false or null to show them
      Returns:
      this Options object, for chaining further configuration

    • setXLabel

      protected O setXLabel(String xLabel)
      Sets the X axis label. Declared protected here; re-exposed as public via ChartOptions.XYLabels (and every tier built on top of it).
      Parameters:
      xLabel - the label to display on the X axis
      Returns:
      this Options object, for chaining further configuration

    • setXMin

      protected O setXMin(BigDecimal xMinDecimal)
      Sets the X axis' lower bound for a chart type whose X axis is a plain numeric scale. Declared protected here; re-exposed as public via ChartOptions.XYMinMax, for example ScatterChart.ScatterOptions.
      Parameters:
      xMinDecimal - the lowest value to show on the X axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setXMin

      protected O setXMin(Date xMinDate)
      Sets the X axis' lower bound for a chart type whose X axis is a continuous date/time scale, unlike setXMin(BigDecimal). Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example DetailedTimeSeriesChart.DetailedTimeSeriesOptions or TimeSeriesScatterChart.TimeSeriesScatterOptions.
      Parameters:
      xMinDate - the earliest date/time to show on the X axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setXMax

      protected O setXMax(BigDecimal xMaxDecimal)
      Sets the X axis' upper bound for a chart type whose X axis is a plain numeric scale. Declared protected here; re-exposed as public via ChartOptions.XYMinMax, for example ScatterChart.ScatterOptions.
      Parameters:
      xMaxDecimal - the highest value to show on the X axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setXMax

      protected O setXMax(Date xMaxDate)
      Sets the X axis' upper bound for a chart type whose X axis is a continuous date/time scale, unlike setXMax(BigDecimal). Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example DetailedTimeSeriesChart.DetailedTimeSeriesOptions or TimeSeriesScatterChart.TimeSeriesScatterOptions.
      Parameters:
      xMaxDate - the latest date/time to show on the X axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setXLogarithmic

      protected O setXLogarithmic(boolean enable)
      Renders the X axis on a logarithmic scale. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example ScatterChart.ScatterOptions or BubbleChart.BubbleOptions. Only meaningful for a chart type whose X axis is itself an aggregated numeric measure.
      Parameters:
      enable - true to use a logarithmic X axis; false for a linear one
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setYLabel

      protected O setYLabel(String yLabel)
      Sets the Y axis label. Declared protected here; re-exposed as public via ChartOptions.XYLabels (and every tier built on top of it).
      Parameters:
      yLabel - the label to display on the Y axis
      Returns:
      this Options object, for chaining further configuration

    • setYMin

      protected O setYMin(BigDecimal yMin)
      Sets the Y axis' lower bound. Declared protected here; re-exposed as public independently via both ChartOptions.XYMinMax and ChartOptions.ZAxis, since most chart types have a Y axis worth bounding regardless of which of those two tiers they otherwise build on.
      Parameters:
      yMin - the lowest value to show on the Y axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setYMax

      protected O setYMax(BigDecimal xMax)
      Sets the Y axis' upper bound. Declared protected here; re-exposed as public independently via both ChartOptions.XYMinMax and ChartOptions.ZAxis, since most chart types have a Y axis worth bounding regardless of which of those two tiers they otherwise build on.
      Parameters:
      xMax - the highest value to show on the Y axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setYLogarithmic

      protected O setYLogarithmic(boolean enable)
      Renders the Y axis on a logarithmic scale. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example ScatterChart.ScatterOptions or BarLineChart.BarLineOptions.
      Parameters:
      enable - true to use a logarithmic Y axis; false for a linear one
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setShowZAxis

      protected O setShowZAxis(Boolean showZAxis)
      Shows or hides the chart's secondary Z axis. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).
      Parameters:
      showZAxis - true to show the Z axis; false or null to hide it
      Returns:
      this Options object, for chaining further configuration

    • setZLabel

      protected O setZLabel(String zLabel)
      Sets the Z axis label. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).
      Parameters:
      zLabel - the label to display on the Z axis
      Returns:
      this Options object, for chaining further configuration

    • setZMin

      protected O setZMin(BigDecimal zMin)
      Sets the Z axis' lower bound. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).
      Parameters:
      zMin - the lowest value to show on the Z axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setZMax

      protected O setZMax(BigDecimal zMax)
      Sets the Z axis' upper bound. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).
      Parameters:
      zMax - the highest value to show on the Z axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setZLogarithmic

      protected O setZLogarithmic(boolean enable)
      Renders the Z axis on a logarithmic scale. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example BarLineChart.BarLineOptions or TimeSeriesChart.TimeSeriesOptions.
      Parameters:
      enable - true to use a logarithmic Z axis; false for a linear one
      Returns:
      this Options object, for chaining further configuration

    • setComparison

      protected O setComparison(Boolean comparison)
      Enables comparing this chart's data against a prior period. Declared protected here; re-exposed as public via ChartOptions.ZAxis (and ChartOptions.EmbeddedBoxplot, which is built on top of it).
      Parameters:
      comparison - true to enable period comparison; false or null to disable it
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setComparisonType

      protected O setComparisonType(ComparisonType comparisonType)
      Sets how the compared prior period, enabled with setComparison(Boolean), is chosen. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example BarLineChart.BarLineOptions or DetailedTimeSeriesChart.DetailedTimeSeriesOptions.
      Parameters:
      comparisonType - the kind of prior period to compare against
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setBoxplotAxisLabel

      protected O setBoxplotAxisLabel(String boxplotAxisLabel)
      Sets the label for the axis of an embedded box plot overlay (see AbstractChartSeries.setBoxplotAxis() at the series level). Declared protected here; re-exposed as public via ChartOptions.EmbeddedBoxplot, for example BarLineChart.BarLineOptions or TimeSeriesChart.TimeSeriesOptions.
      Parameters:
      boxplotAxisLabel - the label to display for the embedded boxplot axis
      Returns:
      this Options object, for chaining further configuration

    • setBoxplotAxisMin

      protected O setBoxplotAxisMin(BigDecimal boxplotAxisMin)
      Sets the lower bound for an embedded box plot overlay's axis. Declared protected here; re-exposed as public via ChartOptions.EmbeddedBoxplot, for example BarLineChart.BarLineOptions or TimeSeriesChart.TimeSeriesOptions.
      Parameters:
      boxplotAxisMin - the lowest value to show on the embedded boxplot axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setBoxplotAxisMax

      protected O setBoxplotAxisMax(BigDecimal boxplotAxisMax)
      Sets the upper bound for an embedded box plot overlay's axis. Declared protected here; re-exposed as public via ChartOptions.EmbeddedBoxplot, for example BarLineChart.BarLineOptions or TimeSeriesChart.TimeSeriesOptions.
      Parameters:
      boxplotAxisMax - the highest value to show on the embedded boxplot axis
      Returns:
      this Options object, for chaining further configuration
      See Also:

    • setDisableDrilldown

      protected O setDisableDrilldown(Boolean disableDrilldown)
      Disables drilldown on this chart. Not exposed through any ChartOptions tier; almost every concrete Options type overrides it directly, since drilldown applies broadly across chart types.
      Parameters:
      disableDrilldown - true to disable drilldown; false or null to allow it
      Returns:
      this Options object, for chaining further configuration

    • setDisableZoom

      protected O setDisableZoom(Boolean disableZoom)
      Disables zooming on this chart. Not exposed through any ChartOptions tier; most concrete Options types that support zoom override it directly.
      Parameters:
      disableZoom - true to disable zoom; false or null to allow it
      Returns:
      this Options object, for chaining further configuration

    • setMaxDataPoints

      protected O setMaxDataPoints(BigDecimal maximumNumberOfDataPoints)
      Limits how many data points this chart renders. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example BarLineChart.BarLineOptions, PieChart.PieOptions, or BoxplotChart.BoxplotOptions.
      Parameters:
      maximumNumberOfDataPoints - the maximum number of data points to render
      Returns:
      this Options object, for chaining further configuration

    • setMarker

      protected O setMarker(BigDecimal xValue, BigDecimal yValue)
      Adds a reference marker at the given X/Y coordinate. Not exposed through any ChartOptions tier; a concrete Options type overrides it directly, for example ScatterChart.ScatterOptions, BubbleChart.BubbleOptions, or TimeSeriesScatterChart.TimeSeriesScatterOptions. Only meaningful for a chart type whose X and Y axes are both aggregated numeric measures.
      Parameters:
      xValue - the marker's X coordinate
      yValue - the marker's Y coordinate
      Returns:
      this Options object, for chaining further configuration