net.sf.jasperreports.charts.JRPieSeries Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.charts;
import net.sf.jasperreports.engine.JRCloneable;
import net.sf.jasperreports.engine.JRExpression;
import net.sf.jasperreports.engine.JRHyperlink;
/**
* Represents the series for the Pie dataset.
*
* @author Teodor Danciu ([email protected])
*/
public interface JRPieSeries extends JRCloneable
{
/**
* @return a java.lang.Comparable
object representing
* the categories that will make up the slices in the pie chart.
*/
public JRExpression getKeyExpression();
/**
* @return a numeric expression that produces the values corresponding
* to each category/key in the dataset.
*/
public JRExpression getValueExpression();
/**
* @return the label expression. If this expression is missing, the chart
* will display default labels for each slice in the pie chart. Use this
* expression, which returns java.lang.String
values, to customize
* the item labels for the pie chart.
*/
public JRExpression getLabelExpression();
/**
* Returns the hyperlink specification for chart sections.
*
* The hyperlink will be evaluated for every chart section and an image map will be created for the chart.
*
*
* @return hyperlink specification for chart sections
*/
public JRHyperlink getSectionHyperlink();
}