Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > 19952c5e751bf7e3108c3c59625b0f35 > files > 130

qtcharts5-doc-5.9.4-1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdatetimeaxis.cpp -->
  <title>QDateTimeAxis Class | 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="qt-charts-module.html">C++ Classes</a></td><td >QDateTimeAxis</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QDateTimeAxis Class</h1>
<!-- $$$QDateTimeAxis-brief -->
<p>The <a href="qdatetimeaxis.html">QDateTimeAxis</a> class adds dates and times to a chart's axis. <a href="#details">More...</a></p>
<!-- @@@QDateTimeAxis -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QDateTimeAxis&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtcharts-datetimeaxis.html">DateTimeAxis</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qabstractaxis.html">QAbstractAxis</a></td></tr></table></div><ul>
<li><a href="qdatetimeaxis-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><a href="qdatetimeaxis.html#format-prop">format</a></b> : QString</li>
<li class="fn"><b><a href="qdatetimeaxis.html#max-prop">max</a></b> : QDateTime</li>
<li class="fn"><b><a href="qdatetimeaxis.html#min-prop">min</a></b> : QDateTime</li>
<li class="fn"><b><a href="qdatetimeaxis.html#tickCount-prop">tickCount</a></b> : int</li>
</ul>
<ul>
<li class="fn">27 properties inherited from <a href="qabstractaxis.html#properties">QAbstractAxis</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#QDateTimeAxis">QDateTimeAxis</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#dtor.QDateTimeAxis">~QDateTimeAxis</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#format-prop">format</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDateTime </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#max-prop">max</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDateTime </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#min-prop">min</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#format-prop">setFormat</a></b>(QString <i>format</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#max-prop">setMax</a></b>(QDateTime <i>max</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#min-prop">setMin</a></b>(QDateTime <i>min</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#setRange">setRange</a></b>(QDateTime <i>min</i>, QDateTime <i>max</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#setTickCount">setTickCount</a></b>(int <i>count</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#tickCount">tickCount</a></b>() const</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual AxisType </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#type">type</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">58 public functions inherited from <a href="qabstractaxis.html#public-functions">QAbstractAxis</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#formatChanged">formatChanged</a></b>(QString <i>format</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#maxChanged">maxChanged</a></b>(QDateTime <i>max</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#minChanged">minChanged</a></b>(QDateTime <i>min</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#rangeChanged">rangeChanged</a></b>(QDateTime <i>min</i>, QDateTime <i>max</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdatetimeaxis.html#tickCountChanged">tickCountChanged</a></b>(int <i>tickCount</i>)</td></tr>
</table></div>
<ul>
<li class="fn">25 signals inherited from <a href="qabstractaxis.html#signals">QAbstractAxis</a></li>
</ul>
<a name="details"></a>
<!-- $$$QDateTimeAxis-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qdatetimeaxis.html">QDateTimeAxis</a> class adds dates and times to a chart's axis.</p>
<p><a href="qdatetimeaxis.html">QDateTimeAxis</a> can be set up to show an axis line with tick marks, grid lines, and shades. The labels can be configured by setting an appropriate DateTime format. <a href="qdatetimeaxis.html">QDateTimeAxis</a> works correctly with dates from 4714 BCE to 287396 CE. For other limitiations related to QDateTime, see QDateTime documentation.</p>
<p><b>Note: </b><a href="qdatetimeaxis.html">QDateTimeAxis</a> is disabled on platforms that define qreal as float.</p><p class="centerAlign"><img src="images/api_datatime_axis.png" alt="" /></p><p><a href="qdatetimeaxis.html">QDateTimeAxis</a> can be used with any <a href="qxyseries.html">QXYSeries</a>. To add a data point to the series, QDateTime::toMSecsSinceEpoch() is used:</p>
<pre class="cpp">

  <span class="type"><a href="qlineseries.html">QLineSeries</a></span> <span class="operator">*</span>series <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qlineseries.html">QLineSeries</a></span>;

  <span class="type">QDateTime</span> xValue;
  xValue<span class="operator">.</span>setDate(<span class="type">QDate</span>(<span class="number">2012</span><span class="operator">,</span> <span class="number">1</span> <span class="operator">,</span> <span class="number">18</span>));
  xValue<span class="operator">.</span>setTime(<span class="type">QTime</span>(<span class="number">9</span><span class="operator">,</span> <span class="number">34</span>));
  <span class="type">qreal</span> yValue <span class="operator">=</span> <span class="number">12</span>;
  series<span class="operator">-</span><span class="operator">&gt;</span>append(xValue<span class="operator">.</span>toMSecsSinceEpoch()<span class="operator">,</span> yValue);

  xValue<span class="operator">.</span>setDate(<span class="type">QDate</span>(<span class="number">2013</span><span class="operator">,</span> <span class="number">5</span> <span class="operator">,</span> <span class="number">11</span>));
  xValue<span class="operator">.</span>setTime(<span class="type">QTime</span>(<span class="number">11</span><span class="operator">,</span> <span class="number">14</span>));
  <span class="type">qreal</span> yValue <span class="operator">=</span> <span class="number">22</span>;
  series<span class="operator">-</span><span class="operator">&gt;</span>append(xValue<span class="operator">.</span>toMSecsSinceEpoch()<span class="operator">,</span> yValue);

