aboutsummaryrefslogtreecommitdiffstats
path: root/examples/charts/legend/doc/legend.rst
diff options
context:
space:
mode:
Diffstat (limited to 'examples/charts/legend/doc/legend.rst')
-rw-r--r--examples/charts/legend/doc/legend.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/examples/charts/legend/doc/legend.rst b/examples/charts/legend/doc/legend.rst
new file mode 100644
index 000000000..10fb79cc1
--- /dev/null
+++ b/examples/charts/legend/doc/legend.rst
@@ -0,0 +1,20 @@
+Legend Example
+==============
+
+This example shows how to detach the legend from the chart and how to attach it
+back.
+
+By default the chart draws the legend inside the same view with the chart. In
+some cases the user may want to draw the legend to somewhere else. To make this
+possible the legend can be detached from the chart. Detaching means that the
+chart doesn't draw the legend or try to change its layout. The detached legend can
+then be drawn wherever the user wishes, for example, in a different graphics
+scene. The behavior of the legend can be inspected by running the legend
+example. In the example we use the bar series where we add or remove the bar
+sets. The legend reflects the changes in the series. The legend can be detached or
+attached back to the chart and its alignment can be modified. When the legend
+is detached, it can be resized and positioned freely.
+
+.. image:: legend.png
+ :width: 400
+ :alt: Legend Screenshot