Get started

Built-in charts & reports

Dashboard gadgets

Self scripted charts

Manage permissions


Import and export scripted charts


xCharts API Javadoc


Chart scripting examples

Additional product info

Versions Compared

Old Version 15

changes.mady.by.user Decadis AG

Saved on

compared with

New Version 16

changes.mady.by.user Decadis AG

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 1.7.0

Overview

xCharts is a charting app that allows to generate custom charts & reports directly within Jira to visualize project and issue analysis. New charts can easily be created in no time by using chart & report templates. Furthermore, these templates can be expanded by just scripting own charts using Groovy and Javascript.

Features

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 via the Jira navigation bar.

Image Added


Creating your first chart

Creating a brand new chart can easily be done by using one of the many built-in templates.

By going to the "Chart Templates" any chart or report can be chosen. Clicking on the Image Added button will create a new chart.

Image Added


In the upcoming page the chart can be configured according to the specific needs by e.g. entering a JQL or selecting a Field to be summed up.

After setting the chart up it can be previewed by hitting "Chart Preview".

Finally, the chart can be saved by clicking on "Save as Chart".


Image Modified


Created charts can then be accessed by either going to the "Chart Browser

" or by hitting "Charts" in the sidebar.


Anchor
chartBrowser
chartBrowser

Chart Browser

The Chart Browser can be used for browsing through all created charts, grouped by:Browse through your charts, grouped by favorites, configured charts, custom charts and built-in charts.  

  • Favorites: Lists all charts
you
  • that are 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


Image Modified

Charts

This page gives you an overview about all charts you are allowed to see.

 +


Additionally, it is possible to:

  1. Open the chart in a new tab
  2. Edit the chart configuration
  3. Export the chart as PNG or SVG.


Anchor
charts
charts

Charts

Here are all charts listed that can be viewed by the current user. If he does not have the required permission, the chart won't be shown.

Charts can be viewed by clicking on the View a chart by clicking on the the chart name.

Favorite: Shows whether a chart is marked as favorite or not. (read more)

Type:


Image Modified


Anchor
chartTemplates
chartTemplates

Chart Templates

This page gives you an overview about all configurable built-in & scripted charts. You can create a  new chart by clicking on Image RemovedNew charts can be created by hitting the Image Added button.  

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. 

Image Modified

Creating a new chart

  • Click on "Chart Templates" and choose a template
  • click on Image Removed 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. 


    • Gadgets

    Currently there are two gadgets available within xCharts:

    They can be used for displaying the created charts right on the dashboard.

    You'll find your saved chart in the chart browser and charts


    Image Modified


    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 the 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 When marking a chart as favorite chart, it will be available in the drop-down menu on the "ChartsChart Browser" menu, page 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.

    Image Removed: chart is added as favorite Image Removed: chart is removed from favorites

    Image Removed

    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.

    Image Removed

    Gadget settings

    • Choose the chart you want to display on your dashboard,
    • Preferred background color (hex code and color names, e.g. "white" will be accepted)
    • Refresh interval (if needed)

    Image Removed

    drop-down "Charts" menu in the Jira top navigation bar.

    Image Added


    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.



    CSS Stylesheet
    #tocContainer {
margin-right: 15px; 
position: fixed;
right: 0;
top: 160px;
width: 23%;
z-index: 1;
}


    Div
    styleline-height: 150%;
    idtocContainer


    Panel
    borderColor#333f48
    bgColor#FFFFFF
    titleColor#eeeeee
    borderWidth1
    titleBGColor#333f48
    borderStylesolid
    titleOn this page

    Table of Contents
    maxLevel12
    indent20px
    classp



    Related Topics