<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlogvalue3daxisformatter.cpp -->
<title>QLogValue3DAxisFormatter Class | Qt Data Visualization 5.12.6</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.12</td><td ><a href="qtdatavisualization-index.html">Qt Data Visualization</a></td><td ><a href="qtdatavisualization-module.html">C++ Classes</a></td><td >QLogValue3DAxisFormatter</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtdatavisualization-index.html">Qt Data Visualization | Commercial or GPLv3</a></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="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QLogValue3DAxisFormatter Class</h1>
<!-- $$$QLogValue3DAxisFormatter-brief -->
<p>The <a href="qlogvalue3daxisformatter.html">QLogValue3DAxisFormatter</a> class provides formatting rules for a logarithmic value axis. <a href="#details">More...</a></p>
<!-- @@@QLogValue3DAxisFormatter -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QLogValue3DAxisFormatter></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> QtDataVisualization 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtdatavisualization-logvalueaxis3dformatter.html">LogValueAxis3DFormatter</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qvalue3daxisformatter.html">QValue3DAxisFormatter</a></td></tr></table></div><ul>
<li><a href="qlogvalue3daxisformatter-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="qlogvalue3daxisformatter.html#autoSubGrid-prop">autoSubGrid</a></b> : bool</li>
<li class="fn"><b><a href="qlogvalue3daxisformatter.html#base-prop">base</a></b> : qreal</li>
<li class="fn"><b><a href="qlogvalue3daxisformatter.html#showEdgeLabels-prop">showEdgeLabels</a></b> : bool</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="qlogvalue3daxisformatter.html#QLogValue3DAxisFormatter">QLogValue3DAxisFormatter</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#dtor.QLogValue3DAxisFormatter">~QLogValue3DAxisFormatter</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#autoSubGrid-prop">autoSubGrid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#base-prop">base</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#autoSubGrid-prop">setAutoSubGrid</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#base-prop">setBase</a></b>(qreal <i>base</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#showEdgeLabels-prop">setShowEdgeLabels</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#showEdgeLabels-prop">showEdgeLabels</a></b>() const</td></tr>
</table></div>
<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="qlogvalue3daxisformatter.html#autoSubGrid-prop">autoSubGridChanged</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#base-prop">baseChanged</a></b>(qreal <i>base</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#showEdgeLabels-prop">showEdgeLabelsChanged</a></b>(bool <i>enabled</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qlogvalue3daxisformatter.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">18 protected functions inherited from <a href="qvalue3daxisformatter.html#protected-functions">QValue3DAxisFormatter</a></li>
</ul>
<a name="details"></a>
<!-- $$$QLogValue3DAxisFormatter-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qlogvalue3daxisformatter.html">QLogValue3DAxisFormatter</a> class provides formatting rules for a logarithmic value axis.</p>
<p>When a formatter is attached to a value axis, the axis range cannot include negative values or the zero.</p>
</div>
<p><b>See also </b><a href="qvalue3daxisformatter.html">QValue3DAxisFormatter</a>.</p>
<!-- @@@QLogValue3DAxisFormatter -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$autoSubGrid-prop$$$autoSubGrid$$$setAutoSubGridbool$$$autoSubGridChangedbool -->
<h3 class="fn" id="autoSubGrid-prop"><a name="autoSubGrid-prop"></a><span class="name">autoSubGrid</span> : <span class="type">bool</span></h3>
<p>This property holds whether sub-grid positions are generated automatically.</p>
<p>If this property value is set to <code>true</code>, the parent axis sub-segment count is ignored when calculating sub-grid line positions. The sub-grid positions are generated automatically according to the <a href="qlogvalue3daxisformatter.html#base-prop">base</a> property value. The number of sub-grid lines is set to the base value minus one, rounded down. This property is ignored when the base value is zero. Defaults to <code>true</code>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>autoSubGrid</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAutoSubGrid</b></span>(bool <i>enabled</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>autoSubGridChanged</b></span>(bool <i>enabled</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qlogvalue3daxisformatter.html#base-prop">base</a> and <a href="qvalue3daxis.html#subSegmentCount-prop">QValue3DAxis::subSegmentCount</a>.</p>
<!-- @@@autoSubGrid -->
<!-- $$$base-prop$$$base$$$setBaseqreal$$$baseChangedqreal -->
<h3 class="fn" id="base-prop"><a name="base-prop"></a><span class="name">base</span> : <span class="type">qreal</span></h3>
<p>This property holds the base of the logarithm used to map axis values.</p>
<p>If the base is non-zero, the parent axis segment count will be ignored when the grid line and label positions are calculated. If you want the range to be divided into equal segments like a normal value axis, set this property value to zero.</p>
<p>The base has to be zero or a positive value and it cannot be equal to one. Defaults to ten.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>base</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBase</b></span>(qreal <i>base</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>baseChanged</b></span>(qreal <i>base</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qvalue3daxis.html#segmentCount-prop">QValue3DAxis::segmentCount</a>.</p>
<!-- @@@base -->
<!-- $$$showEdgeLabels-prop$$$showEdgeLabels$$$setShowEdgeLabelsbool$$$showEdgeLabelsChangedbool -->
<h3 class="fn" id="showEdgeLabels-prop"><a name="showEdgeLabels-prop"></a><span class="name">showEdgeLabels</span> : <span class="type">bool</span></h3>
<p>This property holds whether the first and last label on the axis are visible.</p>
<p>When the <a href="qlogvalue3daxisformatter.html#base-prop">base</a> property value is non-zero, the whole axis range is often not equally divided into segments. The first and last segments are often smaller than the other segments. In extreme cases, this can lead to overlapping labels on the first and last two grid lines. By setting this property to <code>false</code>, you can suppress showing the minimum and maximum labels for the axis in cases where the segments do not exactly fit the axis. Defaults to <code>true</code>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>showEdgeLabels</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setShowEdgeLabels</b></span>(bool <i>enabled</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>showEdgeLabelsChanged</b></span>(bool <i>enabled</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qlogvalue3daxisformatter.html#base-prop">base</a> and <a href="qabstract3daxis.html#labels-prop">QAbstract3DAxis::labels</a>.</p>
<!-- @@@showEdgeLabels -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLogValue3DAxisFormatter[overload1]$$$QLogValue3DAxisFormatterQObject* -->
<h3 class="fn" id="QLogValue3DAxisFormatter"><a name="QLogValue3DAxisFormatter"></a>QLogValue3DAxisFormatter::<span class="name">QLogValue3DAxisFormatter</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new logarithmic value 3D axis formatter with the optional parent <i>parent</i>.</p>
<!-- @@@QLogValue3DAxisFormatter -->
<!-- $$$~QLogValue3DAxisFormatter[overload1]$$$~QLogValue3DAxisFormatter -->
<h3 class="fn" id="dtor.QLogValue3DAxisFormatter"><a name="dtor.QLogValue3DAxisFormatter"></a><code>[virtual] </code>QLogValue3DAxisFormatter::<span class="name">~QLogValue3DAxisFormatter</span>()</h3>
<p>Deletes the logarithmic value 3D axis formatter.</p>
<!-- @@@~QLogValue3DAxisFormatter -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 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>
