com.atlassian.jira.gadgets.system
Class PieChartResource
java.lang.Object
com.atlassian.jira.gadgets.system.AbstractResource
com.atlassian.jira.gadgets.system.SearchQueryBackedResource
com.atlassian.jira.gadgets.system.PieChartResource
public class PieChartResource
- extends SearchQueryBackedResource
REST endpoint to validate and retreive Pie chart.
- Since:
- v4.0
Method Summary |
javax.ws.rs.core.Response |
getPieChart(String queryString,
String statType,
boolean returnData,
int width,
int height,
boolean inline)
Generate a pie chart and returns a simple bean containing all relievent information |
javax.ws.rs.core.Response |
validatePieChart(String queryString,
String statType)
Ensures all parameters are valid for the Pie Chart |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PieChartResource
public PieChartResource(ChartFactory chartFactory,
ChartUtils chartUtils,
JiraAuthenticationContext authenticationContext,
PermissionManager permissionManager,
StatisticTypesResource statisticTypesResource,
SearchService searchService,
VelocityRequestContextFactory velocityRequestContextFactory)
getPieChart
public javax.ws.rs.core.Response getPieChart(String queryString,
String statType,
boolean returnData,
int width,
int height,
boolean inline)
- Generate a pie chart and returns a simple bean containing all relievent information
- Parameters:
queryString
- a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with
"jql-")statType
- a valid statistic type. See StatisticTypesResource
returnData
- whther or not to return the datawidth
- the width of the chart in pixels (defaults to 400px)height
- the height of the chart in pixels (defaults to 250px)
- Returns:
- a
PieChartResource.PieChart
if all params validated else a Collection of ValidationError
validatePieChart
public javax.ws.rs.core.Response validatePieChart(String queryString,
String statType)
- Ensures all parameters are valid for the Pie Chart
- Parameters:
queryString
- a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with
"jql-")statType
- a valid statistic type. See StatisticTypesResource
- Returns:
- a Collection of
ValidationError
. Or empty list if no
errors.
Copyright © 2002-2014 Atlassian. All Rights Reserved.