Class XYSeriesRenderer

java.lang.Object

com.codename1.charts.renderers.SimpleSeriesRenderer

com.codename1.charts.renderers.XYSeriesRenderer

public class XYSeriesRenderer
extends SimpleSeriesRenderer

A renderer for the XY type series.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XYSeriesRenderer.FillOutsideLine	A descriptor for the line fill behavior.

Constructor Summary

Constructors

Constructor	Description
XYSeriesRenderer()

Method Summary

Modifier and Type	Method	Description
void	addFillOutsideLine(XYSeriesRenderer.FillOutsideLine fill)	Sets if the line chart should be filled outside its line.
int	getAnnotationsColor()	Returns the annotations color.
int	getAnnotationsTextAlign()	Returns the annotations text align.
float	getAnnotationsTextSize()	Returns the annotations text size.
float	getChartValuesSpacing()	Returns the chart values spacing from the data point.
int	getChartValuesTextAlign()	Returns the chart values text align.
float	getChartValuesTextSize()	Returns the chart values text size.
int	getDisplayChartValuesDistance()	Returns the chart values minimum distance.
XYSeriesRenderer.FillOutsideLine[]	getFillOutsideLine()	Returns the type of the outside fill of the line.
float	getLineWidth()	Returns the chart line width.
float	getPointStrokeWidth()	Returns the point stroke width in pixels.
PointStyle	getPointStyle()	Returns the point style.
boolean	isDisplayChartValues()	Returns if the chart point values should be displayed as text.
boolean	isFillBelowLine()	Deprecated.
boolean	isFillPoints()	Returns if the chart points should be filled.
void	setAnnotationsColor(int color)	Sets the annotations color.
void	setAnnotationsTextAlign(int align)	Sets the annotations text align.
void	setAnnotationsTextFont(Font font)	Sets the annotations text font size using a Font object instead of a point size.
void	setAnnotationsTextSize(float textSize)	Sets the annotations text size.
void	setChartValuesSpacing(float spacing)	Sets the chart values spacing from the data point.
void	setChartValuesTextAlign(int align)	Sets the chart values text align.
void	setChartValuesTextFont(Font font)	Sets the chart values title text font size using a Font object instead of a point size.
void	setChartValuesTextSize(float textSize)	Sets the chart values text size.
void	setDisplayChartValues(boolean display)	Sets if the chart point values should be displayed as text.
void	setDisplayChartValuesDistance(int distance)	Sets chart values minimum distance.
void	setFillBelowLine(boolean fill)	Deprecated.
void	setFillBelowLineColor(int color)	Deprecated.
void	setFillPoints(boolean fill)	Sets if the chart points should be filled.
void	setLineWidth(float lineWidth)	Sets the chart line width.
void	setPointStrokeWidth(float strokeWidth)	Sets the point stroke width in pixels.
void	setPointStyle(PointStyle style)	Sets the point style.

Methods inherited from class SimpleSeriesRenderer

getChartValuesFormat, getColor, getGradientStartColor, getGradientStartValue, getGradientStopColor, getGradientStopValue, getStroke, isDisplayBoundingPoints, isGradientEnabled, isHighlighted, isShowLegendItem, setChartValuesFormat, setColor, setDisplayBoundingPoints, setGradientEnabled, setGradientStart, setGradientStop, setHighlighted, setShowLegendItem, setStroke

Modifier and Type	Method	Description
NumberFormat	getChartValuesFormat()	Returns the number format for displaying chart values.
int	getColor()	Returns the series color.
int	getGradientStartColor()	Returns the gradient start color.
double	getGradientStartValue()	Returns the gradient start value.
int	getGradientStopColor()	Returns the gradient stop color.
double	getGradientStopValue()	Returns the gradient stop value.
BasicStroke	getStroke()	Returns the stroke style.
boolean	isDisplayBoundingPoints()	Returns if the bounding points of the first and last visible ones should be displayed.
boolean	isGradientEnabled()	Returns the gradient is enabled value.
boolean	isHighlighted()	Returns if the item is displayed highlighted.
boolean	isShowLegendItem()	Returns if the legend item for this renderer should be visible.
void	setChartValuesFormat(NumberFormat format)	Sets the number format for displaying chart values.
void	setColor(int color)	Sets the series color.
void	setDisplayBoundingPoints(boolean display)	Sets if the bounding points of the first and last visible ones should be displayed.
void	setGradientEnabled(boolean enabled)	Sets the gradient enabled value.
void	setGradientStart(double start, int color)	Sets the gradient start value and color.
void	setGradientStop(double start, int color)	Sets the gradient stop value and color.
void	setHighlighted(boolean highlighted)	Sets if the item for this renderer should be highlighted.
void	setShowLegendItem(boolean showLegend)	Sets if the legend item for this renderer should be visible.
void	setStroke(BasicStroke stroke)	Sets the stroke style.

Methods inherited from class Object

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

Modifier and Type	Method	Description
protected Object	clone()
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
final Class	getClass()	Returns the runtime class of an object.
int	hashCode()	Returns a hash code value for the object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes current thread to wait until another thread invokes the method or the method for this object.
final void	wait(long timeout)	Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.
final void	wait(long timeout, int nanos)	Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

Constructor Details

XYSeriesRenderer

public XYSeriesRenderer()

Method Details

isFillBelowLine

@Deprecated
public boolean isFillBelowLine()

