- Fixed issue #10055: Improve chart class documentation with chart elements

3 files changed, 45 insertions, 0 deletions

diff --git a/src/charts/bar.php b/src/charts/bar.php
index 045dd75..32ff49c 100644
--- a/src/charts/bar.php
+++ b/src/charts/bar.php
@@ -36,6 +36,22 @@
  *  $chart->render( 500, 200, 'bar_chart.svg' );
  * </code>
  *
+ * Each chart consists of several chart elements which represents logical 
+ * parts of the chart and can be formatted independently. The bar chart
+ * consists of:
+ *  - title ( ezcGraphChartElementText )
+ *  - legend ( ezcGraphChartElementLegend )
+ *  - background ( ezcGraphChartElementBackground )
+ *  - xAxis ( ezcGraphChartElementLabeledAxis )
+ *  - yAxis ( ezcGraphChartElementNumericAxis )
+ *
+ * The type of the axis may be changed and all elements can be configured by
+ * accessing them as properties of the chart:
+ *
+ * <code>
+ *  $chart->legend->position = ezcGraph::RIGHT;
+ * </code>
+ *
  * @package Graph
  * @mainclass
  */
diff --git a/src/charts/line.php b/src/charts/line.php
index 1db554b..a0ec609 100644
--- a/src/charts/line.php
+++ b/src/charts/line.php
@@ -36,6 +36,22 @@
  *  $chart->render( 500, 200, 'line_chart.svg' );
  * </code>
  *
+ * Each chart consists of several chart elements which represents logical 
+ * parts of the chart and can be formatted independently. The line chart
+ * consists of:
+ *  - title ( ezcGraphChartElementText )
+ *  - legend ( ezcGraphChartElementLegend )
+ *  - background ( ezcGraphChartElementBackground )
+ *  - xAxis ( ezcGraphChartElementLabeledAxis )
+ *  - yAxis ( ezcGraphChartElementNumericAxis )
+ *
+ * The type of the axis may be changed and all elements can be configured by
+ * accessing them as properties of the chart:
+ *
+ * <code>
+ *  $chart->legend->position = ezcGraph::RIGHT;
+ * </code>
+ *
  * @package Graph
  * @mainclass
  */
diff --git a/src/charts/pie.php b/src/charts/pie.php
index 4283806..7ec1d7a 100644
--- a/src/charts/pie.php
+++ b/src/charts/pie.php
@@ -30,6 +30,19 @@
  *  $chart->render( 500, 200, 'line_chart.svg' );
  * </code>
  *
+ * Each chart consists of several chart elements which represents logical 
+ * parts of the chart and can be formatted independently. The pie chart
+ * consists of:
+ *  - title ( ezcGraphChartElementText )
+ *  - legend ( ezcGraphChartElementLegend )
+ *  - background ( ezcGraphChartElementBackground )
+ *
+ * All elements can be configured by accessing them as properties of the chart:
+ *
+ * <code>
+ *  $chart->legend->position = ezcGraph::RIGHT;
+ * </code>
+ *
  * @package Graph
  * @mainclass
  */