Glossary
Built-In Chart: chart that is bundled in the plugin (configurable or not)
Scripted Chart: chart created by users, written in Groovy Script.
Javascript Layout: the JS function that generates the c3.js chart and displays it.
Overview
xCharts can be reached over the Jira navigation bar.
Chart Browser
Browse through your charts, grouped by favorites, configured charts, custom charts and built-in charts.
Favorites: Lists all charts you marked as favorite
Configured Charts: Lists all saved chart configurations based on Built-In Charts.
Custom Charts: Lists all saved chart configurations based on Scripted Charts.
Built-in Charts: Lists all built-in charts where no configuration is needed
Charts
This page gives you an overview about all charts you are allowed to see.
View a chart by clicking on the the chart name.
Favorite: Shows whether a chart is marked as favorite or not. (read more)
Type:
- Built-in chart: a built-in chart where no parameters are needed.
- Configured chart: a chart based on a template.
- Scripted chart: a chart based on a Chart Data Script.
Chart Templates
This page gives you an overview about all configurable built-in & scripted charts. You can create a new chart by clicking on
Name: Displays the name and a description of a template.
Parameters: Show all parameters, which can be defined for a chart
Chart Type: Shows whether a chart is a built-in or a scripted chart.
Creating a new chart
- Click on "Chart Templates" and choose a template
- click on
to create a new chart
- Enter your parameters (e.g. a JQL or an issue)
- to get a preview of your chart click on "Show preview"
- to save a chart click on "save configuration" and enter a name and a description of your chart.
- You'll find your saved chart in the chart browser and charts
Charts in projects & issues
Charts in projects
xCharts adds a "Charts" tab to the project navigation providing quick and easy access to relevant charts relevant for your project, e.g. Tickets over Time.
Favorite Charts
Adding a new favorite
Simplify the access to frequently used charts by adding them to your favorite charts:
By marking charts as favorite, they will be available in the drop-down "Charts" menu, and in the Charts Browser, in the "Favorites" category.
To add or to remove a chart to your favorites, click on the star to the left of the chart name.
: chart is added as favorite
: chart is removed from favorites
Gadgets
Add a gadget
Include the charts you need the most in your dashboard using the xChart Gadget:
- Go to your Dashboard and click on "Add gadget"
- Choose the xChart gadget.
Gadget settings
- Choose the chart you want to display on your dashboard,
- prefered background-colour (hex code and color names, e.g. "white" will be accepted)
- refresh interval (if needed)
