162 lines
8.0 KiB
HTML
162 lines
8.0 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" />
|
|
<!-- utils.js -->
|
|
<title>UtilsJS 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>UtilsJS 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-utilsjs.html#methods">Methods</a></li>
|
|
<li class="level1"><a href="qml-csdataquick-components-utilsjs.html#details">Detailed Description</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sidebar-content" id="sidebar-content"></div></div>
|
|
<div class="context">
|
|
<h1 class="title">UtilsJS QML Type</h1>
|
|
<span class="subtitle"></span>
|
|
<!-- $$$UtilsJS-brief -->
|
|
<p>Javascript Utility Functions. <a href="qml-csdataquick-components-utilsjs.html#details">More...</a></p>
|
|
<!-- @@@UtilsJS -->
|
|
<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></table></div><ul>
|
|
<li><a href="qml-csdataquick-components-utilsjs-members.html">List of all members, including inherited members</a></li>
|
|
</ul>
|
|
<a name="methods"></a>
|
|
<h2 id="methods">Methods</h2>
|
|
<ul>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-utilsjs.html#dumpCSData-method">dumpCSData</a></b></b>(<i>data</i>)</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-utilsjs.html#formatString-method">formatString</a></b></b>(<i>value</i>, <i>format</i>, <i>type</i>, <i>precision</i>, <i>states</i>)</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-utilsjs.html#getBestFontSize-method">getBestFontSize</a></b></b>(<i>item_height</i>, <i>with_frame</i>)</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-utilsjs.html#popupDataLimitsDialog-method">popupDataLimitsDialog</a></b></b>(<i>parent</i>)</li>
|
|
<li class="fn"><b><b><a href="qml-csdataquick-components-utilsjs.html#popupPromptDialog-method">popupPromptDialog</a></b></b>(<i>parent</i>, <i>title</i>, <i>hint</i>, <i>input</i>)</li>
|
|
</ul>
|
|
<!-- $$$UtilsJS-description -->
|
|
<a name="details"></a>
|
|
<h2 id="details">Detailed Description</h2>
|
|
<!-- @@@UtilsJS -->
|
|
<h2>Method Documentation</h2>
|
|
<!-- $$$dumpCSData -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="dumpCSData-method">
|
|
<td class="tblQmlFuncNode"><p>
|
|
<a name="dumpCSData-method"></a><span class="name">dumpCSData</span>(<i>data</i>)</p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This function returns a printable string representation of the <i>data</i> object.</p>
|
|
</div></div><!-- @@@dumpCSData -->
|
|
<br/>
|
|
<!-- $$$formatString -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="formatString-method">
|
|
<td class="tblQmlFuncNode"><p>
|
|
<a name="formatString-method"></a><span class="name">formatString</span>(<i>value</i>, <i>format</i>, <i>type</i>, <i>precision</i>, <i>states</i>)</p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>Format the value based on data type.</p>
|
|
<div class="table"><table class="generic">
|
|
<thead><tr class="qt-style"><th >type</th><th >output</th></tr></thead>
|
|
<tr valign="top" class="odd"><td >Enum</td><td >string at the <i>value</i> index from the <i>states</i> list.</td></tr>
|
|
<tr valign="top" class="even"><td >String</td><td >as it is.</td></tr>
|
|
<tr valign="top" class="odd"><td >Char</td><td >string by joinning the char array with ending null character removed.</td></tr>
|
|
<tr valign="top" class="even"><td >Number</td><td >string determined by <i>format</i> and <i>precision</i>.</td></tr>
|
|
</table></div>
|
|
<p><b>See also </b><a href="qml-csdataquick-components-utils.html#convert-method">Utils::convert</a>.</p>
|
|
</div></div><!-- @@@formatString -->
|
|
<br/>
|
|
<!-- $$$getBestFontSize -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="getBestFontSize-method">
|
|
<td class="tblQmlFuncNode"><p>
|
|
<a name="getBestFontSize-method"></a><span class="name">getBestFontSize</span>(<i>item_height</i>, <i>with_frame</i>)</p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>Calculates the font size/family based on item height.</p>
|
|
<p>This function uses an imperically determined (item height, font size) table. Actually two sets of tables are defined. One for items without enclosing frame, e.g. <a href="qml-csdataquick-components-cstext.html">CSText</a>. One for items with a border frame, e.g. <a href="qml-csdataquick-components-cstextentry.html">CSTextEntry</a>. The reason for this manual tweak is to match MEDM displays.</p>
|
|
<p>The font family is either <i>Dejavu Sans Mono</i> for font size less than 20 or <i>Helvetica</i> otherwise.</p>
|
|
</div></div><!-- @@@getBestFontSize -->
|
|
<br/>
|
|
<!-- $$$popupDataLimitsDialog -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="popupDataLimitsDialog-method">
|
|
<td class="tblQmlFuncNode"><p>
|
|
<a name="popupDataLimitsDialog-method"></a><span class="name">popupDataLimitsDialog</span>(<i>parent</i>)</p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This function popups up a dialog for user to configure the limits settings.</p>
|
|
</div></div><!-- @@@popupDataLimitsDialog -->
|
|
<br/>
|
|
<!-- $$$popupPromptDialog -->
|
|
<div class="qmlitem"><div class="qmlproto">
|
|
<div class="table"><table class="qmlname">
|
|
<tr valign="top" class="odd" id="popupPromptDialog-method">
|
|
<td class="tblQmlFuncNode"><p>
|
|
<a name="popupPromptDialog-method"></a><span class="name">popupPromptDialog</span>(<i>parent</i>, <i>title</i>, <i>hint</i>, <i>input</i>)</p></td></tr>
|
|
</table></div>
|
|
</div><div class="qmldoc"><p>This function popups a dialog to obtains user's input.</p>
|
|
</div></div><!-- @@@popupPromptDialog -->
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">Copyright (C) 2012-2021 Xiaoqiang Wang, Paul Scherrer Institute.</div>
|
|
</body>
|
|
</html>
|