This file is indexed.

/usr/share/qt5/doc/qtcharts/qtcharts-qmloscilloscope-example.html is in qtcharts5-doc-html 5.9.5-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- examples-qmloscilloscope.qdoc -->
  <title>Qml Oscilloscope | Qt Charts 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtcharts-index.html">Qt Charts</a></td><td ><a href="qtcharts-examples.html">Qt Charts Examples</a></td><td >Qml Oscilloscope</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#running-the-example">Running the Example</a></li>
<li class="level1"><a href="#creating-views">Creating Views</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qml Oscilloscope</h1>
<span class="subtitle"></span>
<!-- $$$qmloscilloscope-description -->
<div class="descr"> <a name="details"></a>
<p class="centerAlign"><img src="images/examples_qmloscilloscope.png" alt="" /></p><p>The oscilloscope application demonstrates how to use the Qt Charts QML API to implement an application with strict performance requirements. The application uses generated data with configurable characteristics to mimic a simple oscilloscope user interface.</p>
<p>To get information about actual rendering speed shown in the application output console, you can set QSG_RENDER_TIMING = 1 to your run environment settings. To do so go to Projects - Run - Run environment in Qt Creator and select Add. Then you can experiment with the different configurable options of the example application to find the configuration that gives you the best performance in your environment.</p>
<a name="running-the-example"></a>
<h2 id="running-the-example">Running the Example</h2>
<p>To run the example from Qt Creator, open the <b>Welcome</b> mode and select the example from <b>Examples</b>. For more information, visit Building and Running an Example.</p>
<a name="creating-views"></a>
<h2 id="creating-views">Creating Views</h2>
<p>The application window is shared by control and scope views:</p>
<pre class="qml">

  <span class="type">Item</span> {
      <span class="name">id</span>: <span class="name">main</span>
      <span class="name">width</span>: <span class="number">600</span>
      <span class="name">height</span>: <span class="number">400</span>

      <span class="type">ControlPanel</span> {
          <span class="name">id</span>: <span class="name">controlPanel</span>
          <span class="name">anchors</span>.top: <span class="name">parent</span>.<span class="name">top</span>
          <span class="name">anchors</span>.topMargin: <span class="number">10</span>
          <span class="name">anchors</span>.bottom: <span class="name">parent</span>.<span class="name">bottom</span>
          <span class="name">anchors</span>.left: <span class="name">parent</span>.<span class="name">left</span>
          <span class="name">anchors</span>.leftMargin: <span class="number">10</span>
      ...
      <span class="type">ScopeView</span> {
          <span class="name">id</span>: <span class="name">scopeView</span>
          <span class="name">anchors</span>.top: <span class="name">parent</span>.<span class="name">top</span>
          <span class="name">anchors</span>.bottom: <span class="name">parent</span>.<span class="name">bottom</span>
          <span class="name">anchors</span>.right: <span class="name">parent</span>.<span class="name">right</span>
          <span class="name">anchors</span>.left: <span class="name">controlPanel</span>.<span class="name">right</span>
          <span class="name">height</span>: <span class="name">main</span>.<span class="name">height</span>

          <span class="name">onOpenGLSupportedChanged</span>: {
              <span class="keyword">if</span> (!<span class="name">openGLSupported</span>) {
                  <span class="name">controlPanel</span>.<span class="name">openGLButton</span>.<span class="name">enabled</span> <span class="operator">=</span> <span class="number">false</span>
                  <span class="name">controlPanel</span>.<span class="name">openGLButton</span>.<span class="name">currentSelection</span> <span class="operator">=</span> <span class="number">0</span>
              }
          }
      }

</pre>
<p>ControlView implements the buttons used for configuring. ScopeView uses a <a href="qml-qtcharts-chartview.html">ChartView</a> to show a chart with two line series:</p>
<pre class="qml">

  <span class="type"><a href="qml-qtcharts-chartview.html">ChartView</a></span> {
      <span class="name">id</span>: <span class="name">chartView</span>
      <span class="name">animationOptions</span>: <span class="name">ChartView</span>.<span class="name">NoAnimation</span>
      <span class="name">theme</span>: <span class="name">ChartView</span>.<span class="name">ChartThemeDark</span>
      property <span class="type">bool</span> <span class="name">openGL</span>: <span class="number">true</span>
      property <span class="type">bool</span> <span class="name">openGLSupported</span>: <span class="number">true</span>
      <span class="name">onOpenGLChanged</span>: {
          <span class="keyword">if</span> (<span class="name">openGLSupported</span>) {
              <span class="name">series</span>(<span class="string">&quot;signal 1&quot;</span>).<span class="name">useOpenGL</span> <span class="operator">=</span> <span class="name">openGL</span>;
              <span class="name">series</span>(<span class="string">&quot;signal 2&quot;</span>).<span class="name">useOpenGL</span> <span class="operator">=</span> <span class="name">openGL</span>;
          }
      }
      <span class="name">Component</span>.onCompleted: {
          <span class="keyword">if</span> (!<span class="name">series</span>(<span class="string">&quot;signal 1&quot;</span>).<span class="name">useOpenGL</span>) {
              <span class="name">openGLSupported</span> <span class="operator">=</span> <span class="number">false</span>
              <span class="name">openGL</span> <span class="operator">=</span> <span class="number">false</span>
          }
      }

      <span class="type"><a href="qml-qtcharts-valueaxis.html">ValueAxis</a></span> {
          <span class="name">id</span>: <span class="name">axisY1</span>
          <span class="name">min</span>: -<span class="number">1</span>
          <span class="name">max</span>: <span class="number">4</span>
      }

      <span class="type"><a href="qml-qtcharts-valueaxis.html">ValueAxis</a></span> {
          <span class="name">id</span>: <span class="name">axisY2</span>
          <span class="name">min</span>: -<span class="number">10</span>
          <span class="name">max</span>: <span class="number">5</span>
      }

      <span class="type"><a href="qml-qtcharts-valueaxis.html">ValueAxis</a></span> {
          <span class="name">id</span>: <span class="name">axisX</span>
          <span class="name">min</span>: <span class="number">0</span>
          <span class="name">max</span>: <span class="number">1024</span>
      }

      <span class="type"><a href="qml-qtcharts-lineseries.html">LineSeries</a></span> {
          <span class="name">id</span>: <span class="name">lineSeries1</span>
          <span class="name">name</span>: <span class="string">&quot;signal 1&quot;</span>
          <span class="name">axisX</span>: <span class="name">axisX</span>
          <span class="name">axisY</span>: <span class="name">axisY1</span>
          <span class="name">useOpenGL</span>: <span class="name">chartView</span>.<span class="name">openGL</span>
      }
      <span class="type"><a href="qml-qtcharts-lineseries.html">LineSeries</a></span> {
          <span class="name">id</span>: <span class="name">lineSeries2</span>
          <span class="name">name</span>: <span class="string">&quot;signal 2&quot;</span>
          <span class="name">axisX</span>: <span class="name">axisX</span>
          <span class="name">axisYRight</span>: <span class="name">axisY2</span>
          <span class="name">useOpenGL</span>: <span class="name">chartView</span>.<span class="name">openGL</span>
      }
      ...

</pre>
<p>The data of the line series is updated with a QML timer. In a real life application the updating could be triggered with a signal from Qt C++ code.</p>
<pre class="qml">

  <span class="type">Timer</span> {
      <span class="name">id</span>: <span class="name">refreshTimer</span>
      <span class="name">interval</span>: <span class="number">1</span> <span class="operator">/</span> <span class="number">60</span> <span class="operator">*</span> <span class="number">1000</span> <span class="comment">// 60 Hz</span>
      <span class="name">running</span>: <span class="number">true</span>
      <span class="name">repeat</span>: <span class="number">true</span>
      <span class="name">onTriggered</span>: {
          <span class="name">dataSource</span>.<span class="name">update</span>(<span class="name">chartView</span>.<span class="name">series</span>(<span class="number">0</span>));
          <span class="name">dataSource</span>.<span class="name">update</span>(<span class="name">chartView</span>.<span class="name">series</span>(<span class="number">1</span>));
      }
  }

</pre>
<p>The oscilloscope also allows you to switch the type of the series used for visualizing the signal sources. This is implemented by dynamically destroying and creating series:</p>
<pre class="qml">

  <span class="keyword">function</span> <span class="name">changeSeriesType</span>(<span class="name">type</span>) {
      <span class="name">chartView</span>.<span class="name">removeAllSeries</span>();

      <span class="comment">// Create two new series of the correct type. Axis x is the same for both of the series,</span>
      <span class="comment">// but the series have their own y-axes to make it possible to control the y-offset</span>
      <span class="comment">// of the &quot;signal sources&quot;.</span>
      <span class="keyword">if</span> (<span class="name">type</span> <span class="operator">==</span> <span class="string">&quot;line&quot;</span>) {
          var <span class="name">series1</span> = <span class="name">chartView</span>.<span class="name">createSeries</span>(<span class="name">ChartView</span>.<span class="name">SeriesTypeLine</span>, <span class="string">&quot;signal 1&quot;</span>,
                                               <span class="name">axisX</span>, <span class="name">axisY1</span>);
          <span class="name">series1</span>.<span class="name">useOpenGL</span> <span class="operator">=</span> <span class="name">chartView</span>.<span class="name">openGL</span>

          var <span class="name">series2</span> = <span class="name">chartView</span>.<span class="name">createSeries</span>(<span class="name">ChartView</span>.<span class="name">SeriesTypeLine</span>, <span class="string">&quot;signal 2&quot;</span>,
                                               <span class="name">axisX</span>, <span class="name">axisY2</span>);
          <span class="name">series2</span>.<span class="name">useOpenGL</span> <span class="operator">=</span> <span class="name">chartView</span>.<span class="name">openGL</span>
      } <span class="keyword">else</span> {
          var <span class="name">series1</span> = <span class="name">chartView</span>.<span class="name">createSeries</span>(<span class="name">ChartView</span>.<span class="name">SeriesTypeScatter</span>, <span class="string">&quot;signal 1&quot;</span>,
                                               <span class="name">axisX</span>, <span class="name">axisY1</span>);
          <span class="name">series1</span>.<span class="name">markerSize</span> <span class="operator">=</span> <span class="number">2</span>;
          <span class="name">series1</span>.<span class="name">borderColor</span> <span class="operator">=</span> <span class="string">&quot;transparent&quot;</span>;
          <span class="name">series1</span>.<span class="name">useOpenGL</span> <span class="operator">=</span> <span class="name">chartView</span>.<span class="name">openGL</span>

          var <span class="name">series2</span> = <span class="name">chartView</span>.<span class="name">createSeries</span>(<span class="name">ChartView</span>.<span class="name">SeriesTypeScatter</span>, <span class="string">&quot;signal 2&quot;</span>,
                                               <span class="name">axisX</span>, <span class="name">axisY2</span>);
          <span class="name">series2</span>.<span class="name">markerSize</span> <span class="operator">=</span> <span class="number">2</span>;
          <span class="name">series2</span>.<span class="name">borderColor</span> <span class="operator">=</span> <span class="string">&quot;transparent&quot;</span>;
          <span class="name">series2</span>.<span class="name">useOpenGL</span> <span class="operator">=</span> <span class="name">chartView</span>.<span class="name">openGL</span>
      }
  }

  <span class="keyword">function</span> <span class="name">createAxis</span>(<span class="name">min</span>, max) {
      <span class="comment">// The following creates a ValueAxis object that can be then set as a x or y axis for a series</span>
      <span class="keyword">return</span> <span class="name">Qt</span>.<span class="name">createQmlObject</span>(<span class="string">&quot;import QtQuick 2.0; import QtCharts 2.0; ValueAxis { min: &quot;</span>
                                <span class="operator">+</span> <span class="name">min</span> <span class="operator">+</span> <span class="string">&quot;; max: &quot;</span> <span class="operator">+</span> <span class="name">max</span> <span class="operator">+</span> <span class="string">&quot; }&quot;</span>, <span class="name">chartView</span>);
  }

</pre>
<p>Files:</p>
<ul>
<li><a href="qtcharts-qmloscilloscope-datasource-cpp.html">qmloscilloscope/datasource.cpp</a></li>
<li><a href="qtcharts-qmloscilloscope-datasource-h.html">qmloscilloscope/datasource.h</a></li>
<li><a href="qtcharts-qmloscilloscope-qml-qmloscilloscope-controlpanel-qml.html">qmloscilloscope/qml/qmloscilloscope/ControlPanel.qml</a></li>
<li><a href="qtcharts-qmloscilloscope-qml-qmloscilloscope-multibutton-qml.html">qmloscilloscope/qml/qmloscilloscope/MultiButton.qml</a></li>
<li><a href="qtcharts-qmloscilloscope-qml-qmloscilloscope-scopeview-qml.html">qmloscilloscope/qml/qmloscilloscope/ScopeView.qml</a></li>
<li><a href="qtcharts-qmloscilloscope-qml-qmloscilloscope-main-qml.html">qmloscilloscope/qml/qmloscilloscope/main.qml</a></li>
<li><a href="qtcharts-qmloscilloscope-main-cpp.html">qmloscilloscope/main.cpp</a></li>
<li><a href="qtcharts-qmloscilloscope-qmloscilloscope-pro.html">qmloscilloscope/qmloscilloscope.pro</a></li>
<li><a href="qtcharts-qmloscilloscope-resources-qrc.html">qmloscilloscope/resources.qrc</a></li>
</ul>
</div>
<!-- @@@qmloscilloscope -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>