summaryrefslogtreecommitdiffstats
path: root/src/charts/doc/src/examples-legendmarkers.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/charts/doc/src/examples-legendmarkers.qdoc')
-rw-r--r--src/charts/doc/src/examples-legendmarkers.qdoc43
1 files changed, 43 insertions, 0 deletions
diff --git a/src/charts/doc/src/examples-legendmarkers.qdoc b/src/charts/doc/src/examples-legendmarkers.qdoc
new file mode 100644
index 00000000..35ae5254
--- /dev/null
+++ b/src/charts/doc/src/examples-legendmarkers.qdoc
@@ -0,0 +1,43 @@
+/*!
+ \example legendmarkers
+ \title LegendMarkers Example
+ \ingroup qtcharts_examples
+
+ \brief The example shows how to make use of legend markers.
+
+ In this example we create an application which uses the QLegendMarker clicked signal to show/hide the corresponding series
+ in a chart. The connect marker button connects a clicked signal from all markers in a legend to the handleMarkerClicked slot.
+
+ \image examples_legendmarkers.png
+
+ Our application has buttons for adding or removing a series in a chart and a button to connect or disconnect the legend markers clicked signal to our handler.
+ In the image above we have connected the markers and clicked on one of them.
+
+ \snippet legendmarkers/mainwidget.cpp 1
+
+ Here we connect the markers in the legend to our handler. To avoid connecting the same marker more than once, we first disconnect it.
+
+ \snippet legendmarkers/mainwidget.cpp 2
+
+ Here we disconnect all markers from our handler.
+
+ \snippet legendmarkers/mainwidget.cpp 3
+
+ In our handler we first cast the sender of the event to the QLegendMarker.
+
+ \snippet legendmarkers/mainwidget.cpp 4
+
+ Then we check the type of the marker. This is required if we want to access the detailed methods of the marker and cast it to the correct type.
+ If all we need is the pointer to QAbstractSeries, the casting isn't necessary. In case of a pie or bar series, we may need the pointer to a related QPieSlice or QBarSet.
+
+ \snippet legendmarkers/mainwidget.cpp 5
+
+ We want to toggle the visibility of the series, when the marker is clicked. To do so, we get the pointer to a related series from the marker and toggle its visibility.
+ Since the legend marker follows the visibility of the series by default, we also set the marked back to visible. If we don't do so, the marker will be
+ invisible in the legend and we can't click on it anymore.
+
+ \snippet legendmarkers/mainwidget.cpp 6
+
+ Instead of making the marker invisible when the series is hidden, we dim the color of the marker. Here we do it by modifying the color of the laberBrush.
+
+*/