</pre>
<p>The following code snippet illustrates adding the series to the chart and setting up <a href="qdatetimeaxis.html">QDateTimeAxis</a>:</p>
<pre class="cpp">

  <span class="type"><a href="qchartview.html">QChartView</a></span> <span class="operator">*</span>chartView <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qchartview.html">QChartView</a></span>;
  chartView<span class="operator">-</span><span class="operator">&gt;</span>chart()<span class="operator">-</span><span class="operator">&gt;</span>addSeries(series);

  <span class="comment">// ...</span>
  <span class="type"><a href="qdatetimeaxis.html#QDateTimeAxis">QDateTimeAxis</a></span> <span class="operator">*</span>axisX <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qdatetimeaxis.html#QDateTimeAxis">QDateTimeAxis</a></span>;
  axisX<span class="operator">-</span><span class="operator">&gt;</span>setFormat(<span class="string">&quot;dd-MM-yyyy h:mm&quot;</span>);
  chartView<span class="operator">-</span><span class="operator">&gt;</span>chart()<span class="operator">-</span><span class="operator">&gt;</span>setAxisX(axisX<span class="operator">,</span> series);

</pre>
</div>
<!-- @@@QDateTimeAxis -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$format-prop$$$format$$$setFormatQString$$$formatChangedQString -->
<h3 class="fn" id="format-prop"><a name="format-prop"></a><span class="name">format</span> : <span class="type">QString</span></h3>
<p>This property holds the format string that is used when creating the label for the axis out of a QDateTime object.</p>
<p>See QDateTime documentation for information on how the string should be defined.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>format</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFormat</b></span>(QString <i>format</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qdatetimeaxis.html#formatChanged">formatChanged</a></b></span>(QString <i>format</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qchart.html#locale-prop">QChart::locale</a>.</p>
<!-- @@@format -->
<!-- $$$max-prop$$$max$$$setMaxQDateTime$$$maxChangedQDateTime -->
<h3 class="fn" id="max-prop"><a name="max-prop"></a><span class="name">max</span> : <span class="type">QDateTime</span></h3>
<p>This property holds the maximum value on the axis.</p>
<p>When setting this property, the minimum value is adjusted if necessary, to ensure that the range remains valid.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QDateTime </td><td class="memItemRight bottomAlign"><span class="name"><b>max</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMax</b></span>(QDateTime <i>max</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qdatetimeaxis.html#maxChanged">maxChanged</a></b></span>(QDateTime <i>max</i>)</td></tr>
</table></div>
<!-- @@@max -->
<!-- $$$min-prop$$$min$$$setMinQDateTime$$$minChangedQDateTime -->
<h3 class="fn" id="min-prop"><a name="min-prop"></a><span class="name">min</span> : <span class="type">QDateTime</span></h3>
<p>This property holds the minimum value on the axis.</p>
<p>When setting this property, the maximum value is adjusted if necessary, to ensure that the range remains valid.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QDateTime </td><td class="memItemRight bottomAlign"><span class="name"><b>min</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMin</b></span>(QDateTime <i>min</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qdatetimeaxis.html#minChanged">minChanged</a></b></span>(QDateTime <i>min</i>)</td></tr>
</table></div>
<!-- @@@min -->
<!-- $$$tickCount-prop$$$tickCount$$$setTickCountint$$$tickCountChangedint -->
<h3 class="fn" id="tickCount-prop"><a name="tickCount-prop"></a><span class="name">tickCount</span> : <span class="type">int</span></h3>
<p>This property holds the number of tick marks on the axis.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qdatetimeaxis.html#tickCount">tickCount</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qdatetimeaxis.html#setTickCount">setTickCount</a></b></span>(int <i>count</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qdatetimeaxis.html#tickCountChanged">tickCountChanged</a></b></span>(int <i>tickCount</i>)</td></tr>
</table></div>
<!-- @@@tickCount -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDateTimeAxis[overload1]$$$QDateTimeAxisQObject* -->
<h3 class="fn" id="QDateTimeAxis"><a name="QDateTimeAxis"></a>QDateTimeAxis::<span class="name">QDateTimeAxis</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs an axis object that is a child of <i>parent</i>.</p>
<!-- @@@QDateTimeAxis -->
<!-- $$$~QDateTimeAxis[overload1]$$$~QDateTimeAxis -->
<h3 class="fn" id="dtor.QDateTimeAxis"><a name="dtor.QDateTimeAxis"></a>QDateTimeAxis::<span class="name">~QDateTimeAxis</span>()</h3>
<p>Destroys the object.</p>
<!-- @@@~QDateTimeAxis -->
<!-- $$$formatChanged -->
<h3 class="fn" id="formatChanged"><a name="formatChanged"></a><code>[signal] </code><span class="type">void</span> QDateTimeAxis::<span class="name">formatChanged</span>(<span class="type">QString</span> <i>format</i>)</h3>
<p>This signal is emitted when the <i>format</i> of the axis changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qdatetimeaxis.html#format-prop">format</a>. </p><!-- @@@formatChanged -->
<!-- $$$maxChanged -->
<h3 class="fn" id="maxChanged"><a name="maxChanged"></a><code>[signal] </code><span class="type">void</span> QDateTimeAxis::<span class="name">maxChanged</span>(<span class="type">QDateTime</span> <i>max</i>)</h3>
<p>This signal is emitted when the maximum value of the axis, specified by <i>max</i>, changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qdatetimeaxis.html#max-prop">max</a>. </p><!-- @@@maxChanged -->
<!-- $$$minChanged -->
<h3 class="fn" id="minChanged"><a name="minChanged"></a><code>[signal] </code><span class="type">void</span> QDateTimeAxis::<span class="name">minChanged</span>(<span class="type">QDateTime</span> <i>min</i>)</h3>
<p>This signal is emitted when the minimum value of the axis, specified by <i>min</i>, changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qdatetimeaxis.html#min-prop">min</a>. </p><!-- @@@minChanged -->
<!-- $$$rangeChanged[overload1]$$$rangeChangedQDateTimeQDateTime -->
<h3 class="fn" id="rangeChanged"><a name="rangeChanged"></a><code>[signal] </code><span class="type">void</span> QDateTimeAxis::<span class="name">rangeChanged</span>(<span class="type">QDateTime</span> <i>min</i>, <span class="type">QDateTime</span> <i>max</i>)</h3>
<p>This signal is emitted when the minimum or maximum value of the axis, specified by <i>min</i> and <i>max</i>, changes.</p>
<!-- @@@rangeChanged -->
<!-- $$$setRange[overload1]$$$setRangeQDateTimeQDateTime -->
<h3 class="fn" id="setRange"><a name="setRange"></a><span class="type">void</span> QDateTimeAxis::<span class="name">setRange</span>(<span class="type">QDateTime</span> <i>min</i>, <span class="type">QDateTime</span> <i>max</i>)</h3>
<p>Sets the range on the axis from <i>min</i> to <i>max</i>. If <i>min</i> is greater than <i>max</i>, this function returns without making any changes.</p>
<!-- @@@setRange -->
<!-- $$$setTickCount -->
<h3 class="fn" id="setTickCount"><a name="setTickCount"></a><span class="type">void</span> QDateTimeAxis::<span class="name">setTickCount</span>(<span class="type">int</span> <i>count</i>)</h3>
<p>Sets the number of tick marks on the axis to <i>count</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qdatetimeaxis.html#tickCount-prop">tickCount</a>. </p><p><b>See also </b><a href="qdatetimeaxis.html#tickCount">tickCount</a>().</p>
<!-- @@@setTickCount -->
<!-- $$$tickCount -->
<h3 class="fn" id="tickCount"><a name="tickCount"></a><span class="type">int</span> QDateTimeAxis::<span class="name">tickCount</span>() const</h3>
<p>Returns the number of tick marks on the axis.</p>
<p><b>Note:</b> Getter function for property <a href="qdatetimeaxis.html#tickCount-prop">tickCount</a>. </p><p><b>See also </b><a href="qdatetimeaxis.html#setTickCount">setTickCount</a>().</p>
<!-- @@@tickCount -->
<!-- $$$tickCountChanged -->
<h3 class="fn" id="tickCountChanged"><a name="tickCountChanged"></a><code>[signal] </code><span class="type">void</span> QDateTimeAxis::<span class="name">tickCountChanged</span>(<span class="type">int</span> <i>tickCount</i>)</h3>
<p>This signal is emitted when the number of tick marks on the axis, specified by <i>tickCount</i>, changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qdatetimeaxis.html#tickCount-prop">tickCount</a>. </p><!-- @@@tickCountChanged -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn" id="type"><a name="type"></a><code>[virtual] </code><span class="type"><a href="qabstractaxis.html#AxisType-enum">AxisType</a></span> QDateTimeAxis::<span class="name">type</span>() const</h3>
<p>Reimplemented from <a href="qabstractaxis.html#type">QAbstractAxis::type</a>().</p>
<p>Returns the type of the axis.</p>
<!-- @@@type -->
</div>
        </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>