hu.ibello.graph

Interface TimeGraph

public interface TimeGraph

Represents a graph/chart where the domain axis is the time. Ibello can print the graph on the screen or can save into file.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
void	addFunction(String name, Function function) Adds a new function plot to the chart.
void	addTimeSeries(String name, List<TimeDataPoint> data) Adds a new scatter plot to the chart.
TimeDataPoint	point(LocalDate x, double y) Creates a new 2-dimension data point object.
TimeDataPoint	point(LocalDateTime x, double y) Creates a new 2-dimension data point object.
void	setName(String name) The name of the graph/chart.
void	setXAxis(String name) Sets the X axis parameters on the chart.
void	setXAxis(String name, LocalDate min, LocalDate max) Sets the X axis parameters on the chart.
void	setXAxis(String name, LocalDateTime min, LocalDateTime max) Sets the X axis parameters on the chart.
void	setYAxis(String name) Sets Y axis parameters on the chart.

Method Detail

setName

void setName(String name)

The name of the graph/chart.

Parameters:

name - the name of the graph/chart

setXAxis

void setXAxis(String name)

Sets the X axis parameters on the chart.

Parameters:

name - the name of the axis

setXAxis

void setXAxis(String name,
              LocalDate min,
              LocalDate max)

Sets the X axis parameters on the chart. If the minimum and/or maximum values are nulls, ibello will determine them automatically from the content.

Parameters:

name - the name of the axis

min - minimum value of the axis, can be null

max - maximum value of the axis, can be null

setXAxis

void setXAxis(String name,
              LocalDateTime min,
              LocalDateTime max)

Sets the X axis parameters on the chart. If the minimum and/or maximum values are nulls, ibello will determine them automatically from the content.

Parameters:

name - the name of the axis

min - minimum value of the axis, can be null

max - maximum value of the axis, can be null

setYAxis

void setYAxis(String name)

Sets Y axis parameters on the chart.

Parameters:

name - the name of the axis

addTimeSeries

void addTimeSeries(String name,
                   List<TimeDataPoint> data)

Adds a new scatter plot to the chart.

Parameters:

name - the name of the plot

data - the data points

addFunction

void addFunction(String name,
                 Function function)

Adds a new function plot to the chart. The domain axis is the function will be converted into time values. For the conversion, each x value will be considered as epoch millis.

Parameters:

name - the name of the plot

function - the function which should be plotted

point

TimeDataPoint point(LocalDate x,
                    double y)

Creates a new 2-dimension data point object.

Parameters:

x - the x value as a local date

y - the y value

Returns:

the data point object

point

TimeDataPoint point(LocalDateTime x,
                    double y)

Creates a new 2-dimension data point object.

Parameters:

x - the x value as a local date/time

y - the y value

Returns:

the data point object