AppWithin Minutes Charts and Data

Last modified by Admin on 2022/02/28 00:29

cogAllows creating charts and data table for AppWithinMinutes applications
TypeXAR
Category
Developed by

Ludovic Dubost

Active Installs12
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Tested with XWiki 9.8.1 and 10.2

Installable with the Extension Manager

Description

Allows creating charts and data table for AppWithinMinutes applications. 

You will find the link to the charts page in the left menu

awm-charts-menu.png

You can then select an application or class

awm-charts-home.png

You can create bar or pie charts by choosing the fields from your application or class:

awm-charts-table.png

awm-charts-pie.png

You can also create charts using the macro in the Wysiwyg editor or in Wiki syntax. See the macro parameters below:

{{awmchart app="Help.Applications.Movies" category="databaseList1" type="pie" title="Chart" width="500" height="500" table="1" /}}
 Parameter  Description  Default Value
 app  Application Name to get the data for the chart (corresponds to the space) Empty
 className  Class Name used alternatively to an Application name  Empty
 category  Field on which the counting is made status
 type  Chart type (pie / bar / bar3D) Empty
 title  Title of the chart Empty
 width  Width of the chart 500px
 height  Height of the chart 500px
 table  Display of the data table (0/1) 1
 chart  Display of the chart (0/1) 1
 chartClasses  CSS Classes to add to the chart 'div' col-md-6 col-sm-12
 tableClasses  CSS Classes to add to the table 'div' col-md-6 col-sm-12
 useRow  Display of a bootstrap row (0/1) 1
 colors  Colors to use for the chart (separated by commas) backgroundColor:FFFFFF;
legendBackgroundColor:FFFFFF;
borderColor:FFFFFF;
plotBackgroundColor:FFFFFF;
plotBorderColor:FFFFFF;
plotBorderVisible:false
 addParams  Additional parameters for the chart (see the [[Chart macro documentation>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Chart%20Macro]) Empty
 fromHQL  Additional HQL to add to the from part of the query Empty
 whereHQL  Additional HQL to add to the where part of the query Empty
 function  Function to apply to the category field Empty
 aggregate  Aggregate field to use instead of count Empty
 aggregateFunction  Function to apply to the aggregate sum
 orderColumn  Colonne par laquelle trier les données. to sort the results on. Le tri par défaut est sur les données Vide
 orderDirection  Direction du tri (asc pour ascendant / desc pour descendant). Te tri par défaut est déscendant desc
 columnTitle  Titre à utiliser pour la colonne de groupement (la première colonne) Vide
 aggregateTitle  Titre à utiliser pour la colonne de données (la seconde colonne) Vide

awm-charts-macro.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v1.2.2

  • Support linked fields for the category field
  • Find document title when a value represents a document
  • Support having restrictions

v1.2.1

  • Support document fields in aggregates
  • Default aggregate set to count(distinct doc.fullName)
  • Added category field to macro definition

v1.2

  • Support document fields in aggregates
  • Default aggregate set to count(distinct doc.fullName)

v1.1

  • Added sort configuration
  • Added table header title configuration

v1.0

Initial release of chart macro and application

Tags:
    

Get Connected