no.uib.jsparklines.renderers.util

Class ReferenceArea

java.lang.Object

no.uib.jsparklines.renderers.util.ReferenceArea

public class ReferenceArea
extends Object

Reference area that can be added to a chart.

Author:

Harald Barsnes.

Constructor Summary

Constructors

Constructor and Description
ReferenceArea(String label, double start, double end, Color areaColor, float alpha) Creates a new ReferenceArea.

Method Summary

Modifier and Type	Method and Description
float	getAlpha() Get the alpha level.
Color	getAreaColor() Get the area color.
double	getEnd() Get the end value.
String	getLabel() Returns the label.
double	getStart() Get the start value.
void	setAlpha(float alpha) Set the alpha level.
void	setAreaColor(Color areaColor) Set the area color.
void	setEnd(double end) Set the end value.
void	setLabel(String label) Sets the label.
void	setStart(double start) Set the start value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceArea

public ReferenceArea(String label,
                     double start,
                     double end,
                     Color areaColor,
                     float alpha)
              throws IllegalArgumentException

Creates a new ReferenceArea.

Parameters:

label - the reference label

start - the start of the reference area

end - the end of the reference area

areaColor - the color of the reference area

alpha - the alpha level of the reference area, range: 0.0 to 1.0

Throws:

IllegalArgumentException - alpha must be in the range 0.0 to 1.0

Method Detail

getLabel

public String getLabel()

Returns the label.

Returns:

the label

setLabel

public void setLabel(String label)

Sets the label.

Parameters:

label - the label to set

getStart

public double getStart()

Get the start value.

Returns:

the start

setStart

public void setStart(double start)

Set the start value.

Parameters:

start - the start to set

getEnd

public double getEnd()

Get the end value.

Returns:

the end

setEnd

public void setEnd(double end)

Set the end value.

Parameters:

end - the end to set

getAreaColor

public Color getAreaColor()

Get the area color.

Returns:

the areaColor

setAreaColor

public void setAreaColor(Color areaColor)

Set the area color.

Parameters:

areaColor - the areaColor to set

getAlpha

public float getAlpha()

Get the alpha level.

Returns:

the alpha level

setAlpha

public void setAlpha(float alpha)

Set the alpha level.

Parameters:

alpha - the alpha level to set