Q3DGraphsWidgetItem Class

Property Documentation

activeTheme : QGraphsTheme*

This property holds the active theme of the graph.

Sets activeTheme as the active theme to be used for the graph. Implicitly calls addTheme() to transfer the ownership of the theme to this graph.

If activeTheme is null, a temporary default theme is created. This temporary theme is destroyed if any theme is explicitly set later. Properties of the theme can be modified even after setting it, and the modifications take effect immediately.

Access functions:

Notifier signal:

ambientLightStrength : float

This property holds the ambient light strength for the whole graph.

This value determines how evenly and brightly the colors are shown throughout the graph regardless of the light position.

The value must be between 0.0f and 1.0f.

Access functions:

Notifier signal:

aspectRatio : qreal

This property holds the ratio of the graph scaling between the longest axis on the horizontal plane and the y-axis.

Defaults to 2.0.

Access functions:

Notifier signal:

See also horizontalAspectRatio.

cameraTargetPosition : QVector3D

This property holds the camera target position as a vector or vertex in the 3D space.

Defaults to QVector3D(0.0, 0.0, 0.0).

Valid coordinate values are between -1.0...1.0, where the edge values indicate the edges of the corresponding axis range. Any values outside this range are clamped to the edge.

Access functions:

Notifier signal:

cameraXRotation : float

This property holds the X-rotation angle of the camera around the target point in degrees.

Access functions:

Notifier signal:

cameraYRotation : float

This property holds the Y-rotation angle of the camera around the target point in degrees.

Access functions:

Notifier signal:

cameraZoomLevel : float

This property holds the camera zoom level in percentage.

The default value of 100.0f means there is no zoom in or out set in the camera. The value is limited by the minCameraZoomLevel and maxCameraZoomLevel properties.

Access functions:

Notifier signal:

See also minCameraZoomLevel and maxCameraZoomLevel.

[read-only] currentFps : const int

This property holds the rendering results for the last second.

The results are stored in this read-only property when FPS measuring is enabled. It takes at least a second before this value is updated after measuring is activated.

Access functions:

Notifier signal:

See also measureFps.

gridLineType : QtGraphs3D::GridLineType

This property holds whether the grid lines type is QtGraphs3D::GridLineType::Shader or QtGraphs3D::GridLineType::Geometry.

This value affects all grid lines.

Access functions:

Notifier signal:

See also QtGraphs3D::GridLineType.

horizontalAspectRatio : qreal

This property holds the ratio of the graph scaling between the x-axis and z-axis.

The value of 0.0 indicates automatic scaling according to axis ranges. Defaults to 0.0.

Has no effect on Q3DBarsWidgetItem, which handles scaling on the horizontal plane via the barThickness and barSpacing properties. Polar graphs also ignore this property.

Access functions:

Notifier signal:

See also aspectRatio, polar, Q3DBarsWidgetItem::barThickness, and Q3DBarsWidgetItem::barSpacing.

labelMargin : float

This property specifies the margin for the placement of the axis labels.

Negative values place the labels inside the plot-area while positive values place them outside the plot-area. Label automatic rotation is disabled when the value is negative. Defaults to 0.1

Access functions:

Notifier signal:

See also QAbstract3DAxis::labelAutoAngle.

lightColor : QColor

This property holds the color for the ambient and specular light.

This value affects the light specified in Q3DScene.

Access functions:

Notifier signal:

lightStrength : float

This property holds the specular light strength for the whole graph.

The value must be between 0.0f and 10.0f.

This value affects the light specified in Q3DScene.

Access functions:

Notifier signal:

locale : QLocale

This property holds the locale used for formatting various numeric labels.

Defaults to the "C" locale.

Access functions:

Notifier signal:

See also QValue3DAxis::labelFormat.

margin : qreal

This property holds the absolute value used for the space left between the edge of the plottable graph area and the edge of the graph background.

If the margin value is negative, the margins are determined automatically and can vary according to the size of the items in the series and the type of the graph. The value is interpreted as a fraction of the y-axis range if the graph aspect ratios have not been changed from the default values. Defaults to -1.0.

Access functions:

Notifier signal:

maxCameraXRotation : float

This property holds the maximum X-rotation angle of the camera around the target point in degrees. The default value is 180.0

Access functions:

Notifier signal:

maxCameraYRotation : float

This property holds the maximum Y-rotation angle of the camera around the target point in degrees. The default value is 90.0

Access functions:

Notifier signal:

maxCameraZoomLevel : float

This property holds the maximum allowed camera zoom level.

If the maximum level is set to a new value that is lower than the existing minimum level, the minimum level is adjusted to the new maximum as well. If the current cameraZoomLevel is outside the new bounds, it is adjusted as well. Defaults to 500.0f.

Access functions:

Notifier signal:

See also cameraZoomLevel and minCameraZoomLevel.

measureFps : bool

This property holds whether rendering is done continuously instead of on demand.

If true, rendering is continuous and the value of the currentFps property is updated. Defaults to false.

Access functions:

Notifier signal:

See also currentFps.

minCameraXRotation : float

This property holds the minimum X-rotation angle of the camera around the target point in degrees. The default value is -180.0

Access functions:

Notifier signal:

minCameraYRotation : float

This property holds the minimum Y-rotation angle of the camera around the target point in degrees. The default value is 0.0

Access functions:

Notifier signal:

minCameraZoomLevel : float

This property holds the minimum allowed camera zoom level.

If the minimum level is set to a new value that is higher than the existing maximum level, the maximum level is adjusted to the new minimum as well. If the current zoomLevel is outside the new bounds, it is adjusted as well. The minCameraZoomLevel cannot be set below 1.0f. Defaults to 10.0f.

