public class

HeatMapResource

extends SearchQueryBackedResource

java.lang.Object
↳	com.atlassian.jira.gadgets.system.AbstractResource
	↳	com.atlassian.jira.gadgets.system.SearchQueryBackedResource
		↳	com.atlassian.jira.gadgets.system.HeatMapResource

Class Overview

REST endpoint to validate and retreive a Heat Map. Similar to the pie chart gadget

Nested Classes
class	HeatMapResource.DataRow
class	HeatMapResource.HeatMap	A simple bean contain all information required to render the Heat Map

Inherited Constants

Inherited Fields

Public Constructors
	HeatMapResource(ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, StatisticTypesResource statisticTypesResource, SearchService searchService, VelocityRequestContextFactory velocityRequestContextFactory, CustomFieldManager customFieldManager)

Public Methods
Response	getHeatMap(String queryString, String statType) Generate a heat map and returns a simple bean containing all relievent information
Response	validateHeatMap(String queryString, String statType) Ensures all parameters are valid for the heat map

Inherited Methods

From class java.lang.Object

Generate a heat map and returns a simple bean containing all relievent information

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`

a HeatMapResource.HeatMap if all params validated else a Collection of ValidationError

Ensures all parameters are valid for the heat map

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`