modules/swfcharts/README.txt

$Id: README.txt,v 1.3 2007/10/04 23:34:00 hlslaughter Exp $

NOTE

There has been some criticism of this module due to the fact that it relies
on proprietary code. However, this software is available for free, and it
also generates some of the nicest looking graphs I've ever seen on the web.
So rather than being "pure" and providing dodgy, pixelated images using
something like gnuplot, I chose to use SWF/Charts. 

DESCRIPTION

This is a wrapper for the XML/SWF Charts package available at
http://www.maani.us/xml_charts/

It allows for generation of very attractive charts and graphs without having
to install special graphics libraries on the server. Because the graphics are
generated client-side via Flash, there is not the additional load on the server
that comes with generating images server side with GD or jpgraph.

It provides an API for integration with other modules as well as a 'content
filter' for inline useage.

See sample images at http://www.maani.us/xml_charts/index.php?menu=Gallery

INSTALLATION

This module requires 3rd party libraries. For details, see INSTALL.txt.

USAGE

This module provides a single function which should be called as follows:

module_invoke('swfcharts', 'chart', $data, $config);

This will return a themed chart.

$data will contain a fairly elaborate data structure which you will define
according to the API details located at:
  http://www.maani.us/charts/index.php?menu=Reference

Detailed examples are provided at:
  http://www.maani.us/charts/index.php?menu=Gallery

$config is optional and will use defaults from admin/settings/swfcharts if
not supplied. 

1	$Id: README.txt,v 1.3 2007/10/04 23:34:00 hlslaughter Exp $
2
3	NOTE
4
5	There has been some criticism of this module due to the fact that it relies
6	on proprietary code. However, this software is available for free, and it
7	also generates some of the nicest looking graphs I've ever seen on the web.
8	So rather than being "pure" and providing dodgy, pixelated images using
9	something like gnuplot, I chose to use SWF/Charts.
10
11	DESCRIPTION
12
13	This is a wrapper for the XML/SWF Charts package available at
14	http://www.maani.us/xml_charts/
15
16	It allows for generation of very attractive charts and graphs without having
17	to install special graphics libraries on the server. Because the graphics are
18	generated client-side via Flash, there is not the additional load on the server
19	that comes with generating images server side with GD or jpgraph.
20
21	It provides an API for integration with other modules as well as a 'content
22	filter' for inline useage.
23
24	See sample images at http://www.maani.us/xml_charts/index.php?menu=Gallery
25
26	INSTALLATION
27
28	This module requires 3rd party libraries. For details, see INSTALL.txt.
29
30	USAGE
31
32	This module provides a single function which should be called as follows:
33
34	module_invoke('swfcharts', 'chart', $data, $config);
35
36	This will return a themed chart.
37
38	$data will contain a fairly elaborate data structure which you will define
39	according to the API details located at:
40	http://www.maani.us/charts/index.php?menu=Reference
41
42	Detailed examples are provided at:
43	http://www.maani.us/charts/index.php?menu=Gallery
44
45	$config is optional and will use defaults from admin/settings/swfcharts if
46	not supplied.
47