io.jmix.charts.model

Class GaugeArrow

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.GaugeArrow

All Implemented Interfaces:

java.io.Serializable

public class GaugeArrow
extends AbstractChartObject

Creates an arrow for AngularGaugeChart chart, multiple can be assigned.
See documentation for properties of GaugeArrow JS Object.
http://docs.amcharts.com/3/javascriptcharts/GaugeArrow

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GaugeArrow()

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getAlpha()
java.lang.String	getAxis()
java.lang.Double	getBorderAlpha()
java.lang.Boolean	getClockWiseOnly()
Color	getColor()
java.lang.String	getId()
java.lang.String	getInnerRadius()
java.lang.Double	getNailAlpha()
java.lang.Double	getNailBorderAlpha()
java.lang.Integer	getNailBorderThickness()
java.lang.Integer	getNailRadius()
java.lang.String	getRadius()
java.lang.Integer	getStartWidth()
java.lang.Double	getValue()
@Max(value=1L) @Min(value=0L) GaugeArrow	setAlpha(java.lang.Double alpha) Sets opacity of an arrow.
GaugeArrow	setAxis(java.lang.String axis) Sets axis of the arrow.
@Max(value=1L) @Min(value=0L) GaugeArrow	setBorderAlpha(java.lang.Double borderAlpha) Sets opacity of arrow border.
GaugeArrow	setClockWiseOnly(java.lang.Boolean clockWiseOnly) Set clockWiseOnly to true if you need the arrow to rotate only clock-wise.
GaugeArrow	setColor(Color color) Sets color of an arrow.
GaugeArrow	setId(java.lang.String id) Sets unique id of an arrow.
GaugeArrow	setInnerRadius(java.lang.String innerRadius) Sets inner radius of an arrow.
@Max(value=1L) @Min(value=0L) GaugeArrow	setNailAlpha(java.lang.Double nailAlpha) Sets opacity of a nail, holding the arrow.
@Max(value=1L) @Min(value=0L) GaugeArrow	setNailBorderAlpha(java.lang.Double nailBorderAlpha) Sets opacity of nail border.
GaugeArrow	setNailBorderThickness(java.lang.Integer nailBorderThickness) Sets thickness of nail border.
GaugeArrow	setNailRadius(java.lang.Integer nailRadius) Sets radius of a nail, holding the arrow.
GaugeArrow	setRadius(java.lang.String radius) Sets radius of an arrow.
GaugeArrow	setStartWidth(java.lang.Integer startWidth) Sets width of arrow root.
GaugeArrow	setValue(java.lang.Double value) Sets value to which the arrow should point at.

Methods inherited from class java.lang.Object

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

Constructor Detail

GaugeArrow

public GaugeArrow()

Method Detail

getAlpha

public java.lang.Double getAlpha()

Returns:

opacity of an arrow

setAlpha

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

Sets opacity of an arrow. If not set the default value is 1.

Parameters:

alpha - opacity

Returns:

gauge arrow

getBorderAlpha

public java.lang.Double getBorderAlpha()

Returns:

opacity of arrow border

setBorderAlpha

@StudioProperty(defaultValue="1")
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) GaugeArrow setBorderAlpha(java.lang.Double borderAlpha)

Sets opacity of arrow border. If not set the default value is 1.

Parameters:

borderAlpha - border opacity

Returns:

gauge arrow

getClockWiseOnly

public java.lang.Boolean getClockWiseOnly()

Returns:

true if clockWiseOnly is enabled

setClockWiseOnly

@StudioProperty(defaultValue="false")
public GaugeArrow setClockWiseOnly(java.lang.Boolean clockWiseOnly)

Set clockWiseOnly to true if you need the arrow to rotate only clock-wise. If not set the default value is false.

Parameters:

clockWiseOnly - clockWiseOnly option

Returns:

gauge arrow

getColor

public Color getColor()

Returns:

color of an arrow

setColor

@StudioProperty(type=OPTIONS,
                defaultValue="#000000")
public GaugeArrow setColor(Color color)

Sets color of an arrow. If not set the default value is #000000.

Parameters:

color - color

Returns:

gauge arrow

getInnerRadius

public java.lang.String getInnerRadius()

Returns:

inner radius

setInnerRadius

@StudioProperty(defaultValue="0")
public GaugeArrow setInnerRadius(java.lang.String innerRadius)

Sets inner radius of an arrow. If not set the default value is 0.

Parameters:

innerRadius - inner radius

Returns:

gauge arrow

getNailAlpha

public java.lang.Double getNailAlpha()

Returns:

opacity of a nail, holding the arrow

setNailAlpha

@StudioProperty(defaultValue="1")
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) GaugeArrow setNailAlpha(java.lang.Double nailAlpha)

Sets opacity of a nail, holding the arrow. If not set the default value is 1.

Parameters:

nailAlpha - opacity

Returns:

gauge arrow

getNailBorderAlpha

public java.lang.Double getNailBorderAlpha()

Returns:

opacity of nail border

setNailBorderAlpha

@StudioProperty(defaultValue="0")
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) GaugeArrow setNailBorderAlpha(java.lang.Double nailBorderAlpha)

Sets opacity of nail border. If not set the default value is 0.

Parameters:

nailBorderAlpha - opacity

Returns:

gauge arrow

getNailBorderThickness

public java.lang.Integer getNailBorderThickness()

Returns:

thickness of nail border

setNailBorderThickness

@StudioProperty(defaultValue="1")
public GaugeArrow setNailBorderThickness(java.lang.Integer nailBorderThickness)

Sets thickness of nail border. If not set the default value is 1.

Parameters:

nailBorderThickness - thickness

Returns:

gauge arrow

getNailRadius

public java.lang.Integer getNailRadius()

Returns:

radius

setNailRadius

@StudioProperty(defaultValue="8")
public GaugeArrow setNailRadius(java.lang.Integer nailRadius)

Sets radius of a nail, holding the arrow. If not set the default value is 8.

Parameters:

nailRadius - radius

Returns:

gauge arrow

getRadius

public java.lang.String getRadius()

Returns:

radius of an arrow

setRadius

@StudioProperty(defaultValue="90%")
public GaugeArrow setRadius(java.lang.String radius)

Sets radius of an arrow. If not set the default value is 90%.

Parameters:

radius - radius

Returns:

gauge arrow

getStartWidth

public java.lang.Integer getStartWidth()

Returns:

width of arrow root

setStartWidth

@StudioProperty(defaultValue="8")
public GaugeArrow setStartWidth(java.lang.Integer startWidth)

Sets width of arrow root. If not set the default value is 8.

Parameters:

startWidth - width

Returns:

gauge arrow

getAxis

public java.lang.String getAxis()

Returns:

axis id

setAxis

@StudioProperty
public GaugeArrow setAxis(java.lang.String axis)

Sets axis of the arrow. If you don't set any axis, the first axis of a chart will be used.

Parameters:

axis - axis id

Returns:

gauge arrow

getId

public java.lang.String getId()

Returns:

unique id of an arrow

setId

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

Sets unique id of an arrow.

Parameters:

id - unique id of an arrow

Returns:

gauge arrow

getValue

public java.lang.Double getValue()

Returns:

value to which the arrow is point at

setValue

@StudioProperty
public GaugeArrow setValue(java.lang.Double value)

Sets value to which the arrow should point at.

Parameters:

value - value

Returns:

gauge arrow