Class TimeChart

java.lang.Object

com.codename1.charts.views.AbstractChart

com.codename1.charts.views.XYChart

com.codename1.charts.views.LineChart

com.codename1.charts.views.TimeChart

public class TimeChart
extends LineChart

Specialised LineChart that formats the X axis as dates or times.

Populate the chart with an XYMultipleSeriesDataset where X values are expressed as milliseconds since the epoch. Configure the desired date format using #setDateFormat(String) or let the chart choose an appropriate format automatically.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DAY	The number of milliseconds in a day.
static final String	TYPE	/** The constant to identify this chart type.

Fields inherited from class XYChart

mDataset, mRenderer

Modifier and Type	Field	Description
protected XYMultipleSeriesDataset	mDataset	The multiple series dataset.
protected XYMultipleSeriesRenderer	mRenderer	The multiple series renderer.

Constructor Summary

Constructors

Constructor	Description
TimeChart(XYMultipleSeriesDataset dataset, XYMultipleSeriesRenderer renderer)	Builds a new time chart instance.

Method Summary

Modifier and Type	Method	Description
protected void	drawXLabels(List<Double> xLabels, Double[] xTextLabelLocations, Canvas canvas, Paint paint, int left, int top, int bottom, double xPixelsPerUnit, double minX, double maxX)	The graphical representation of the labels on the X axis.
String	getChartType()	Returns the chart type identifier.
String	getDateFormat()	Returns the date format pattern to be used for formatting the X axis labels.
protected List<Double>	getXLabels(double min, double max, int count)
void	setDateFormat(String format)	Sets the date format pattern to be used for formatting the X axis labels.

Methods inherited from class LineChart

clickableAreasForPoints, drawLegendShape, drawSeries, getLegendShapeWidth, getPointsChart, isRenderPoints, setDatasetRenderer

Modifier and Type	Method	Description
protected ClickableArea[]	clickableAreasForPoints(List<Float> points, List<Double> values, float yAxisValue, int seriesIndex, int startIndex)	Returns the clickable areas for all passed points
void	drawLegendShape(Canvas canvas, SimpleSeriesRenderer renderer, float x, float y, int seriesIndex, Paint paint)	The graphical representation of the legend shape.
void	drawSeries(Canvas canvas, Paint paint, List<Float> points, XYSeriesRenderer renderer, float yAxisValue, int seriesIndex, int startIndex)	The graphical representation of a series.
int	getLegendShapeWidth(int seriesIndex)	Returns the legend shape width.
ScatterChart	getPointsChart()	Returns the scatter chart to be used for drawing the data points.
boolean	isRenderPoints(SimpleSeriesRenderer renderer)	Returns if the chart should display the points as a certain shape.
protected void	setDatasetRenderer(XYMultipleSeriesDataset dataset, XYMultipleSeriesRenderer renderer)	Sets the series and the renderer.

Methods inherited from class XYChart

draw, drawChartValuesText, drawPoints, drawSeries, drawText, drawXTextLabels, drawYLabels, getCalcRange, getDataset, getDefaultMinimum, getRenderer, getScreenR, getSeriesAndPointForScreenCoordinate, getYLabels, isRenderNullValues, setCalcRange, setScreenR, toRealPoint, toRealPoint, toScreenPoint, toScreenPoint

Modifier and Type	Method	Description
void	draw(Canvas canvas, int x, int y, int width, int height, Paint paint)	The graphical representation of the XY chart.
protected void	drawChartValuesText(Canvas canvas, XYSeries series, XYSeriesRenderer renderer, Paint paint, List<Float> points, int seriesIndex, int startIndex)	The graphical representation of the series values as text.
protected void	drawPoints(Canvas canvas, Paint paint, List<Float> pointsList, XYSeriesRenderer seriesRenderer, float yAxisValue, int seriesIndex, int startIndex)	Draws the series points.
protected void	drawSeries(XYSeries series, Canvas canvas, Paint paint, List<Float> pointsList, XYSeriesRenderer seriesRenderer, float yAxisValue, int seriesIndex, XYMultipleSeriesRenderer.Orientation or, int startIndex)	Draws the series.
protected void	drawText(Canvas canvas, String text, float x, float y, Paint paint, float extraAngle)	The graphical representation of a text, to handle both HORIZONTAL and VERTICAL orientations and extra rotation angles.
protected void	drawXTextLabels(Double[] xTextLabelLocations, Canvas canvas, Paint paint, boolean showLabels, int left, int top, int bottom, double xPixelsPerUnit, double minX, double maxX)	The graphical representation of the text labels on the X axis.
protected void	drawYLabels(Map<Integer, List<Double>> allYLabels, Canvas canvas, Paint paint, int maxScaleNumber, int left, int right, int bottom, double[] yPixelsPerUnit, double[] minY)	The graphical representation of the labels on the Y axis.
double[]	getCalcRange(int scale)
XYMultipleSeriesDataset	getDataset()
double	getDefaultMinimum()	Returns the default axis minimum.
XYMultipleSeriesRenderer	getRenderer()
protected Rectangle	getScreenR()
SeriesSelection	getSeriesAndPointForScreenCoordinate(Point screenPoint)	Given screen coordinates, returns the series and point indexes of a chart element.
protected Map<Integer, List<Double>>	getYLabels(double[] minY, double[] maxY, int maxScaleNumber)
protected boolean	isRenderNullValues()	Returns if the chart should display the null values.
void	setCalcRange(double[] range, int scale)
protected void	setScreenR(Rectangle screenR)
double[]	toRealPoint(float screenX, float screenY)
double[]	toRealPoint(float screenX, float screenY, int scale)	Transforms a screen point to a real coordinates point.
double[]	toScreenPoint(double[] realPoint)
double[]	toScreenPoint(double[] realPoint, int scale)

Methods inherited from class AbstractChart

calculateDrawPoints, drawBackground, drawLabel, drawLegend, drawPath, drawPath, drawString, getExceed, getLabel, getLegendSize, isNullValue, isVertical

Modifier and Type	Method	Description
protected static float[]	calculateDrawPoints(float p1x, float p1y, float p2x, float p2y, int screenHeight, int screenWidth)
protected void	drawBackground(DefaultRenderer renderer, Canvas canvas, int x, int y, int width, int height, Paint paint, boolean newColor, int color)	Draws the chart background.
protected void	drawLabel(Canvas canvas, String labelText, DefaultRenderer renderer, List<Rectangle2D> prevLabelsBounds, int centerX, int centerY, float shortRadius, float longRadius, float currentAngle, float angle, int left, int right, int color, Paint paint, boolean line, boolean display)	Draws a text label.
protected int	drawLegend(Canvas canvas, DefaultRenderer renderer, String[] titles, int left, int right, int y, int width, int height, int legendSize, Paint paint, boolean calculate)	Draws the chart legend.
protected void	drawPath(Canvas canvas, float[] points, Paint paint, boolean circular)	The graphical representation of a path.
protected void	drawPath(Canvas canvas, List<Float> points, Paint paint, boolean circular)	The graphical representation of a path.
protected void	drawString(Canvas canvas, String text, float x, float y, Paint paint)	Draw a multiple lines string.
protected boolean	getExceed(float currentWidth, DefaultRenderer renderer, int right, int width)	Calculates if the current width exceeds the total width.
protected String	getLabel(NumberFormat format, double label)	Makes sure the fraction digit is not displayed, if not needed.
protected int	getLegendSize(DefaultRenderer renderer, int defaultHeight, float extraHeight)	Calculates the current legend size.
boolean	isNullValue(double value)
boolean	isVertical(DefaultRenderer renderer)	Checks if the current chart is rendered as vertical.

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.

Field Details

TYPE

public static final String TYPE

/** The constant to identify this chart type.

See Also:

• Constant Field Values

DAY

public static final long DAY

The number of milliseconds in a day.

See Also:

• Constant Field Values

Constructor Details

TimeChart

public TimeChart(XYMultipleSeriesDataset dataset,
 XYMultipleSeriesRenderer renderer)

Builds a new time chart instance.

Parameters

• dataset: the multiple series dataset

• renderer: the multiple series renderer

Method Details

getDateFormat

public String getDateFormat()

Returns the date format pattern to be used for formatting the X axis labels.

Returns

the date format pattern for the X axis labels

setDateFormat

public void setDateFormat(String format)

Sets the date format pattern to be used for formatting the X axis labels.

Parameters

• format: @param format the date format pattern for the X axis labels. If null, an appropriate default format will be used.

drawXLabels

protected void drawXLabels(List<Double> xLabels,
 Double[] xTextLabelLocations,
 Canvas canvas,
 Paint paint,
 int left,
 int top,
 int bottom,
 double xPixelsPerUnit,
 double minX,
 double maxX)

The graphical representation of the labels on the X axis.

Parameters

• xLabels: the X labels values

• xTextLabelLocations: the X text label locations

• canvas: the canvas to paint to

• paint: the paint to be used for drawing

• left: the left value of the labels area

• top: the top value of the labels area

• bottom: the bottom value of the labels area

• xPixelsPerUnit: the amount of pixels per one unit in the chart labels

• minX: the minimum value on the X axis in the chart

• maxX: the maximum value on the X axis in the chart

Overrides:

drawXLabels in class XYChart

getChartType

public String getChartType()

Returns the chart type identifier.

Returns

the chart type

Overrides:

getChartType in class LineChart

getXLabels

protected List<Double> getXLabels(double min,
 double max,
 int count)

Overrides:

getXLabels in class XYChart