com.telerik.widget.chart.visualization.annotations

Class ChartLabelAnnotation

java.lang.Object

com.telerik.android.common.PropertyManager

com.telerik.widget.chart.visualization.common.PresenterBase

com.telerik.widget.chart.visualization.common.ChartElementPresenter

com.telerik.widget.chart.visualization.annotations.ChartAnnotation

com.telerik.widget.chart.visualization.annotations.ChartLabelAnnotation

All Implemented Interfaces:

ChartElementPresenter, PaletteChangedListener

Direct Known Subclasses:

CartesianChartAnnotation

public abstract class ChartLabelAnnotation
extends ChartAnnotation

Field Summary

Fields

Modifier and Type	Field and Description
static int	HORIZONTAL_ALIGNMENT_PROPERTY_KEY
static int	HORIZONTAL_OFFSET_PROPERTY_KEY
static int	LABEL_FORMAT_PROPERTY_KEY
static int	LABEL_LOCATION_PROPERTY_KEY
static int	VERTICAL_ALIGNMENT_PROPERTY_KEY
static int	VERTICAL_OFFSET_PROPERTY_KEY

Fields inherited from class com.telerik.widget.chart.visualization.annotations.ChartAnnotation

ANNOTATION_Z_INDEX

Constructor Summary

Constructors

Constructor and Description
ChartLabelAnnotation() Creates a new instance of the ChartLabelAnnotation class.

Method Summary

Modifier and Type	Method and Description
String	getLabel() Gets the current label.
String	getLabelFormat() Gets a string representing the format used to display the annotation.
HorizontalAlignment	getLabelHorizontalAlignment() Gets a value from the HorizontalAlignment enum determining the way the annotation is aligned horizontally in its bounds.
double	getLabelHorizontalOffset() Gets a boolean value determining the horizontal offset of the annotation relatively to its original bounds.
ChartAnnotationLabelLocation	getLabelLocation() Gets a value from the ChartAnnotationLabelLocation enum describing the location of the annotation related to its parent.
float	getLabelSize() Gets the label size in pixels.
VerticalAlignment	getLabelVerticalAlignment() Gets a value from the VerticalAlignment enum determining the way the annotation is aligned vertically in its bounds.
double	getLabelVerticalOffset() Gets a boolean value determining the vertical offset of the annotation relatively to its original bounds.
void	setLabel(String value) Sets the current label.
void	setLabelFormat(String value) Sets the format string used to display the annotation.
void	setLabelHorizontalAlignment(HorizontalAlignment value) Sets a value from the HorizontalAlignment enum determining the way the annotation is aligned horizontally in its bounds.
void	setLabelHorizontalOffset(double value) Sets a boolean value determining the horizontal offset of the annotation relatively to its original bounds.
void	setLabelLocation(ChartAnnotationLabelLocation value) Sets a value from the ChartAnnotationLabelLocation enum determining the location of the annotation relatively to its parent.
void	setLabelSize(float value) Sets the label size in pixels.
void	setLabelVerticalAlignment(VerticalAlignment value) Sets a value from the VerticalAlignment enum determining the way the annotation is aligned vertically in its bounds.
void	setLabelVerticalOffset(double value) Sets a boolean value determining the vertical offset of the annotation relatively to its original bounds.

Methods inherited from class com.telerik.widget.chart.visualization.annotations.ChartAnnotation

getClipToPlotArea, getModel, render, setClipToPlotArea

Methods inherited from class com.telerik.widget.chart.visualization.common.ChartElementPresenter

attach, detach, getCanApplyPalette, getChart, getCollectionIndex, getPalette, getZIndex, invalidatePalette, onPaletteInvalidated, onPaletteUpdated, requestLayout, requestRender, setZIndex, updatePalette

Methods inherited from class com.telerik.widget.chart.visualization.common.PresenterBase

getPaletteFamily, getPaletteFamilyCore, isLoaded, isPaletteApplied, isVisible, measureContent, paletteFamily, postRender, refreshNode, setCanApplyPalette, setPaletteFamily, setVisible, setVisible

