com.sencha.gxt.chart.client.chart.series

Class SeriesLabelConfig<M>

java.lang.Object

com.sencha.gxt.chart.client.chart.series.SeriesLabelConfig<M>

Type Parameters:

M - the data type used by the config

public class SeriesLabelConfig<M>
extends Object

Configuration for Series labels.

Constructor Summary

Constructors

Constructor and Description
SeriesLabelConfig()

Method Summary

Methods

Modifier and Type	Method and Description
Series.LabelPosition	getLabelPosition() Returns the position of label on the series.
SeriesLabelProvider<M>	getLabelProvider() Returns the custom label provider.
Sprite	getSpriteConfig() Returns the label sprite configuration.
SeriesRenderer<M>	getSpriteRenderer() Returns the series renderer used on the sprites of the series.
boolean	isLabelContrast() Returns whether or not the label automatically contrasts with its background.
void	setLabelContrast(boolean labelContrast) Sets whether or not the label automatically contrasts with its background.
void	setLabelPosition(Series.LabelPosition labelPosition) Sets the position of label on the series.
void	setLabelProvider(SeriesLabelProvider<M> labelProvider) Returns the custom label provider.
void	setNumberFormatProvider(NumberFormat format) Creates a label provider using the given NumberFormat.
void	setSpriteConfig(Sprite spriteConfig) Sets the label sprite configuration.
void	setSpriteRenderer(SeriesRenderer<M> spriteRenderer) Sets the series renderer used on the sprites of the series.
<V> void	setValueProvider(ValueProvider<? super M,V> customValueProvider, LabelProvider<? super V> labelProvider) Sets a custom ValueProvider for the tooltip.

Methods inherited from class java.lang.Object

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

Constructor Detail

SeriesLabelConfig

public SeriesLabelConfig()

Method Detail

getLabelPosition

public Series.LabelPosition getLabelPosition()

Returns the position of label on the series.

Returns:

the label position

getLabelProvider

public SeriesLabelProvider<M> getLabelProvider()

Returns the custom label provider.

Returns:

the custom label provider

getSpriteConfig

public Sprite getSpriteConfig()

Returns the label sprite configuration.

Returns:

the label sprite configuration

getSpriteRenderer

public SeriesRenderer<M> getSpriteRenderer()

Returns the series renderer used on the sprites of the series.

Returns:

the series renderer used on the sprites of the series

isLabelContrast

public boolean isLabelContrast()

Returns whether or not the label automatically contrasts with its background.

Returns:

true if contrasted

setLabelContrast

public void setLabelContrast(boolean labelContrast)

Sets whether or not the label automatically contrasts with its background.

Parameters:

labelContrast - true if contrasted

setLabelPosition

public void setLabelPosition(Series.LabelPosition labelPosition)

Sets the position of label on the series.

Parameters:

labelPosition - the label position

setLabelProvider

public void setLabelProvider(SeriesLabelProvider<M> labelProvider)

Returns the custom label provider.

Parameters:

labelProvider - the custom label provider

setNumberFormatProvider

public void setNumberFormatProvider(NumberFormat format)

Creates a label provider using the given NumberFormat.

Parameters:

format - the number formatter

setSpriteConfig

public void setSpriteConfig(Sprite spriteConfig)

Sets the label sprite configuration. Defaults to TextSprite. Cannot be null.

Parameters:

spriteConfig - sprite configuration

setSpriteRenderer

public void setSpriteRenderer(SeriesRenderer<M> spriteRenderer)

Sets the series renderer used on the sprites of the series.

Parameters:

spriteRenderer - the series renderer used on the sprites of the series

setValueProvider

public <V> void setValueProvider(ValueProvider<? super M,V> customValueProvider,
                        LabelProvider<? super V> labelProvider)

Sets a custom ValueProvider for the tooltip.

Parameters:

customValueProvider - the custom value provider

labelProvider - the label provider used on the value provider