org.xwiki.chart

Interface ChartGenerator

@Role
public interface ChartGenerator

A component interface for defining various chart generators.

Since:

2.0M1

Version:

$Id: 453329f7e37e870f75b093b38731bc0d05bd8ef0 $

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLORS_PARAM Color parameter identifier.
static String	HEIGHT_PARAM Height parameter identifier.
static String	SERIES_PARAM Source parameter identifier.
static String	TITLE_PARAM Title parameter identifier.
static String	TYPE_PARAM Type parameter identifier.
static String	WIDTH_PARAM Width parameter identifier.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	generate(ChartModel model, Map<String,String> parameters) Generates an image of a chart representing the data presented as a ChartModel and extra formatting parameters provided in the parameters map.

Field Detail

TITLE_PARAM

static final String TITLE_PARAM

Title parameter identifier.

See Also:

Constant Field Values

HEIGHT_PARAM

static final String HEIGHT_PARAM

Height parameter identifier.

See Also:

Constant Field Values

WIDTH_PARAM

static final String WIDTH_PARAM

Width parameter identifier.

See Also:

Constant Field Values

TYPE_PARAM

static final String TYPE_PARAM

Type parameter identifier.

See Also:

Constant Field Values

SERIES_PARAM

static final String SERIES_PARAM

Source parameter identifier.

See Also:

Constant Field Values

COLORS_PARAM

static final String COLORS_PARAM

Color parameter identifier. The format is color1,color2,...,colorN where each color is specified as a 6 characters string, the first 2 representing in hexadecimal the red percentage, the next two the green percentage and the last 2 the blue percentage. For example FF0000,00FF00,0000FF for red, green, blue.

See Also:

Constant Field Values

Method Detail

generate

byte[] generate(ChartModel model,
              Map<String,String> parameters)
                throws ChartGeneratorException

Generates an image of a chart representing the data presented as a ChartModel and extra formatting parameters provided in the parameters map.

Parameters:

model - the ChartModel which defines the data model to be represented by the chart.

parameters - extra parameters for controlling various features of the image output.

Returns:

the chart image (binary).

Throws:

ChartGeneratorException - if the ChartGenerator is unable to render a chart.