Package org.zkoss.chart

Class Stop

java.lang.Object

org.zkoss.chart.Stop

All Implemented Interfaces:

org.zkoss.json.JSONAware

public class Stop
extends Object
implements org.zkoss.json.JSONAware

Stop color for linear gradient, radial gradient, and solid gauges.

Since:

2.1.0

Author:

Christopher

Constructor Summary

Constructors

Constructor	Description
Stop(Number stop, String color)	Constructs a stop color object.

Method Summary

Modifier and Type	Method	Description
String	getColor()	Get the color of this stop object.
Number	getStop()	Get the stop value of this stop object.
void	setColor(String color)	Set the color value of this stop object.
void	setStop(Number stop)	Set the stop value for this stop object.
String	toJSONString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Stop

public Stop(Number stop,
            String color)

Constructs a stop color object.

Parameters:

stop - value between 0 and 1

color - any valid color in string format

See Also:

setStop(Number), setColor(String)

Method Detail

getStop

public Number getStop()

Get the stop value of this stop object.

Returns:

stop the stop number

setStop

public void setStop(Number stop)

Set the stop value for this stop object. Value should be in the range of 0 to 1.

Parameters:

stop -

getColor

public String getColor()

Get the color of this stop object.

Returns:

color the color value as String

setColor

public void setColor(String color)

Set the color value of this stop object. Can be in any of the following format:

1. "#A4B5D4" - hex color code
2. "rgb(143, 34, 98)" - rgb color, each from 0-255
3. "rgba(53, 63, 108, 0.3)" - rgb color with alpha between 0-1

Parameters:

color - any valid color in string format

toJSONString

public String toJSONString()

Specified by:

toJSONString in interface org.zkoss.json.JSONAware