Access functions:

Notifier signal:

See also cameraZoomLevel and maxCameraZoomLevel.

msaaSamples : int

This property holds the number of used samples in MSAA.

Sets the number of used MSAA samples to samples. The number of samples can be either 0, 2, 4, or 8.

Access functions:

Notifier signal:

optimizationHint : QtGraphs3D::OptimizationHint

Specifies whether the default or legacy mode is used for rendering optimization.

The default mode uses instanced rendering, and provides the full feature set at the best level of performance on most systems. The static mode optimizes graph rendering and is ideal for large non-changing data sets. It is slower with dynamic data changes and item rotations. Selection is not optimized, so using the static mode with massive data sets is not advisable. Static optimization works only on scatter graphs. Legacy mode renders all items in th graph individually, without instancing. It should be used only if default mode does not work, i.e. if the target system does not support instancing. Defaults to QtGraphs3D::OptimizationHint::Default.

Access functions:

Notifier signal:

See also QAbstract3DSeries::mesh.

orthoProjection : bool

This property holds whether orthographic projection is used for displaying the graph.

Defaults to false.

Access functions:

Notifier signal:

See also QAbstract3DAxis::labelAutoAngle.

polar : bool

This property holds whether horizontal axes are changed into polar axes.

If true, the x-axis becomes the angular axis and the z-axis becomes the radial axis. Polar mode is not available for bar graphs.

Defaults to false.

Access functions:

Notifier signal:

See also orthoProjection and radialLabelOffset.

[read-only] queriedGraphPosition : const QVector3D

This property holds the latest queried graph position values along each axis.

This read-only property contains the results from Q3DScene::graphPositionQuery. The values are normalized to the range [-1, 1]. If the queried position was outside the graph bounds, the values will not reflect the real position, but will instead indicate an undefined position outside the range [-1, 1]. The value will be undefined until a query is made.

There is no single correct 3D coordinate to match a particular screen position, so to be consistent, the queries are always done against the inner sides of an invisible box surrounding the graph.

Access functions:

Notifier signal:

See also Q3DScene::graphPositionQuery.

radialLabelOffset : float

This property holds the normalized horizontal offset for the axis labels of the radial polar axis.

The value 0.0 indicates that the labels should be drawn next to the 0-angle angular axis grid line. The value 1.0 indicates that the labels are drawn in their usual place at the edge of the graph background. Defaults to 1.0.

This property is ignored if the polar property value is false.

Access functions:

Notifier signal:

See also polar.

rotationEnabled : bool

This property holds whether this input handler allows graph rotation.

Defaults to true.

Access functions:

Notifier signal:

[read-only] scene : Q3DScene* const

This property holds the Q3DScene pointer that can be used to manipulate the scene and access the scene elements.

This property is read-only.

Access functions:

[read-only] selectedElement : const QtGraphs3D::ElementType

This property holds the element selected in the graph.

This property can be used to query the selected element type. The type is valid until a new selection is made in the graph and the selectedElementChanged signal is emitted.

The signal can be used for example for implementing custom input handlers, as demonstrated in the Graph Gallery example under Scatter Graph tab.

Access functions:

Notifier signal:

See also selectedLabelIndex(), selectedAxis(), selectedCustomItemIndex(), selectedCustomItem(), Q3DBarsWidgetItem::selectedSeries(), Q3DScatterWidgetItem::selectedSeries(), Q3DSurfaceWidgetItem::selectedSeries(), and Q3DScene::setSelectionQueryPosition().

selectionEnabled : bool

This property holds whether this input handler allows selection from the graph.

Defaults to true.

Access functions:

Notifier signal:

selectionMode : QtGraphs3D::SelectionFlags

Item selection mode.

A combination of SelectionFlags. By default, Item. Different graph types support different selection modes.

Access functions:

Notifier signal:

See also QtGraphs3D::SelectionFlags.

shadowQuality : QtGraphs3D::ShadowQuality

This property holds the quality of the shadow.

One of the ShadowQuality enum values. By default, Medium.

Access functions:

Notifier signal:

See also QtGraphs3D::ShadowQuality.

shadowStrength : float

This property holds the shadow strength for the whole graph.

The higher the number, the darker the shadows will be. The value must be between 0.0 and 100.0.

This value affects the light specified in Q3DScene.

Access functions:

Notifier signal:

wrapCameraXRotation : bool

This property holds the behavior of the minimum and maximum limits in the X-rotation.

If set to true, the X-rotation of the camera is wrapped from minimum to maximum and from maximum to minimum. If set to false, the X-rotation of the camera is limited to the sector determined by the minimum and maximum values. Set to true by default.

Access functions:

Notifier signal:

wrapCameraYRotation : bool

This property holds the behavior of the minimum and maximum limits in the Y-rotation.

If true, the Y-rotation of the camera is wrapped from minimum to maximum and from maximum to minimum. If false, the Y-rotation of the camera is limited to the sector determined by the minimum and maximum values. Set to true by default.

Access functions:

Notifier signal:

zoomAtTargetEnabled : bool

This property holds whether zooming should change the camera target so that the zoomed point of the graph stays at the same location after the zoom.

Defaults to true.

Access functions:

Notifier signal:

zoomEnabled : bool

This property holds whether this input handler allows graph zooming.

Defaults to true.

Access functions:

Notifier signal:

QQuickWidget quickwidget;
Q3DBarsWidgetItem graph;
graph.setWidget(&quickwidget);