Methods inherited from class com.telerik.android.common.PropertyManager

getValue, resetPropertyValue, setValue, setValue

Methods inherited from class java.lang.Object

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

Field Detail

LABEL_FORMAT_PROPERTY_KEY

public static final int LABEL_FORMAT_PROPERTY_KEY

LABEL_LOCATION_PROPERTY_KEY

public static final int LABEL_LOCATION_PROPERTY_KEY

HORIZONTAL_ALIGNMENT_PROPERTY_KEY

public static final int HORIZONTAL_ALIGNMENT_PROPERTY_KEY

VERTICAL_ALIGNMENT_PROPERTY_KEY

public static final int VERTICAL_ALIGNMENT_PROPERTY_KEY

HORIZONTAL_OFFSET_PROPERTY_KEY

public static final int HORIZONTAL_OFFSET_PROPERTY_KEY

VERTICAL_OFFSET_PROPERTY_KEY

public static final int VERTICAL_OFFSET_PROPERTY_KEY

Constructor Detail

ChartLabelAnnotation

public ChartLabelAnnotation()

Creates a new instance of the ChartLabelAnnotation class.

Method Detail

getLabelFormat

public String getLabelFormat()

Gets a string representing the format used to display the annotation.

Returns:

the format string.

setLabelFormat

public void setLabelFormat(String value)

Sets the format string used to display the annotation.

Parameters:

value - the format string.

getLabelLocation

public ChartAnnotationLabelLocation getLabelLocation()

Gets a value from the ChartAnnotationLabelLocation enum describing the location of the annotation related to its parent.

Returns:

the annotation location.

setLabelLocation

public void setLabelLocation(ChartAnnotationLabelLocation value)

Sets a value from the ChartAnnotationLabelLocation enum determining the location of the annotation relatively to its parent.

Parameters:

value - the annotation location to set.

getLabelHorizontalAlignment

public HorizontalAlignment getLabelHorizontalAlignment()

Gets a value from the HorizontalAlignment enum determining the way the annotation is aligned horizontally in its bounds.

Returns:

the horizontal alignment.

setLabelHorizontalAlignment

public void setLabelHorizontalAlignment(HorizontalAlignment value)

Sets a value from the HorizontalAlignment enum determining the way the annotation is aligned horizontally in its bounds.

Parameters:

value - the horizontal alignment.

getLabelVerticalAlignment

public VerticalAlignment getLabelVerticalAlignment()

Gets a value from the VerticalAlignment enum determining the way the annotation is aligned vertically in its bounds.

Returns:

the vertical alignment.

setLabelVerticalAlignment

public void setLabelVerticalAlignment(VerticalAlignment value)

Sets a value from the VerticalAlignment enum determining the way the annotation is aligned vertically in its bounds.

Parameters:

value - the vertical alignment.

getLabelHorizontalOffset

public double getLabelHorizontalOffset()

Gets a boolean value determining the horizontal offset of the annotation relatively to its original bounds.

Returns:

the horizontal offset.

setLabelHorizontalOffset

public void setLabelHorizontalOffset(double value)

Sets a boolean value determining the horizontal offset of the annotation relatively to its original bounds.

Parameters:

value - the horizontal offset.

getLabelVerticalOffset

public double getLabelVerticalOffset()

Gets a boolean value determining the vertical offset of the annotation relatively to its original bounds.

Returns:

the vertical offset.

setLabelVerticalOffset

public void setLabelVerticalOffset(double value)

Sets a boolean value determining the vertical offset of the annotation relatively to its original bounds.

Parameters:

value - the vertical offset.

getLabel

public String getLabel()

Gets the current label.

Returns:

the current label.

setLabel

public void setLabel(String value)

Sets the current label.

Parameters:

value - the new label.

getLabelSize

public float getLabelSize()

Gets the label size in pixels.

setLabelSize

public void setLabelSize(float value)

Sets the label size in pixels.

Parameters:

value - The new label size.