bld.generator.report.excel.annotation

Annotation Type ExcelChart

@Retention(value=RUNTIME)
 @Target(value={})
public @interface ExcelChart

The Interface ExcelChart. ExcelChart is used to create different chart types.
This annotation is composed by:

• id - is the chart grouping identifier
• FieldName - chart identifier
• Function - is the chart function
• ChartTypes - to set the chart type
• SizeRow - to set height in terms number of rows
• SizeColumn - to set width in terms number of columns
• LegendPosition - to configure the legend position
• CategoryAxis - to set the category position
• ValueAxis - to set the value position
• xAxis - to set the axis categories description
• Group - to group series

It is a property of the annotation ExcelCharts

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
ExcelChartCategory[]	excelChartCategories Excel chart categories.
String	id Id.
int	sizeColumn Size column.
int	sizeRow Size row.
String	xAxis X axis.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
org.apache.poi.xddf.usermodel.PresetColor	axisLineColor Axis line color.
org.apache.poi.xddf.usermodel.chart.AxisPosition	categoryAxis Category axis.
org.apache.poi.xddf.usermodel.chart.ChartTypes	chartTypes Chart types.
org.apache.poi.xddf.usermodel.chart.AxisCrossBetween	crossBetween Cross between.
org.apache.poi.xddf.usermodel.chart.AxisCrosses	crosses Crosses.
ExcelChartDataLabel	excelChartDataLabel Excel chart data label.
org.apache.poi.xddf.usermodel.PresetColor	gridLineColor Grid line color.
boolean	group Group.
org.apache.poi.xddf.usermodel.chart.LegendPosition	legendPosition Legend position.
org.apache.poi.xddf.usermodel.PresetColor[]	lineColor Line color.
boolean	showLeaderLines Show leader lines.
boolean	smooth Smooth.
org.apache.poi.ss.SpreadsheetVersion	spreadsheetVersion Spreadsheet version.
String	title Title.
org.apache.poi.xddf.usermodel.chart.AxisPosition	valueAxis Value axis.

Element Detail

id

public abstract String id

Id.

Returns:

the string

excelChartCategories

public abstract ExcelChartCategory[] excelChartCategories

Excel chart categories.

Returns:

the excel chart category[]

xAxis

public abstract String xAxis

X axis.

Returns:

the string

sizeRow

public abstract int sizeRow

Size row.

Returns:

the int

sizeColumn

public abstract int sizeColumn

Size column.

Returns:

the int

chartTypes

public abstract org.apache.poi.xddf.usermodel.chart.ChartTypes chartTypes

Chart types.

Returns:

the chart types

Default:

org.apache.poi.xddf.usermodel.chart.ChartTypes.LINE

legendPosition

public abstract org.apache.poi.xddf.usermodel.chart.LegendPosition legendPosition

Legend position.

Returns:

the legend position

Default:

org.apache.poi.xddf.usermodel.chart.LegendPosition.BOTTOM

categoryAxis

public abstract org.apache.poi.xddf.usermodel.chart.AxisPosition categoryAxis

Category axis.

Returns:

the axis position

Default:

org.apache.poi.xddf.usermodel.chart.AxisPosition.BOTTOM

valueAxis

public abstract org.apache.poi.xddf.usermodel.chart.AxisPosition valueAxis

Value axis.

Returns:

the axis position

Default:

org.apache.poi.xddf.usermodel.chart.AxisPosition.LEFT

group

public abstract boolean group

Group.

Returns:

true, if successful

Default:

false

title

public abstract String title

Title.

Returns:

the string

Default:

""

lineColor

public abstract org.apache.poi.xddf.usermodel.PresetColor[] lineColor

Line color.

Returns:

the preset color

Default:

org.apache.poi.xddf.usermodel.PresetColor.BLACK

axisLineColor

public abstract org.apache.poi.xddf.usermodel.PresetColor axisLineColor

Axis line color.

Returns:

the preset color

Default:

org.apache.poi.xddf.usermodel.PresetColor.BLACK

gridLineColor

public abstract org.apache.poi.xddf.usermodel.PresetColor gridLineColor

Grid line color.

Returns:

the preset color

Default:

org.apache.poi.xddf.usermodel.PresetColor.GRAY

crosses

public abstract org.apache.poi.xddf.usermodel.chart.AxisCrosses crosses

Crosses.

Returns:

the axis crosses

Default:

org.apache.poi.xddf.usermodel.chart.AxisCrosses.AUTO_ZERO

crossBetween

public abstract org.apache.poi.xddf.usermodel.chart.AxisCrossBetween crossBetween

Cross between.

Returns:

the axis cross between

Default:

org.apache.poi.xddf.usermodel.chart.AxisCrossBetween.BETWEEN

showLeaderLines

public abstract boolean showLeaderLines

Show leader lines.

Returns:

true, if successful

Default:

true

excelChartDataLabel

public abstract ExcelChartDataLabel excelChartDataLabel

Excel chart data label.

Returns:

the excel chart data label

Default:

@bld.generator.report.excel.annotation.ExcelChartDataLabel

smooth

public abstract boolean smooth

Smooth.

Returns:

true, if successful

Default:

true

spreadsheetVersion

public abstract org.apache.poi.ss.SpreadsheetVersion spreadsheetVersion

Spreadsheet version.

Returns:

the spreadsheet version

Default:

org.apache.poi.ss.SpreadsheetVersion.EXCEL2007