Excel Plugin

Last modified by Thomas Mortagne on 2024/07/05 14:35

page_white_excelExtracts data from Excel spreadsheets and view them in wiki pages
TypeJAR
Category
Developed by

xwiki:XWiki.ganji, Cristina Lopes, Ludovic Dubost

Active Installs71
Rating
1 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Representing data in Wiki Tables

This plugin works with Excel 95, 97, 2000, XP, and 2003 workbooks. The XLSX format is not supported.

Usage

If your data is in an excel file and you want to display it in your wiki page, you can simply attach your excel file to your page and use a code like the following:

$xwiki.calc.getTable($attachname, $sheetname, $range)

Here, the first parameter specifies the name of the Excel attachment. The second parameter specifies the name or number of the sheet where your data is located. The last parameter specifies the range of the data.

Example

$xwiki.calc.getTable("sample.xls", "1", "A1-B10")

Representing data on Charts

This is an extension of the Charting Plugin which allows you to extract your data from your excel files and show them on your wiki pages.

Usage

Since this is an extension of the Charting Plugin, you can use all of the chart types as described in Charting Samples. The only difference is that the source of the chart is specified like the following:

{chart:
  source=type:excel; file:sample.xls; sheet:1; range:A1-C10|
  type=bar|
  width=700
}

Acknowledgment

The development of this plugin was in part supported by award no. OCI-0724806 from the National Science Foundation.

Prerequisites & Installation Instructions

  • Download the Java Excel API and copy the jxl.jar file to the %xwikipath%/WEB-INF/lib/ directory of your xwiki installation.
  • Download the plugin on this page and copy the jar file to the %xwikipath%/WEB-INF/lib/ directory of your xwiki installation.

Edit your WEB-INF/xwiki.cfg file as follows:

xwiki.plugins=[...],com.xpn.xwiki.plugin.excel.ExcelPlugin

Restart your XWiki instance

You can try if the installation is good with this code :

{{velocity}}
$xwiki.calc
{{/velocity}}

You should see as result something like "com.xpn.xwiki.plugin.excel.ExcelPluginAPI@1e36ee47". If not, there is something wrong in your installation.

Example of usage:

{{velocity}}
{{html}}
$xwiki.ExcelPlugin.getTable("test.xls", "1", "B1-F20")
{{/html}}
{{/velocity}}

Release Notes

v1.1

Dependencies

Dependencies for this extension (org.xwiki.contrib:xwiki-plugin-excel 1.1):

  • org.xwiki.platform:xwiki-platform-chart-plugin 4.5.4
  • net.sourceforge.jexcelapi:jxl 2.6.12

Get Connected