204 lines
9.5 KiB
HTML
204 lines
9.5 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<!-- CSStripChart.qml -->
|
|
<title>CSStripChart QML Type | CSDataQuick Documentation 1.2</title>
|
|
<link rel="stylesheet" type="text/css" href="style/online.css" />
|
|
<script type="text/javascript">
|
|
(function (i, s, o, g, r, a, m) {
|
|
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
|
|
(i[r].q = i[r].q || []).push(arguments)
|
|
}, i[r].l = 1 * new Date(); a = s.createElement(o),
|
|
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
|
|
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
|
|
|
|
ga('create', 'UA-24645639-4', 'qt.io');
|
|
ga('set', 'forceSSL', true);
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div class="header" id="header">
|
|
<header id="navbar" class="">
|
|
</header>
|
|
</div>
|
|
<div class="main">
|
|
<div class="main-rounded">
|
|
<div class="navigationbar">
|
|
<ul class="sub-navigation">
|
|
<li><a href="../../CSDataQuick.html">Home</a></li>
|
|
<li><a href="../docs.html" class="active">Documentation</a></li>
|
|
<li><a href="http://github.com/xiaoqiangwang/CSDataQuick/">Code</a></li>
|
|
<li><a href="https://github.com/xiaoqiangwang/CSDataQuick/issues/">Bug Reports</a></li>
|
|
</ul>
|
|
<div id="main_title_bar">
|
|
<h1>CSDataQuick Documentation</h1>
|
|
<div class="search_bar">
|
|
<script>
|
|
(function() {
|
|
var cx = '001693341472456439948:u9v0snkru3q';
|
|
var gcse = document.createElement('script');
|
|
gcse.type = 'text/javascript';
|
|
gcse.async = true;
|
|
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + '//www.google.com/cse/cse.js?cx=' + cx;
|
|
var s = document.getElementsByTagName('script')[0];
|
|
s.parentNode.insertBefore(gcse, s);
|
|
})();
|
|
</script>
|
|
<gcse:searchbox-only resultsUrl="search-results.html"></gcse:searchbox-only>
|
|
</div></div>
|
|
<ul>
|
|
<li><a href="index.html">CSDataQuick Documentation</a></li>
|
|
<li><a href="csdataquick-qmlmodules.html">QML Types</a></li>
|
|
<li>CSStripChart QML Type</li>
|
|
</ul>
|
|
</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="qml-csdataquick-components-csstripchart.html#properties">Properties</a></li>
|
|
<li class="level1"><a href="qml-csdataquick-components-csstripchart.html#details">Detailed Description</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sidebar-content" id="sidebar-content"></div></div>
|
|
<div class="context">
|
|
<h1 class="title">CSStripChart QML Type</h1>
|
|
<span class="subtitle"></span>
|
|
<!-- $$$CSStripChart-brief -->
|
|
<p>Display a strip chart. <a href="qml-csdataquick-components-csstripchart.html#details">More...</a></p>
|
|
<!-- @@@CSStripChart -->
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import CSDataQuick.Components 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-csdataquick-components-baseitem.html">BaseItem</a></p>
|
|
</td></tr></table></div><ul>
|
|
<li><a href="qml-csdataquick-components-csstripchart-members.html">List of all members, including inherited members</a></li>
|
|
</ul>
|
|
<a name="properties"></a>
|
|
<h2 id="properties">Properties</h2>
|
|
<ul>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-csstripchart.html#legendVisible-prop">legendVisible</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-csstripchart.html#model-prop">model</a></b></b> : var</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-csstripchart.html#period-prop">period</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-csstripchart.html#title-prop">title</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-csstripchart.html#units-prop">units</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-csstripchart.html#xLabel-prop">xLabel</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-csstripchart.html#yLabel-prop">yLabel</a></b></b> : string</li>
|
|
</ul>
|
|
<!-- $$$CSStripChart-description -->
|
|
<a name="details"></a>
|
|
<h2 id="details">Detailed Description</h2>
|
|
<p>A strip chart acquires the data and updates the plot in fixed period. <a href="qml-csdataquick-components-csstripchart.html#period-prop">period</a> and <a href="qml-csdataquick-components-csstripchart.html#units-prop">units</a> together define the time span.</p>
|
|
<pre class="qml"><span class="type"><a href="qml-csdataquick-components-csstripchart.html">CSStripChart</a></span> {
|
|
<span class="name">model</span>: <span class="name">ListModel</span> {
|
|
<span class="type"><a href="http://doc.qt.io/qt-5/qml-qtqml-models-listelement.html">ListElement</a></span> {
|
|
<span class="name">channel</span>: <span class="string">'catest'</span>
|
|
<span class="name">color</span>: <span class="string">'red'</span>
|
|
}
|
|
<span class="type"><a href="http://doc.qt.io/qt-5/qml-qtqml-models-listelement.html">ListElement</a></span> {
|
|
<span class="name">channel</span>: <span class="string">'catest2'</span>
|
|
<span class="name">color</span>: <span class="string">'blue'</span>
|
|
}
|
|
}
|
|
}</pre>
|
|
<p class="centerAlign"><img src="images/stripchart.png" alt="" /></p><!-- @@@CSStripChart -->
|
|
<h2>Property Documentation</h2>
|
|
<!-- $$$legendVisible -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="legendVisible-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="legendVisible-prop"></a><span class="name">legendVisible</span> : <span class="type">bool</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property indicates whether the legend is visible.</p>
|
|
</div></div><!-- @@@legendVisible -->
|
|
<br/>
|
|
<!-- $$$model -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="model-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="model-prop"></a><span class="name">model</span> : <span class="type"><a href="http://doc.qt.io/qt-5/qml-var.html">var</a></span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the data list model.</p>
|
|
<p>The model can be <a href="http://doc.qt.io/qt-5/qml-qtqml-models-listmodel.html">ListModel</a> or JSON object array. In any case, each element contains the following properties,</p>
|
|
<ul>
|
|
<li>channel - the data source to monitor.</li>
|
|
<li>label - the descriptive text.</li>
|
|
<li>color - the color of the line for that channel,</li>
|
|
<li>loprSrc - the lower range source.</li>
|
|
<li>loprDefault - the default lower range.</li>
|
|
<li>hoprSrc - the upper range source.</li>
|
|
<li>hoprDefault - the default upper range.</li>
|
|
</ul>
|
|
<p><i>Note: Only in the form of JSON object array, it can be used in Qt Quick Designer</i></p>
|
|
</div></div><!-- @@@model -->
|
|
<br/>
|
|
<!-- $$$period -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="period-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="period-prop"></a><span class="name">period</span> : <span class="type">int</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the period of time between updates</p>
|
|
</div></div><!-- @@@period -->
|
|
<br/>
|
|
<!-- $$$title -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="title-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="title-prop"></a><span class="name">title</span> : <span class="type">string</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the title of the plot, displayed on top.</p>
|
|
</div></div><!-- @@@title -->
|
|
<br/>
|
|
<!-- $$$units -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="units-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="units-prop"></a><span class="name">units</span> : <span class="type">int</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the time axis units.</p>
|
|
<ul>
|
|
<li>TimeUnit.MilliSecond</li>
|
|
<li>TimeUnit.Second</li>
|
|
<li>TimeUnit.Minute</li>
|
|
</ul>
|
|
</div></div><!-- @@@units -->
|
|
<br/>
|
|
<!-- $$$xLabel -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="xLabel-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="xLabel-prop"></a><span class="name">xLabel</span> : <span class="type">string</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the lable of x axis, shown below the axis.</p>
|
|
</div></div><!-- @@@xLabel -->
|
|
<br/>
|
|
<!-- $$$yLabel -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="yLabel-prop">
|
|
<td class="tblQmlPropNode"><p>
|
|
<a name="yLabel-prop"></a><span class="name">yLabel</span> : <span class="type">string</span></p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This property holds the label of y axis, show next to the axis.</p>
|
|
</div></div><!-- @@@yLabel -->
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">Copyright (C) 2012-2021 Xiaoqiang Wang, Paul Scherrer Institute.</div>
|
|
</body>
|
|
</html>
|