Surface3D QML Type

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.0 and 1.0.

The ratio of the graph scaling between the longest axis on the horizontal plane and the y-axis. Defaults to 2.0.

See also horizontalAspectRatio.

The active x-axis.

If an axis is not given, a temporary default axis with no labels and an automatically adjusting range is created. This temporary axis is destroyed if another axis is explicitly set to the same orientation.

The active y-axis.

If an axis is not given, a temporary default axis with no labels and an automatically adjusting range is created. This temporary axis is destroyed if another axis is explicitly set to the same orientation.

The active z-axis.

If an axis is not given, a temporary default axis with no labels and an automatically adjusting range is created. This temporary axis is destroyed if another axis is explicitly set to the same orientation.

The currently active camera preset, which is one of Graphs3D.CameraPreset. If no preset is active, the value is Graphs3D.CameraPreset.NoPreset.

The camera target as a vector3d. Defaults to vector3d(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.

The X-rotation angle of the camera around the target point in degrees starting from the current base position.

The Y-rotation angle of the camera around the target point in degrees starting from the current base position.

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

See also minCameraZoomLevel and maxCameraZoomLevel.

When FPS measuring is enabled, the results for the last second are stored in this read-only property. It takes at least a second before this value updates after measuring is activated.

See also measureFps.

The list of Custom3DItem items added to the graph. The graph takes ownership of the added items.

In some use cases the horizontal axis grid is mostly covered by the surface, so it can be more useful to display the horizontal axis grid on top of the graph rather than on the bottom. A typical use case for this is showing 2D spectrograms using orthoGraphic projection with a top-down viewpoint.

If false, the horizontal axis grid and labels are drawn on the horizontal background of the graph. If true, the horizontal axis grid and labels are drawn on the opposite side of the graph from the horizontal background. Defaults to false.

Defines whether the grid lines type is Graphs3D.GridLineType.Shader or Graphs3D.GridLineType.Geometry.

This value affects all grid lines.

See also Graphs3D.GridLineType.

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.

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

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

See also QAbstract3DAxis::labelAutoAngle.

The color of the ambient and specular light defined in Scene3D.

The specular light strength for the whole graph. The value must be between 0.0 and 10.0.

This value affects the light specified in Scene3D.

Sets the locale used for formatting various numeric labels. Defaults to the "C" locale.

See also Value3DAxis::labelFormat.

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.

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

This property was introduced in Qt 6.9.

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

This property was introduced in Qt 6.9.

Sets the maximum allowed camera zoom level. If the new maximum level 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.

See also cameraZoomLevel and minCameraZoomLevel.

If true, the rendering is done continuously instead of on demand, and the value of the currentFps property is updated. Defaults to false.

See also currentFps.

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

This property was introduced in Qt 6.9.

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

This property was introduced in Qt 6.9.

Sets the minimum allowed camera zoom level. If the new minimum level is higher than the existing maximum level, the maximum level is adjusted to the new minimum as well. If the current cameraZoomLevel is outside the new bounds, it is adjusted as well. The minCameraZoomLevel cannot be set below 1.0. Defaults to 10.0.

See also cameraZoomLevel and maxCameraZoomLevel.

The number of samples used in multisample antialiasing when renderingMode is Indirect. When renderingMode is DirectToBackground, this property value is read-only and returns the number of samples specified by the window surface format. Defaults to 4.

See also renderingMode.

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. Legacy mode renders all items in th graph individually, without instancing. It should be used only if default mode does not work, that is the same as if the target system does not support instancing. Defaults to Default.

See also Abstract3DSeries::mesh and Graphs3D.OptimizationHint.

If true, orthographic projection will be used for displaying the graph. Defaults to false.

If true, the horizontal axes are changed into polar axes. 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.

See also orthoProjection and radialLabelOffset.

This read-only property contains the latest graph position values along each axis queried using Scene3D::graphPositionQuery. The values are normalized to range [-1, 1]. If the queried position was outside the graph bounds, the values will not reflect the real position, but will instead be some 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.

See also Scene3D::graphPositionQuery.

This property specifies 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. This property is ignored if the polar property value is false. Defaults to 1.0.

See also polar.

How the graph will be rendered. Defaults to Indirect.

See also msaaSamples and Graphs3D.RenderingMode.

Returns a pointer to the root node of the 3D graph. Use this property for injecting a 3D graph into a separate View3D using importScene:

Bars3D {
  id: bars
}
View3D {
  importScene: bars.rootNode
}

This property was introduced in Qt 6.9.

See also View3D.

Whether this input handler allows graph rotation.

Defaults to true.

The Scene3D pointer that can be used to manipulate the scene and access the scene elements.

This property is read-only.

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 customized input handling, as demonstrated by the Axis Handling example.

See also selectedLabelIndex(), selectedAxis(), selectedCustomItemIndex(), selectedCustomItem(), Bars3D::selectedSeries, Scatter3D::selectedSeries, Scene3D::selectionQueryPosition, and Graphs3D.ElementType.

The selected series or null. If selectionMode has the MultiSeries flag set, this property holds the series which owns the selected point.

Whether this input handler allows selection from the graph.

Defaults to true.

The active selection mode in the graph. One of the Graphs3D.SelectionFlag enum values.

This property holds the series of the graph. By default, this property contains an empty list. To set the series, either use the addSeries() function or define them as children of the graph.

The quality of shadows. One of the Graphs3D.ShadowQuality enum values.

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 Scene3D.

The active theme of the graph.

See also GraphsTheme.

Specifies which transparency technique to use. The Default value is Default. When rendering transparent surface graphs, use Approximate or Accurate.

This property was introduced in Qt 6.9.

The behavior of the minimum and maximum limits in the X-rotation. By default, the X-rotation wraps from minimum value to maximum and from maximum to minimum.

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.

The behavior of the minimum and maximum limits in the Y-rotation. By default, the Y-rotation is limited between the minimum and maximum values without any wrapping.

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.

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.

Whether this input handler allows graph zooming.

Defaults to true.

This signal is emitted when axisX changes to axis.

This signal is emitted when axisY changes to axis.

This signal is emitted when axisZ changes to axis.

This signal is emitted when the graph item is tapped twice within a short span of time. The eventPoint signal parameter contains information from the release event about the point that was tapped, and button is the mouse button that was clicked, or NoButton on a touchscreen.

See also QEventPoint, Qt::MouseButtons, and TapHandler::doubleTapped.

This signal is emitted when the translation of the cluster of points on the graph is changed while the pinch gesture is being performed. The delta vector gives the change in translation.

See also PinchHandler::translationChanged.

This signal is emitted when flipHorizontalGrid changes to flip.

This signal is emitted when the parent Item is pressed and held for a time period greater than TapHandler::longPressThreshold.

See also TapHandler::longPressed.

This signal is emitted when the graph receives a mouseMove event. mousePos value gives the position of mouse while mouse is moving.

See also QQuickItem::mouseMoveEvent.

This signal is emitted when the scale factor on the graph changes while the pinch gesture is being performed. The delta value gives the multiplicative change in scale.

See also PinchHandler::scaleChanged.

This signal is emitted when selectedSeries changes to series.

This signal is emitted when the graph item is tapped once. The eventPoint signal parameter contains information from the release event about the point that was tapped, and button is the mouse button that was clicked, or NoButton on a touchscreen.

See also QEventPoint, Qt::MouseButtons, and TapHandler::singleTapped.

This signal is emitted every time the graph receives an event of type QWheelEvent: that is, every time the wheel is moved or the scrolling gesture is updated.

See also WheelEvent and WheelHandler::wheel.

Adds a Custom3DItem item to the graph. Graph takes ownership of the added item.

Returns index to the added item if add was successful, -1 if trying to add a null item, and index of the item if trying to add an already added item.

See also removeCustomItems(), removeCustomItem(), and removeCustomItemAt().

Adds the series to the graph.

See also GraphsItem3D::hasSeries().

Clears selection from all attached series.

Performs picking using view coordinates from point on the elements of the graph, selecting the first item hit. Default input handling performs this upon receiving the onTapped event.

See also selectedElement.

Performs picking starting from origin and in direction on the elements of the graph, selecting the first item hit.

See also selectedElement.

Returns whether the series has already been added to the graph.

Gets ownership of item back and removes the item from the graph.

See also Custom3DItem::textureFile.

Gets ownership of item back and removes the item from the graph.

See also Custom3DItem::textureFile.

Removes the custom item. Deletes the resources allocated to it.

Removes all custom items at position. Deletes the resources allocated to them.

Removes all custom items. Deletes the resources allocated to them.

Removes the series from the graph.

See also GraphsItem3D::hasSeries().

Can be used to get the selected axis after receiving selectedElementChanged signal with any label type. Selection is valid until the next selectedElementChanged signal.

Returns the selected axis, or null.

See also selectedElement.

Can be used to get the selected custom item after receiving selectedElementChanged signal with ElementType.CustomItem type. Ownership of the item remains with the graph. Selection is valid until the next selectedElementChanged signal.

Returns the selected custom item, or null.

See also selectedElement.

Can be used to query the index of the selected custom item after receiving selectedElementChanged signal with ElementType.CustomItem type. Selection is valid until the next selectedElementChanged signal.

Returns index of the selected custom item, or -1.

See also selectedElement.

Can be used to query the index of the selected label after receiving selectedElementChanged signal with any label type. Selection is valid until the next selectedElementChanged signal.

Returns index of the selected label, or -1.

See also selectedElement.