<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcustom3dlabel.cpp -->
<title>Custom3DLabel QML Type | 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-qmlmodule.html">QML Types</a></td><td >Custom3DLabel QML Type</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Custom3DLabel QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Custom3DLabel-brief -->
<p>Adds a custom label to a graph. <a href="#details">More...</a></p>
<!-- @@@Custom3DLabel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtDataVisualization 1.2</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"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qtdatavisualization-custom3dlabel.html"><a href="qcustom3dlabel.html">QCustom3DLabel</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtdatavisualization-custom3ditem.html">Custom3DItem</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtdatavisualization-custom3dlabel-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-qtdatavisualization-custom3dlabel.html#backgroundColor-prop">backgroundColor</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dlabel.html#backgroundEnabled-prop">backgroundEnabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dlabel.html#borderEnabled-prop">borderEnabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dlabel.html#facingCamera-prop">facingCamera</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dlabel.html#font-prop">font</a></b></b> : font</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dlabel.html#text-prop">text</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dlabel.html#textColor-prop">textColor</a></b></b> : color</li>
</ul>
<!-- $$$Custom3DLabel-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The text, font, position, scaling, rotation, and colors of a custom label can be set. In addition, the visibility of the borders and background of the label can be toggled. Colors, borders, and background are determined by the active theme unless set explicitly.</p>
<p><b>Note: </b>In scaling, the z-coordinate has no effect. Setting the same x- and y-coordinates retains the original font dimensions.</p><!-- @@@Custom3DLabel -->
<h2>Property Documentation</h2>
<!-- $$$backgroundColor -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="backgroundColor-prop">
<td class="tblQmlPropNode"><p>
<a name="backgroundColor-prop"></a><span class="name">backgroundColor</span> : <span class="type">color</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The color for the label background, if enabled. Defaults to <code>"gray"</code>.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dlabel.html#backgroundEnabled-prop">backgroundEnabled</a>.</p>
</div></div><!-- @@@backgroundColor -->
<br/>
<!-- $$$backgroundEnabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="backgroundEnabled-prop">
<td class="tblQmlPropNode"><p>
<a name="backgroundEnabled-prop"></a><span class="name">backgroundEnabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Defines whether the label background is enabled. If set to <code>false</code>, <a href="qml-qtdatavisualization-custom3dlabel.html#backgroundColor-prop">backgroundColor</a> has no effect. Defaults to <code>true</code>.</p>
</div></div><!-- @@@backgroundEnabled -->
<br/>
<!-- $$$borderEnabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="borderEnabled-prop">
<td class="tblQmlPropNode"><p>
<a name="borderEnabled-prop"></a><span class="name">borderEnabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Defines whether label borders are enabled. Defaults to <code>true</code>.</p>
</div></div><!-- @@@borderEnabled -->
<br/>
<!-- $$$facingCamera -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="facingCamera-prop">
<td class="tblQmlPropNode"><p>
<a name="facingCamera-prop"></a><span class="name">facingCamera</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Defines whether the label will always face the camera. Defaults to <code>false</code>. If set to <code>true</code>, <a href="qcustom3ditem.html#rotation-prop">rotation</a> has no effect.</p>
</div></div><!-- @@@facingCamera -->
<br/>
<!-- $$$font -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="font-prop">
<td class="tblQmlPropNode"><p>
<a name="font-prop"></a><span class="name">font</span> : <span class="type">font</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The font to be used for the label. Defaults to <code>Font {family: "Arial"; pointSize: 20}</code>. Special formatting (for example, outlined) is not supported.</p>
</div></div><!-- @@@font -->
<br/>
<!-- $$$text -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="text-prop">
<td class="tblQmlPropNode"><p>
<a name="text-prop"></a><span class="name">text</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The text for the label. Rich text is not supported.</p>
</div></div><!-- @@@text -->
<br/>
<!-- $$$textColor -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="textColor-prop">
<td class="tblQmlPropNode"><p>
<a name="textColor-prop"></a><span class="name">textColor</span> : <span class="type">color</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The color for the label text. Also affects label border, if enabled. Defaults to <code>"white"</code>.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dlabel.html#borderEnabled-prop">borderEnabled</a>.</p>
</div></div><!-- @@@textColor -->
<br/>
</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>
