net.sf.jasperreports.charts.JRPieDataset 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.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRChartDataset;
import net.sf.jasperreports.engine.JRExpression;
import net.sf.jasperreports.engine.JRHyperlink;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* This dataset is useful for rendering Pie or Pie 3D charts. Data required for such charts
* comes in the form of key-value pairs. Each pair represents a slice in the pie chart.
*
* @author Teodor Danciu ([email protected])
*/
public interface JRPieDataset extends JRChartDataset
{
/**
*
*/
@Property(
category = PropertyConstants.CATEGORY_FILL,
valueType = Boolean.class,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT, PropertyScope.DATASET},
sinceVersion = PropertyConstants.VERSION_6_0_2
)
public static final String PROPERTY_IGNORE_DUPLICATED_KEY = JRPropertiesUtil.PROPERTY_PREFIX + "chart.pie.ignore.duplicated.key";
/**
*
*/
public Float getMinPercentage();
/**
*
*/
public void setMinPercentage(Float minPercentage);
/**
*
*/
public Integer getMaxCount();
/**
*
*/
public void setMaxCount(Integer maxCount);
/**
* @return an array of {@link JRPieSeries} objects representing the
* series for the Pie or Pie 3D chart
* @see JRPieSeries
*/
public JRPieSeries[] getSeries();
/**
*
*/
public JRExpression getOtherKeyExpression();
/**
*
*/
public JRExpression getOtherLabelExpression();
/**
* Returns the hyperlink specification for the special Other chart section, if present.
*
* @return hyperlink specification for the Other chart section
*/
public JRHyperlink getOtherSectionHyperlink();
}