Package net.pricefx.common.apibuilder.chart

Class ScatterChart.ScatterOptions

Object

ObjectIdentity

BacklinkBuilder<ScatterChart>

AbstractChartOptions<ScatterChart,ScatterChart.ScatterOptions>

ChartOptions.Basic<ScatterChart,ScatterChart.ScatterOptions>

ChartOptions.XYLabels<ScatterChart,ScatterChart.ScatterOptions>

ChartOptions.XYMinMax<ScatterChart,ScatterChart.ScatterOptions>

ScatterOptions

Enclosing class:

ScatterChart

public static class ScatterChart.ScatterOptions
extends ChartOptions.XYMinMax<ScatterChart,ScatterChart.ScatterOptions>

The Options for a ScatterChart, obtained from ScatterChart.getOptions() rather than instantiated directly.

Field Summary

Fields inherited from class BacklinkBuilder

METHOD_BACK

Fields inherited from class ObjectIdentity

classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

Constructor Summary

Constructors

Constructor	Description
ScatterOptions(ScatterChart backLink, String instanceId)

Method Summary

Modifier and Type	Method	Description
ScatterChart.ScatterOptions	setDisableDrilldown(Boolean disableDrilldown)	Disables drilldown on this chart.
ScatterChart.ScatterOptions	setDisableGridDiscretization(boolean disable)	Sets the "Show Full Data Set in Grid" option, which has an effect only when discretization is enabled with setDiscretization(boolean).
ScatterChart.ScatterOptions	setDisableZoom(Boolean disableZoom)	Disables zooming on this chart.
ScatterChart.ScatterOptions	setDiscretization(boolean enable)	Enables or disables discretization (the "Merge Close Data Points" option): on a Scatter Chart with a large number of data points, nearby points are merged into clusters, each rendered as a single gray marker instead of one colored point per underlying row.
ScatterChart.ScatterOptions	setMarker(BigDecimal xValue, BigDecimal yValue)	Adds a reference marker at the given X/Y coordinate.
ScatterChart.ScatterOptions	setXLogarithmic(boolean enable)	Renders the X axis on a logarithmic scale.
ScatterChart.ScatterOptions	setYLogarithmic(boolean enable)	Renders the Y axis on a logarithmic scale.

Methods inherited from class ChartOptions.XYMinMax

setXMax, setXMin, setYMax, setYMin

Methods inherited from class ChartOptions.XYLabels

setXLabel, setYLabel

Methods inherited from class ChartOptions.Basic

setHideLegend, setHideTooltips, setSubtitle, setTitle

Methods inherited from class AbstractChartOptions

getThis, setBoxplotAxisLabel, setBoxplotAxisMax, setBoxplotAxisMin, setComparison, setComparisonType, setMaxDataPoints, setShowZAxis, setXMax, setXMin, setZLabel, setZLogarithmic, setZMax, setZMin

Methods inherited from class BacklinkBuilder

back, getParent

Methods inherited from class ObjectIdentity

addInvocation, addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScatterOptions

public ScatterOptions(ScatterChart backLink,
 String instanceId)

Method Details

setMarker

public ScatterChart.ScatterOptions setMarker(BigDecimal xValue,
 BigDecimal yValue)

Description copied from class: AbstractChartOptions

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.

Overrides:

setMarker in class AbstractChartOptions<ScatterChart,ScatterChart.ScatterOptions>

Parameters:

xValue - the marker's X coordinate

yValue - the marker's Y coordinate

Returns:

this Options object, for chaining further configuration

setDisableDrilldown

public ScatterChart.ScatterOptions setDisableDrilldown(Boolean disableDrilldown)

Description copied from class: AbstractChartOptions

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.

Overrides:

setDisableDrilldown in class AbstractChartOptions<ScatterChart,ScatterChart.ScatterOptions>

Parameters:

disableDrilldown - true to disable drilldown; false or null to allow it

Returns:

this Options object, for chaining further configuration

setDisableZoom

public ScatterChart.ScatterOptions setDisableZoom(Boolean disableZoom)

Description copied from class: AbstractChartOptions

Disables zooming on this chart. Not exposed through any ChartOptions tier; most concrete Options types that support zoom override it directly.

Overrides:

setDisableZoom in class AbstractChartOptions<ScatterChart,ScatterChart.ScatterOptions>

Parameters:

disableZoom - true to disable zoom; false or null to allow it

Returns:

this Options object, for chaining further configuration

setXLogarithmic

public ScatterChart.ScatterOptions setXLogarithmic(boolean enable)

Description copied from class: AbstractChartOptions

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.

Overrides:

setXLogarithmic in class AbstractChartOptions<ScatterChart,ScatterChart.ScatterOptions>

Parameters:

enable - true to use a logarithmic X axis; false for a linear one

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setYLogarithmic(boolean)

setYLogarithmic

public ScatterChart.ScatterOptions setYLogarithmic(boolean enable)

Description copied from class: AbstractChartOptions

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.

Overrides:

setYLogarithmic in class AbstractChartOptions<ScatterChart,ScatterChart.ScatterOptions>

Parameters:

enable - true to use a logarithmic Y axis; false for a linear one

Returns:

this Options object, for chaining further configuration

See Also:

• AbstractChartOptions.setXLogarithmic(boolean)

setDiscretization

public ScatterChart.ScatterOptions setDiscretization(boolean enable)

Enables or disables discretization (the "Merge Close Data Points" option): on a Scatter Chart with a large number of data points, nearby points are merged into clusters, each rendered as a single gray marker instead of one colored point per underlying row.

Parameters:

enable - true to merge close data points into clusters; false to plot one point per row

Returns:

this Options object, for chaining further configuration

See Also:

• setDisableGridDiscretization(boolean)

setDisableGridDiscretization

public ScatterChart.ScatterOptions setDisableGridDiscretization(boolean disable)

Sets the "Show Full Data Set in Grid" option, which has an effect only when discretization is enabled with setDiscretization(boolean). With discretization on, close data points are merged into clusters and the chart's Data Table tab lists those merged rows; passing true here makes the Data Table tab list every underlying data row instead, leaving the plotted clusters unchanged.

Parameters:

disable - true to show the full, un-merged data set in the Data Table tab; false to leave it showing the merged cluster rows

Returns:

this Options object, for chaining further configuration

See Also:

• setDiscretization(boolean)