Commits

Anonymous committed 3c75d00

First draft

Comments (0)

Files changed (1)

-== Welcome ==
-
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
-
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/roberto.aloi/highcharts-php/wiki/
-}}}
-
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-
-=== Syntax highlighting ===
-
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+== Welcome ==
+
+=== What is highcharts-php ===
+highcharts-php is a PHP library to interact with the [[http://www.highcharts.com|Highcharts JS charting library]].
+
+=== What is Highcharts ===
+Reading from the official documentation, "Highcharts is a charting library written in pure JavaScript, offering an easy way of adding interactive charts to your web site or web application".
+
+The Highcharts JS libraries are available at: www.highcharts.com and they are free for non commercial use. For commercial usage, please refers to the license and pricing section of their website.
+
+=== Are the Highcharts and highcharts-php projects related? ===
+Again, the highcharts-php project has nothing to do with the Highcharts projects. The authors are different and the two projects don't share any single line of code.
+
+=== Why highcharts-php ===
+The reason behind the highcharts-php project is to offer a useful tool to PHP developers to automatically generate Highcharts JS code starting from some PHP data.
+
+=== Installation ===
+To use this library, you will need [[http://www.highcharts.com/documentation/how-to-use|the Highcharts JS libraries installed]].
+
+After that, you can simply create your Highcharts graph like this:
+
+{{{
+#!php
+
+        // Include the library
+        require_once('highcharts.php');
+
+        // These are your data
+        $data1 = array();
+        $data2 = array();
+        $data3 = array();
+
+        // Convert your data arrays by doing:
+        $d1 = new HighchartsArray($data1);
+        $d2 = new HighchartsArray($data2);
+        $d3 = new HighchartsArray($data3);
+
+        // Create an option array for your graph.
+        // Refers to the official [[http://www.highcharts.com/ref/|Highcharts reference page]] for a list of the available options.
+        $options = array(
+                         'chart' => array(
+                                          'renderTo' => 'my_graph',
+                                          'defaultSeriesType' => 'line'
+                                          ),
+                         'title' => array(
+                                          'text' => 'my_title'
+                                          ),
+                         'xAxis' => array(
+                                          'categories' => $data1,
+                                          'title' => 'x_axis_title'
+                                          ),
+                         'yAxis' => array(
+                                          'title' => array(
+                                                           'text' => 'y_axis_title'
+                                                           )
+                                          ),
+                         'series' => array(
+                                           array(
+                                                 'name' => 'Data 1',
+                                                 'data' => $data1
+                                                 ),
+                                           array(
+                                                 'name' => 'Data 2',
+                                                 'data' => $data2
+                                                 )
+                                           )
+                         );
+
+        // Generate your chart
+        $chart = new Highcharts('my_graph', $options);
+
+       // Enjoy your new chart
+        echo $chart->getCode();
+        echo '<div id="my_graph" width="500" height="300"> </div>';
+
+}}}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.