Package com.storedobject.chart

Class GaugeChart

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Chart

com.storedobject.chart.AbstractChart

com.storedobject.chart.SelfPositioningChart

com.storedobject.chart.GaugeChart

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasAnimation, HasData, HasEmphasis, HasPolarProperty, HasPosition

public class GaugeChart
extends SelfPositioningChart
implements HasPolarProperty

Gauge chart.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GaugeChart.AxisLine	Axis line used in GaugeChart.
static class	GaugeChart.Needle	Needle property of the gauge chart.

Nested classes/interfaces inherited from class com.storedobject.chart.Chart

Chart.Emphasis, Chart.Label, Chart.LabelPosition

Constructor Summary

Constructors

Constructor	Description
GaugeChart()	Constructor with a single needle for the gauge.
GaugeChart(int needles)	Constructor with number of needles for the gauge.
GaugeChart(String valueName)	Constructor with a single needle for the gauge.

Method Summary

Modifier and Type	Method	Description
void	addDialZone(int percentage, AbstractColor color)	Add a zone to the dial that should show in a different color.
protected AbstractDataProvider<?>	dataToEmbed()	Get the data to embed.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
Chart.Label	getAxisLabel(boolean create)	Get the axis label for this gauge.
GaugeChart.AxisLine	getAxisLine(boolean create)	Get the axis line for this gauge.
protected String	getLabelName()	Get the label name for encoding label if exists.
int	getNumberOfNeedles()	Get number of needles.
final PolarProperty	getPolarProperty(boolean create)	Get the polar property.
Number	getValue()	Get the current value.
Number	getValue(int needle)	Get value of a given needle.
void	setDivisions(int divisions)	Set number of divisions on the dial.
void	setEndAngle(int endAngle)	Set the ending angle of the gauge.
void	setMax(Number max)	Set maximum value on the dial.
void	setMin(Number min)	Set minimum value on the dial.
final void	setPolarProperty(PolarProperty polarProperty)	Set the polar property.
void	setStartAngle(int startAngle)	Set the starting angle of the gauge.
void	setValue(Number value)	Set the current value.
void	setValue(Number value, int needle)	Set value of a given needle.
void	showNeedle(boolean showNeedle)	Set whether needle should be shown or not.
void	showProgress(boolean showProgress)	Set whether to show progress on the dial or not. typically, you may set this if the needle is hidden.

Methods inherited from class com.storedobject.chart.SelfPositioningChart

getPosition, setPosition

Methods inherited from class com.storedobject.chart.AbstractChart

setData, setData, setType, validate

Methods inherited from class com.storedobject.chart.Chart

addParts, dataValue, dataValueIndex, declareData, getAnimation, getCoordinateSystem, getData, getEmphasis, getItemStyle, getLabel, getMarkArea, getMax, getMin, getName, getTooltip, getType, mainData, plotOn, plotOn, setAnimation, setColors, setCustomRenderer, setEmphasis, setItemStyle, setLabel, setMarkArea, setName, setTooltip, typeValue

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getRenderingIndex, getSerial, setRenderingIndex, setSerial

Methods inherited from interface com.storedobject.chart.HasPolarProperty

setHoleRadius, setRadius

Constructor Details

GaugeChart

public GaugeChart()

Constructor with a single needle for the gauge.

GaugeChart

public GaugeChart(String valueName)

Constructor with a single needle for the gauge.

Parameters:

valueName - Name of the value for this gauge.

GaugeChart

public GaugeChart(int needles)

Constructor with number of needles for the gauge.

Parameters:

needles - Number of needles for the gauge.

Method Details

showNeedle

public void showNeedle(boolean showNeedle)

Set whether needle should be shown or not.

Note: If you set this to false, "progress" (See showProgress(boolean)) will be switched on. If you don't want to display both needle and progress too, invoke showProgress(boolean) after this.

Parameters:

showNeedle - True/false.

showProgress

public void showProgress(boolean showProgress)

Set whether to show progress on the dial or not. typically, you may set this if the needle is hidden.

Parameters:

showProgress - True/false

dataToEmbed

protected AbstractDataProvider<?> dataToEmbed()

Description copied from class: Chart

Get the data to embed. This is useful only for those special charts that embed data in the chart itself rather than pointing to the dataset. Example: TreeChart, GaugeChart etc. If null is returned from this method, no data will be embedded.

Overrides:

dataToEmbed in class Chart

Returns:

Data to embed.

setValue

public void setValue(Number value)

Set the current value. If there are more than one needle, value for the first needle will be set.

Parameters:

value - Value to set.

getValue

public Number getValue()

Get the current value. If there are more than one needle, value for the first needle will be returned.

Returns:

Value.

setValue

public void setValue(Number value,
 int needle)

Set value of a given needle. (Used when more than one needle is used).

Parameters:

value - Value to set.

needle - Needle index.

getValue

public Number getValue(int needle)

Get value of a given needle. (Used when more than one needle is used).

Parameters:

needle - Needle index.

Returns:

Value.

getNumberOfNeedles

public int getNumberOfNeedles()

Get number of needles.

Returns:

Number of needles.

getLabelName

protected String getLabelName()

Description copied from class: Chart

Get the label name for encoding label if exists.

Overrides:

getLabelName in class Chart

Returns:

Label name. Default is "label".

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class Chart

Parameters:

sb - Encoded JSON string to be appended to this.

getPolarProperty

public final PolarProperty getPolarProperty(boolean create)

Description copied from interface: HasPolarProperty

Get the polar property. (If true is passed as the parameter, a new polar property will be created if not already exists).

Specified by:

getPolarProperty in interface HasPolarProperty

Parameters:

create - Whether to create it or not.

Returns:

Polar property.

setPolarProperty

public final void setPolarProperty(PolarProperty polarProperty)

Description copied from interface: HasPolarProperty

Set the polar property.

Specified by:

setPolarProperty in interface HasPolarProperty

Parameters:

polarProperty - Polar property to set. It could be null.

setStartAngle

public void setStartAngle(int startAngle)

Set the starting angle of the gauge.

Parameters:

startAngle - Starting angle.

setEndAngle

public void setEndAngle(int endAngle)

Set the ending angle of the gauge.

Parameters:

endAngle - Ending angle.

setDivisions

public void setDivisions(int divisions)

Set number of divisions on the dial.

Parameters:

divisions - Number of divisions.

setMin

public void setMin(Number min)

Set minimum value on the dial.

Parameters:

min - Minimum value.

setMax

public void setMax(Number max)

Set maximum value on the dial.

Parameters:

max - Maximum value.

addDialZone

public void addDialZone(int percentage,
 AbstractColor color)

Add a zone to the dial that should show in a different color. You can add multiple zones and each zone should specify the percentage of the dial to which a given color can be used. So, if you want to show the first 20% in "yellow", the next 50% in "green" and the last 30% in "red", you should call this method as follows:

     addDialZone(20, new Color("yellow")); // First 20%
     addDialZone(70, new Color("green")); // Next 50% (that means, show up to 20 + 50 = 70%)
     addDialZone(100, new Color("red")); // Last 30% (that means, show up to 20 + 50 + 30 = 100%)
 

Parameters:

percentage - Percentage of the dial to which the given color should be used.

color - Color.

getAxisLine

public GaugeChart.AxisLine getAxisLine(boolean create)

Get the axis line for this gauge.

Parameters:

create - If passed true, it will be created if not exists.

Returns:

Axis Line instance

getAxisLabel

public Chart.Label getAxisLabel(boolean create)

Get the axis label for this gauge.

Parameters:

create - If passed true, it will be created if not exists.

Returns:

Label instance