Clone wiki

pivotcharts / Documentation

Back to Home

pivochartslogo.JPG


Table of content:


Introduction


How to install the plugin

Pls visit the plugins marketplace page and find an installation instruction here.


How to setup an initial chart

To create a chart the following steps are required:

  • Create a new or open an existing Jira® dashboard
  • Click on "add gadget", select "Mirrorlake PivotCharts" gadget from the list
  • In the plugin configuration screen select a filter and click "save"
  • Click on a cell to open related list of issues.

features_mainusecase.png


PivotChart gadget explained

Overview

feature_overview.PNG

Renderers

A renderer visualizes the data of your pivot table. The following renderers are available:

  • Table
  • Table Barchart
  • Row Heatmap
  • Col Heatmap
  • Horizonatal Bar Chart
  • Horizontal Stacked Bar Chart
  • Bar Chart
  • Stacked Bar Chart
  • Line Chart
  • Area Chart
  • Scatter Chart

Aggregators

Using an aggregator you can define what exactly is shown in a pivot tabel cell:

  • Count
  • Count Unique Values
  • List Unique Values
  • Sum
  • Integer Sum
  • Average
  • Minimum
  • Maximum
  • First
  • Last
  • Sum over Sum
  • 80% Upper Bound
  • 80% Lower Bound
  • Sum as Fraction of Totals
  • Sum as Fraction of Rows
  • Sum as Fraction of Columns
  • Count as Fraction of Totals
  • Count as Fraction of Rows
  • Count as Fraction of Columns

Axis Containers

There are to containers to define the horizontal and vertical chart or table axis. Juts drag & drop the fields into the conainers to adjust the layout.

Sorting rows+columns

rowsort.png

Exporting to excel

Using the button "Excel: create pivot table" the shown table can be exported to Microsoft Excel. This feature was tested with Windows7 and Microsoft Office 2010 and uses an ActiveXObject which requires Internet Explorer with activated ActiveX suppport.

The button is only active for certain renderer/aggregators (e.g. table/sum or table/count). Using the configuration option the button can also be hidden.

excel_export.PNG


Configuration Options

The following picture shows the configuration options of the plugin. Succeeding chapters explain the options in detail.

Project or Saved Filter

The fields defines the source of tickets to be taken for the chart planned and real progress data. You can select any predefined filter availabel in Jira® or just select a specific project.

Chart Title

Define your own title for your chart to give a summery of the shown content or leave it empty for hiding any title.

Date Format

Using the option you can define the format of dates used for your table. Available options are:

date_format.PNG

Time unit

View/Edit mode

The pivotable can be blocked for further modifications. In "view mode" the axis containers are hidden and only the renderer area is shown.

viewedit_mide.png

Hide Totals

You can hide the total column and row of tables and heatmaps. This might be useful for some aggregators where "totals" do not provide a useful information.

Excel export

The excel export button can be toggled for being shown (or not) above the pivot table.

In case Jira Agile™ is used, tasks can be linked to epics. The information of the "epic link" is just the key of the related epic issue. Activating this option lets the renderer lookup the epic names also. Additional database lookups are necessary which might slow down the creation of the pivot table. Pls report any performance issue to support@mirrorlake.eu.

Field selector

Used to select the issue fields you want to include in your pivot table.

Refresh interval


Frequently asked Questions

Is there any limitation of a maximum number of issues the chart can process?

Since 1.9.1.0 there is no maximum number of issues that can be received from your Jira® server.

In earlier versions the following applies:

Jira® limits the number of tickets a user can request using the REST API. Refer to the following article on the Atlassian® website for some hints on how to configure the Jira® server settings to adjust the configured max number: https://confluence.atlassian.com/jirakb/exporting-a-filter-result-containing-more-than-1000-issues-191500982.html

Is there a limitation when opening a ticket list?

You are able to get the list of related tickets when clicking on a chart element. The longer the list of tickets is, the longer the used URL for the ticket list will be. Theoretically there is a browser specific limit which heavily depends on your browser type and version. Pls report any issue to us.

Exporting to excel does not work

Check the following:

  • use Microsoft Internet Explorer (IE)
  • activate ActiveX support in IE settings
  • use a supporter renderer/aggregator (e.g. table/sum)

Contact us at support@mirrorlake.eu for any issue and report browser and MS Office Version.


Used 3rd party IP

base64_decode.js base64_encode.js

https://github.com/kvz/locutus

Copyright (c) 2007-2016 Kevin van Zonneveld (http://kvz.io) and Contributors (http://locutus.io/authors)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


D3.js

https://github.com/d3/d3 Copyright 2010-2016 Mike Bostock All rights reserved. Redistribution and use in source and binary forms, with or without modification,are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the author nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" ANDANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


C3.js

https://github.com/c3js/c3

The MIT License (MIT) Copyright (c) 2013 Masayuki Tanaka Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


PivotTable.js

https://github.com/nicolaskruchten/pivottable (MIT License) PivotTable.js is © 2012-2013 Nicolas Kruchten, Datacratic, other contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


jquery

Copyright jQuery Foundation and other contributors, https://jquery.org/ This software consists of voluntary contributions made by many individuals. For exact contribution history, see the revision history available at https://github.com/jquery/jquery-ui The following license applies to all parts of this software except as documented below:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A ARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


jQuery-MultiSelect Patrick Springstubbe https://github.com/nobleclem/jQuery-MultiSelect http://springstubbe.us

The MIT License (MIT)

Copyright (c) 2014

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Updated