Charts Data Importer

Transcription

1 Charts Data Importer Plugin for Joomla! Editor extension for Aimy Charts This manual documents version 3.0.x of the Joomla! extension.

2 1 Introduction The Joomla! plugin Aimy Charts Data Importer allows you to import and process your data from CSV files easily. A new button is displayed below your editor within Joomla! that lets you import your data to display diagrams with a few clicks. Data from Microsoft Excel or OpenOffice.org s Calc that is exported to CSV can be used as well. This manual guides you through all steps necessary to install and use the plugin. 2 Requirements In order to make use of the imported chart data, Aimy Charts has to be both installed and enabled. Have a look at our website for further information and to download the software: For the use in the backend Aimy Charts Data Importer requires a current browser that supports the FileReader API. Therefore, only the following browsers and versions are supported: Firefox, 3.6 or above Chrome, 7 or above Internet Explorer, 10 or above Safari, or above Opera, or above 3 Installation The installation of the extension follows the common Joomla! procedures. In case you are not familiar with these procedures, proceed as follows: 1. Download the extension s ZIP archive 2. Log into your Joomla! backend as "Super User" 3. From the menu, choose "Extensions" "Extensions Manager" 4. Click on the "Browse" button and select the ZIP archive 5. Click on the "Upload & Install" button The extension s archive will be uploaded and installed afterwards. For further information, please have a look at the Joomla! documentation Installing an Extension. NOTE: All plugins are disabled by Joomla! when installed for the first time. To enable Aimy Charts Data Importer, proceed and configure the plugin. Aimy Charts Data Importer v3.0.x 1 Aimy Extensions

3 4 Configuration After a fresh installation, click on the "Configure plugin now" button on the installation report page. At any time, you can configure the Aimy Charts Data Importer plugin using Joomla! s Plugin Manager by choosing "Extensions" "Plugin Manager" from the menu. Locate the plugin and click on its name in the "Plugin Name" column of the plugin listing. 4.1 Enabling the Plugin In order to use the plugin s functionality, you have to enable it first. To do so, change the plugin s status from "Disabled" to "Enabled" and apply your changes by clicking on either the "Save" or "Save & Close" button in the toolbar. 4.2 Setting Default Options for CSV Import Aimy Charts Data Importer allows you to set default values for the CSV data import Default Chart Type Allows you to set the default chart type that should be pre-selected in the data import dialog Default Separator Allows you to set the default separator that should be pre-selected in the data import dialog. Aimy Charts Data Importer v3.0.x 2 Aimy Extensions

4 5 Importing Data from CSV 5.1 Supported Input Formats Aimy Charts Data Importer supports the import of data in CSV format. This format is both plain text and is supported by a wide range of applications, making it a good choice for data exchange. NOTE: The CSV file has to be encoded in UTF Workflow to import data from CSV The workflow used to import your data from CSV for an Aimy Charts definition that will be shown as a nice diagram in your frontend is a simple and intuitive one: 1. Open the resource you would like to import your CSV data into. This may, for example, be an article or a module. Focus your editor and place the cursor on the position you would like to import to. 2. Locate the "Import Chart Data" button below your editor and click it. 3. A dialog opens as an overlay and provides all settings required to import your data to display a diagram. The settings for "Chart Type" or "Separator" are initially set to the defaults you set in the plugin s configuration. Adjust these settings if necessary. Aimy Charts Data Importer v3.0.x 3 Aimy Extensions

5 4. Click on the button that allows you to select a local file from your disk, usually labeled "Browse..." or alike. Select the CSV file you would like to import. 5. A sample of the file will be shown in the dialog, which presents the first three lines of your file. Have a look at the sample and the fields it provides and decide which ones should be imported. Pie and Doughnut charts require two fields, while Line and Bar charts require three fields. All chart types allow one optional, last field which may be used to specify the color that shall be used for the data set. Have a look at Aimy Charts user manual for details. If you need to select only a set of particular fields, enter their numbers in the input field labeled "Select Fields" and separated them with commas, i.e. "1,2,3". 6. Click the "Import" button. Aimy Charts Data Importer will then process each line of your file and generate a complete chart definition for Aimy Charts which will be inserted to your editor and the dialog window will close. Aimy Charts Data Importer v3.0.x 4 Aimy Extensions

6 6 Copyright & Trademark Notice The Joomla! name and logo are trademarks of Open Source Matters, Inc. in the United States and other countries. Aimy Charts Data Importer uses the csv-to-array JavaScript library for parsing CSV files. Thanks to Daniel Tillin for developing this library and providing it under the terms of the MIT license. Mentioned hard- and software as well as companies may be trademarks of their respective owners. Use of a term in this manual should not be regarded as affecting the validity of any trademark or service mark. A missing annotation of the trademark may not lead to the assumption that no trademark is claimed and may thus be used freely. Aimy Charts Data Importer v3.0.x 5 Aimy Extensions