Deprecated.

Returns if the chart should be filled below the line.

Returns

the fill below line status

Deprecated

Use #getFillOutsideLine() instead.

setFillBelowLine

@Deprecated
public void setFillBelowLine(boolean fill)

Deprecated.

Sets if the line chart should be filled below its line. Filling below the line transforms a line chart into an area chart.

Parameters

• fill: the fill below line flag value

Deprecated

Use #addFillOutsideLine(FillOutsideLine) instead.

getFillOutsideLine

public XYSeriesRenderer.FillOutsideLine[] getFillOutsideLine()

Returns the type of the outside fill of the line.

Returns

the type of the outside fill of the line.

addFillOutsideLine

public void addFillOutsideLine(XYSeriesRenderer.FillOutsideLine fill)

Sets if the line chart should be filled outside its line. Filling outside with FillOutsideLine.INTEGRAL the line transforms a line chart into an area chart.

Parameters

• fill: the type of the filling

isFillPoints

public boolean isFillPoints()

Returns if the chart points should be filled.

Returns

the points fill status

setFillPoints

public void setFillPoints(boolean fill)

Sets if the chart points should be filled.

Parameters

• fill: the points fill flag value

setFillBelowLineColor

@Deprecated
public void setFillBelowLineColor(int color)

Deprecated.

Sets the fill below the line color.

Parameters

• color: the fill below line color

Deprecated

Use FillOutsideLine.setColor instead

getPointStyle

public PointStyle getPointStyle()

Returns the point style.

Returns

the point style

setPointStyle

public void setPointStyle(PointStyle style)

Sets the point style.

Parameters

• style: the point style

getPointStrokeWidth

public float getPointStrokeWidth()

Returns the point stroke width in pixels.

Returns

the point stroke width in pixels

setPointStrokeWidth

public void setPointStrokeWidth(float strokeWidth)

Sets the point stroke width in pixels.

Parameters

• strokeWidth: the point stroke width in pixels

getLineWidth

public float getLineWidth()

Returns the chart line width.

Returns

the line width

setLineWidth

public void setLineWidth(float lineWidth)

Sets the chart line width.

Parameters

• lineWidth: the line width

isDisplayChartValues

public boolean isDisplayChartValues()

Returns if the chart point values should be displayed as text.

Returns

if the chart point values should be displayed as text

setDisplayChartValues

public void setDisplayChartValues(boolean display)

Sets if the chart point values should be displayed as text.

Parameters

• display: if the chart point values should be displayed as text

getDisplayChartValuesDistance

public int getDisplayChartValuesDistance()

Returns the chart values minimum distance.

Returns

the chart values minimum distance

setDisplayChartValuesDistance

public void setDisplayChartValuesDistance(int distance)

Sets chart values minimum distance.

Parameters

• distance: the chart values minimum distance

getChartValuesTextSize

public float getChartValuesTextSize()

Returns the chart values text size.

Returns

the chart values text size

setChartValuesTextSize

public void setChartValuesTextSize(float textSize)

Sets the chart values text size. Consider using #setChartValuesTextFont(com.codename1.ui.Font) instead to allow the font size to to be adjusted appropriately for the display resolution.

Parameters

• textSize: the chart values text size

setChartValuesTextFont

public void setChartValuesTextFont(Font font)

Sets the chart values title text font size using a Font object instead of a point size. This method is the preferred way to set font size because it allows you to more easily have fonts appear in an appropriate size for the target device.

Alternatively check out #setChartValuesTextSize(float) to set the text size in pixels.

Parameters

• font

getChartValuesTextAlign

public int getChartValuesTextAlign()

Returns the chart values text align.

Returns

the chart values text align

setChartValuesTextAlign

public void setChartValuesTextAlign(int align)

Sets the chart values text align.

Parameters

• align: the chart values text align

getChartValuesSpacing

public float getChartValuesSpacing()

Returns the chart values spacing from the data point.

Returns

the chart values spacing

setChartValuesSpacing

public void setChartValuesSpacing(float spacing)

Sets the chart values spacing from the data point.

Parameters

• spacing: @param spacing the chart values spacing (in pixels) from the chart data point

getAnnotationsTextSize

public float getAnnotationsTextSize()

Returns the annotations text size.

Returns

the annotations text size

setAnnotationsTextSize

public void setAnnotationsTextSize(float textSize)

Sets the annotations text size. Consider using #setAnnotationsTextFont(com.codename1.ui.Font) instead to allow the font size to to be adjusted appropriately for the display resolution.

Parameters

• textSize: the annotations text size

setAnnotationsTextFont

public void setAnnotationsTextFont(Font font)

Sets the annotations text font size using a Font object instead of a point size. This method is the preferred way to set font size because it allows you to more easily have fonts appear in an appropriate size for the target device.

Alternatively check out #setAnnotationsTextSize(float) to set the text size in pixels.

Parameters

• font

getAnnotationsTextAlign

public int getAnnotationsTextAlign()

Returns the annotations text align.

Returns

the annotations text align

setAnnotationsTextAlign

public void setAnnotationsTextAlign(int align)

Sets the annotations text align.

Parameters

• align: the chart values text align

getAnnotationsColor

public int getAnnotationsColor()

Returns the annotations color.

Returns

the annotations color

setAnnotationsColor

public void setAnnotationsColor(int color)

Sets the annotations color.

Parameters

• color: the annotations color