io.jmix.charts.model

Class GaugeBand

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.GaugeBand

All Implemented Interfaces:

java.io.Serializable

public class GaugeBand
extends AbstractChartObject

Creates a band for a specified value range on the GaugeAxis. Multiple bands can be assigned to a single GaugeAxis.
See documentation for properties of GaugeBand JS Object.
http://docs.amcharts.com/3/javascriptcharts/GaugeBand

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GaugeBand()

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getAlpha()
java.lang.String	getBalloonText()
Color	getColor()
java.lang.Double	getEndValue()
java.util.List<java.lang.Float>	getGradientRatio()
java.lang.String	getId()
java.lang.String	getInnerRadius()
java.lang.String	getRadius()
java.lang.Double	getStartValue()
java.lang.String	getUrl()
@Max(value=1L) @Min(value=0L) GaugeBand	setAlpha(java.lang.Double alpha) Sets opacity of band fill.
GaugeBand	setBalloonText(java.lang.String balloonText) Sets balloon text.
GaugeBand	setColor(Color color) Sets color of a band.
GaugeBand	setEndValue(java.lang.Double endValue) Sets end value of a fill.
GaugeBand	setGradientRatio(java.util.List<java.lang.Float> gradientRatio) Sets list of gradient ratio.
GaugeBand	setId(java.lang.String id) Sets unique id of a band.
GaugeBand	setInnerRadius(java.lang.String innerRadius) Sets inner radius of a band.
GaugeBand	setRadius(java.lang.String radius) Sets band radius.
GaugeBand	setStartValue(java.lang.Double startValue) Sets start value of a fill.
GaugeBand	setUrl(java.lang.String url) Sets URL for band.

Methods inherited from class java.lang.Object

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

Constructor Detail

GaugeBand

public GaugeBand()

Method Detail

getAlpha

public java.lang.Double getAlpha()

Returns:

opacity of band fill

setAlpha

@StudioProperty
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) GaugeBand setAlpha(java.lang.Double alpha)

Sets opacity of band fill. Will use GaugeAxis.bandAlpha if not set any.

Parameters:

alpha - opacity

Returns:

gauge band

getColor

public Color getColor()

Returns:

color of a band

setColor

@StudioProperty(type=OPTIONS)
public GaugeBand setColor(Color color)

Sets color of a band.

Parameters:

color - color

Returns:

gauge band

getEndValue

public java.lang.Double getEndValue()

Returns:

end value of a fill

setEndValue

@StudioProperty
public GaugeBand setEndValue(java.lang.Double endValue)

Sets end value of a fill.

Parameters:

endValue - end value

Returns:

gauge band

getInnerRadius

public java.lang.String getInnerRadius()

Returns:

inner radius of a band

setInnerRadius

@StudioProperty
public GaugeBand setInnerRadius(java.lang.String innerRadius)

Sets inner radius of a band. If not set any, the band will end with the end of minor ticks. Set 0 if you want the band to be drawn to the axis center.

Parameters:

innerRadius - inner radius

Returns:

gauge band

getRadius

public java.lang.String getRadius()

Returns:

band radius

setRadius

@StudioProperty
public GaugeBand setRadius(java.lang.String radius)

Sets band radius. If not set any, the band will start with the axis outline.

Parameters:

radius - band radius

Returns:

gauge band

getStartValue

public java.lang.Double getStartValue()

Returns:

start value of a fill

setStartValue

@StudioProperty
public GaugeBand setStartValue(java.lang.Double startValue)

Sets start value of a fill.

Parameters:

startValue - start value

Returns:

gauge band

getBalloonText

public java.lang.String getBalloonText()

Returns:

balloon text

setBalloonText

@StudioProperty
public GaugeBand setBalloonText(java.lang.String balloonText)

Sets balloon text. When rolled-over, band will display balloon.

Parameters:

balloonText - balloon text

Returns:

gauge band

getId

public java.lang.String getId()

Returns:

unique id of a band

setId

@StudioProperty
public GaugeBand setId(java.lang.String id)

Sets unique id of a band.

Parameters:

id - id

Returns:

gauge band

getUrl

public java.lang.String getUrl()

Returns:

the URL

setUrl

@StudioProperty
public GaugeBand setUrl(java.lang.String url)

Sets URL for band. Gauge band can be clickable and can lead to some page.

Parameters:

url - the URL

Returns:

gauge band

getGradientRatio

public java.util.List<java.lang.Float> getGradientRatio()

Returns:

list of gradient ratio

setGradientRatio

@StudioProperty(type=STRING)
public GaugeBand setGradientRatio(java.util.List<java.lang.Float> gradientRatio)

Sets list of gradient ratio. Will make bands to be filled with color gradients. Negative value means the color will be darker than the original, and positive number means the color will be lighter.

Parameters:

gradientRatio - list of gradient ratio

Returns:

gauge band