io.jmix.charts.model.label

Class Label

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.label.Label

All Implemented Interfaces:

java.io.Serializable

public class Label
extends AbstractChartObject

Creates a label on the chart which can be placed anywhere, multiple can be assigned.
See documentation for properties of Label JS Object.
http://docs.amcharts.com/3/javascriptcharts/Label

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Label()

Method Summary

Modifier and Type	Method and Description
protected void	checkCorrectInputFormat(java.lang.String value)
Align	getAlign()
java.lang.Double	getAlpha()
java.lang.Boolean	getBold()
Color	getColor()
java.lang.String	getId()
java.lang.Integer	getRotation()
java.lang.Integer	getSize()
java.lang.Integer	getTabIndex()
java.lang.String	getText()
java.lang.String	getUrl()
java.lang.String	getX() Gets the X position of the label.
java.lang.String	getY() Gets the Y position of the label.
Label	setAlign(Align align) Sets align to the label.
@Max(value=1L) @Min(value=0L) Label	setAlpha(java.lang.Double alpha) Sets opacity of the label.
Label	setBold(java.lang.Boolean bold) Set bold to true if label should be bold.
Label	setColor(Color color) Sets color of a label.
Label	setId(java.lang.String id) Sets unique id of the label.
Label	setRotation(java.lang.Integer rotation) Sets rotation angle.
Label	setSize(java.lang.Integer size) Sets text size.
Label	setTabIndex(java.lang.Integer tabIndex) Sets tab index.
Label	setText(java.lang.String text) Sets text of the label.
Label	setUrl(java.lang.String url) Sets the URL which will be access if user clicks on a label.
Label	setX(java.lang.String x) Sets the X position of the label.
Label	setY(java.lang.String y) Sets the Y position of the label.

Methods inherited from class java.lang.Object

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

Constructor Detail

Label

public Label()

Method Detail

getAlign

public Align getAlign()

Returns:

align

setAlign

@StudioProperty(type=ENUMERATION,
                defaultValue="LEFT")
public Label setAlign(Align align)

Sets align to the label. If not set the default value is LEFT.

Parameters:

align - align

Returns:

label

getAlpha

public java.lang.Double getAlpha()

Returns:

opacity of the label

setAlpha

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

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

Parameters:

alpha - opacity

Returns:

label

getBold

public java.lang.Boolean getBold()

Returns:

true if label is bold

setBold

@StudioProperty(defaultValue="false")
public Label setBold(java.lang.Boolean bold)

Set bold to true if label should be bold. If not set the default value is false.

Parameters:

bold - bold option

Returns:

label

getColor

public Color getColor()

Returns:

color of a label

setColor

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

Sets color of a label.

Parameters:

color - color

Returns:

label

getRotation

public java.lang.Integer getRotation()

Returns:

rotation angle

setRotation

@StudioProperty(defaultValue="0")
public Label setRotation(java.lang.Integer rotation)

Sets rotation angle. If not set the default value is 0.

Parameters:

rotation - angle

Returns:

label

getSize

public java.lang.Integer getSize()

Returns:

text size

setSize

@StudioProperty
public Label setSize(java.lang.Integer size)

Sets text size.

Parameters:

size - size

Returns:

label

getText

public java.lang.String getText()

Returns:

text of the label

setText

@StudioProperty
public Label setText(java.lang.String text)

Sets text of the label.

Parameters:

text - text

Returns:

label

getUrl

public java.lang.String getUrl()

Returns:

the URL

setUrl

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

Sets the URL which will be access if user clicks on a label.

Parameters:

url - the URL

Returns:

label

getX

public java.lang.String getX()

Gets the X position of the label.

Returns:

string with double or double with "%"

setX

@StudioProperty
public Label setX(java.lang.String x)

Sets the X position of the label. You can set x coordinate in percentage or in pixels format. For instance, 50% - position with percentage, 50 - position in pixels.

Parameters:

x - double or double with "%"

Returns:

label

getY

public java.lang.String getY()

Gets the Y position of the label.

Returns:

string with double or double with "%"

setY

@StudioProperty
public Label setY(java.lang.String y)

Sets the Y position of the label. You can set x coordinate in percentage or in pixels format. For instance, 50% - position with percentage, 50 - position in pixels.

Parameters:

y - double or double with "%"

Returns:

label

getId

public java.lang.String getId()

Returns:

unique id of the label

setId

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

Sets unique id of the label.

Parameters:

id - id

Returns:

label

getTabIndex

public java.lang.Integer getTabIndex()

Returns:

tab index

setTabIndex

@StudioProperty
public Label setTabIndex(java.lang.Integer tabIndex)

Sets tab index. In case you set it to some number, the chart will set focus on the label when user clicks tab key. When a focus is set, screen readers like NVDA screen reader will read the title. Note, not all browsers and readers support this.

Parameters:

tabIndex - tab index

Returns:

label

checkCorrectInputFormat

protected void checkCorrectInputFormat(java.lang.String value)