|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ChartFactory
Main entry point for charting in JIRA. This factory can be used to generate the different types of charts that are used in JIRA. It returns a generic Chart object that contains all the information required to render the generated chart. This ensures that we can switch to a different charting framework at some stage in the future.
Nested Class Summary | |
---|---|
static class |
ChartFactory.ChartContext
Provides context for rendering a chart that is needed by all chart types. |
static class |
ChartFactory.PeriodName
Defines the period for which data in the charts will be grouped. |
static class |
ChartFactory.VersionLabel
Defines what version labels to show in a chart that supports this feature. |
Field Summary | |
---|---|
static int |
FRAGMENT_IMAGE_HEIGHT
|
static int |
FRAGMENT_IMAGE_WIDTH
|
static int |
PORTLET_IMAGE_HEIGHT
|
static int |
PORTLET_IMAGE_WIDTH
|
static int |
REPORT_IMAGE_HEIGHT
|
static int |
REPORT_IMAGE_WIDTH
|
Method Summary | |
---|---|
Chart |
generateAverageAgeChart(ChartFactory.ChartContext context,
int days,
ChartFactory.PeriodName periodName)
Generates what is essentially a bar chart showing the average time that issues have been open for over time. |
Chart |
generateCreatedVsResolvedChart(ChartFactory.ChartContext context,
int days,
ChartFactory.PeriodName periodName,
ChartFactory.VersionLabel versionLabels,
boolean cumulative,
boolean showUnresolvedTrend)
Generates a created vs resolved line graph, showing the difference between created and resolved issues. |
Chart |
generateDateRangeTimeChart(ChartFactory.ChartContext context,
int days,
ChartFactory.PeriodName periodName,
long yAxisTimePeriod,
String labelSuffixKey,
String dateFieldId)
Generates a date range chart time, meaning a chart that shows time values for particular date ranges. |
Chart |
generatePieChart(ChartFactory.ChartContext context,
String statisticType)
Generates a pie chart for a particular field. |
Chart |
generateRecentlyCreated(ChartFactory.ChartContext context,
int days,
ChartFactory.PeriodName periodName)
Generates a stacked bar chart showing the number of created/resolved issues for a certain time period. |
Chart |
generateTimeSinceChart(ChartFactory.ChartContext context,
int days,
ChartFactory.PeriodName periodName,
boolean cumulative,
String dateFieldId)
Generates a chart showing the number of issues since a certain date field. |
Field Detail |
---|
static final int FRAGMENT_IMAGE_HEIGHT
static final int FRAGMENT_IMAGE_WIDTH
static final int PORTLET_IMAGE_HEIGHT
static final int PORTLET_IMAGE_WIDTH
static final int REPORT_IMAGE_HEIGHT
static final int REPORT_IMAGE_WIDTH
Method Detail |
---|
Chart generateCreatedVsResolvedChart(ChartFactory.ChartContext context, int days, ChartFactory.PeriodName periodName, ChartFactory.VersionLabel versionLabels, boolean cumulative, boolean showUnresolvedTrend)
context
- Basic information needed to generate all chartsdays
- Number of days to go back in time for the chartperiodName
- Defines if the data will be grouped in days, weeks, months...versionLabels
- Defines what version labels to show in the chartcumulative
- Display cumulative totals for the resolved and unresolved issuesshowUnresolvedTrend
- Displays a subgraph showing the trend at which issues are being resolved
Chart generateDateRangeTimeChart(ChartFactory.ChartContext context, int days, ChartFactory.PeriodName periodName, long yAxisTimePeriod, String labelSuffixKey, String dateFieldId)
context
- Basic information needed to generate all chartsdays
- Number of days to go back in time for the chartperiodName
- Defines if the data will be grouped in days, weeks, months...yAxisTimePeriod
- Time period in millis to display on the yAxis. Only supports Hours and DayslabelSuffixKey
- The i18n suffix key to display for mouse tool tips in the chartdateFieldId
- The date field to use as the basis for the times displayed per date range
Chart generatePieChart(ChartFactory.ChartContext context, String statisticType)
FilterStatisticsValuesGenerator
for possible values for the statisticType. Custom fields are also supported by simply entering the
'customfield_
context
- Basic information needed to generate all chartsstatisticType
- The field for which to generate the pie slices.
Chart generateAverageAgeChart(ChartFactory.ChartContext context, int days, ChartFactory.PeriodName periodName)
context
- Basic information needed to generate all chartsdays
- Number of days to go back in time for the chartperiodName
- Defines if the data will be grouped in days, weeks, months...
Chart generateRecentlyCreated(ChartFactory.ChartContext context, int days, ChartFactory.PeriodName periodName)
context
- Basic information needed to generate all chartsdays
- Number of days to go back in time for the chartperiodName
- Defines if the data will be grouped in days, weeks, months...
Chart generateTimeSinceChart(ChartFactory.ChartContext context, int days, ChartFactory.PeriodName periodName, boolean cumulative, String dateFieldId)
DateField
.
context
- Basic information needed to generate all chartsdays
- Number of days to go back in time for the chartperiodName
- Defines if the data will be grouped in days, weeks, months...cumulative
- Display cumulative totals for the number of issuesdateFieldId
- The date field to use as the basis for the times displayed per date range
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |