Package net.pricefx.common.apibuilder.chart

Class PieChart

Object

ObjectIdentity

AbstractBuilder

AbstractChartBuilder<PieChart>

PieChart

All Implemented Interfaces:

CanDrillDown, Portlet, Portlet

public class PieChart
extends AbstractChartBuilder<PieChart>
implements CanDrillDown

Builder for a Pie Chart, obtained via ChartBuilder.newPie() rather than instantiated directly. See that factory method for this chart's category/size shape (no X or Y axis) and a Groovy example.

Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at HighCharts.Chart.

See Also:

• ChartBuilder.newPie()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PieChart.PieAdditionalMeasure	A measure column on a PieChart.PieSeries, obtained from PieChart.PieSeries.addAdditionalMeasure() rather than instantiated directly.
static class	PieChart.PieOptions	The Options for a PieChart, obtained from getOptions() rather than instantiated directly.
static class	PieChart.PieSeries	A single series of a PieChart, obtained from addSeries() rather than instantiated directly.
static class	PieChart.Size	Builder for the aggregated measure that determines a PieChart.PieSeries' slice sizes, obtained from PieChart.PieSeries.setSize(String) rather than instantiated directly.

Field Summary

Fields inherited from class AbstractChartBuilder

dragDropEnabled, layout, messages, queryBuilderState, resizingEnabled

Fields inherited from class AbstractBuilder

METHOD_BUILD

Fields inherited from class ObjectIdentity

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

Fields inherited from interface Portlet

UNIT_GRID, UNIT_PX

Constructor Summary

Constructors

Constructor	Description
PieChart(IdGenerator idGenerator, Invocations<MethodInvocation> invocations)

Method Summary

Modifier and Type	Method	Description
AuxLine<PieChart>	addAuxLine()	Deprecated. since 17.1 - Pie charts do not support reference lines; this method should never have been exposed on PieChart and calling it does not add a line to the rendered chart.
PieChart.PieSeries	addSeries()	Adds a new series to this chart.
ChartBuilderResult	build()	Finishes this chart's definition.
PieChart.PieOptions	getOptions()	Returns this chart's Options builder.

Methods inherited from class AbstractChartBuilder

addInvocation, build, fromQueryBuilderState, getDictionary, getThis, invokeAddSeries, invokeGetOptions, invokeGetSeries, layout, onCellClick, onRowClick, value, withDragDrop, withError, withHeight, withHeight, withInfo, withLabelOverride, withLayout, withLayout, withLayout, withResizing, withTab, withWarning, withWidth, withWidth

Methods inherited from class ObjectIdentity

addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

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

Constructor Details

PieChart

public PieChart(IdGenerator idGenerator,
 Invocations<MethodInvocation> invocations)

Method Details

addSeries

public PieChart.PieSeries addSeries()

Adds a new series to this chart.

Returns:

a new PieChart.PieSeries for this chart. Never null.

getOptions

public PieChart.PieOptions getOptions()

Description copied from class: AbstractChartBuilder

Returns this chart's Options builder. Each concrete chart type declares its own Options subclass (for example ScatterChart.ScatterOptions, BarLineChart.BarLineOptions) exposing the settings that apply to that chart type, such as title, subtitle, and axis label and bound overrides; the exact set of available options differs per chart type, which is why this method is declared abstract here rather than implemented once for every chart.

Specified by:

getOptions in class AbstractChartBuilder<PieChart>

Returns:

this chart's type-specific AbstractChartOptions instance. Never null.

addAuxLine

@Deprecated
public AuxLine<PieChart> addAuxLine()

Deprecated.

since 17.1 - Pie charts do not support reference lines; this method should never have been exposed on PieChart and calling it does not add a line to the rendered chart. There is no replacement.

Adds a reference line to this chart.

Overrides:

addAuxLine in class AbstractChartBuilder<PieChart>

Returns:

a new AuxLine builder for this chart. Never null.

build

public ChartBuilderResult build()

Finishes this chart's definition. The returned object is what Dashboard portlets, Quote headers, and other Data Analyzer areas render.

Specified by:

build in class AbstractBuilder

Returns:

the finished chart definition. Never null.