- Qt 6.12
- Qt Graphs
- QML Types
- QtGraphs
- Spline3DSeries
- Qt Graphs | Commercial or GPLv3

# Spline3DSeries QML Type (Uncreatable)

Represents a data series in a 3D spline graph. More...

Import Statement: | `import QtGraphs`
Since: | Qt 6.9
In C++: | QSpline3DSeries
Inherits: | Scatter3DSeries

Note: This is an uncreatable type. It cannot be instantiated in QML.

- List of all members, including inherited members
- Spline3DSeries is part of Qt Graphs QML Types for 3D.

## Properties

- baseColor : color
- baseGradient : Gradient
- colorStyle : GraphsTheme.ColorStyle
- itemLabel : string
- itemLabelFormat : string
- itemLabelVisible : bool
- lightingMode : Abstract3DSeries.LightingMode `(since 6.10)`
- mesh : Abstract3DSeries.Mesh
- meshRotation : quaternion
- meshSmooth : bool
- multiHighlightColor : color
- multiHighlightGradient : Gradient
- name : string
- singleHighlightColor : color
- singleHighlightGradient : Gradient
- splineColor : color
- splineKnotting : real
- splineLooping : bool
- splineResolution : int
- splineTension : real
- splineVisible : bool
- type : Abstract3DSeries.SeriesType
- userDefinedMesh : string
- visible : bool

## Signals

- baseColorChanged(color color)
- baseGradientChanged(Gradient gradient)
- colorStyleChanged(GraphsTheme.ColorStyle style)
- itemLabelChanged(string label)
- itemLabelFormatChanged(string format)
- itemLabelVisibilityChanged(bool visible)
- lightingModeChanged(Abstract3DSeries.LightingMode lightingMode) `(since 6.10)`
- meshChanged(Abstract3DSeries.Mesh mesh)
- meshRotationChanged(quaternion rotation)
- meshSmoothChanged(bool enabled)
- multiHighlightColorChanged(color color)
- multiHighlightGradientChanged(Gradient gradient)
- nameChanged(string name)
- singleHighlightColorChanged(color color)
- singleHighlightGradientChanged(Gradient gradient)
- userDefinedMeshChanged(string fileName)
- visibilityChanged(bool visible)

## Methods

- void setMeshAxisAndAngle(vector3d axis, real angle)

## Detailed Description

Spline graphs are used to show information as a series of data points connected by a curved or straight Catmull-Rom spline.

This type manages the spline specific visual elements.

## Property Documentation

### baseColor : color

The base color of the series.

See also colorStyle and GraphsTheme.seriesColors.

### baseGradient : Gradient

The base gradient of the series.

See also colorStyle.

### colorStyle : GraphsTheme.ColorStyle

The color style for the series.

See also GraphsTheme.ColorStyle.

### itemLabel : string `[read-only]`

The formatted item label. If there is no selected item or the selected item is not visible, returns an empty string.

See also itemLabelFormat.

### itemLabelFormat : string

The label format for data items in this series. This format is used for single item labels, for example, when an item is selected. How the format is interpreted depends on series type.

See also Bar3DSeries, Scatter3DSeries, and Surface3DSeries.

### itemLabelVisible : bool

If `true`, item labels are drawn as floating labels in the graph. Otherwise, item labels are not drawn. To show the item label in an external control, this property is set to `false`. Defaults to `true`.

See also itemLabelFormat and itemLabel.

### lightingMode : Abstract3DSeries.LightingMode `[since 6.10]`

The lighting mode of the items in the series. The default value is QAbstract3DSeries::LightingMode::Shaded

This property was introduced in Qt 6.10.

See also QAbstract3DSeries::LightingMode.

### mesh : Abstract3DSeries.Mesh

The mesh of the items in the series, or the selection pointer in case of Surface3DSeries. If the mesh is Abstract3DSeries.Mesh.UserDefined, then the userDefinedMesh property must also be set for items to render properly. The default value depends on the graph type.

See also QAbstract3DSeries::Mesh.

### meshRotation : quaternion

The mesh rotation that is applied to all items of the series. The rotation should be a normalized quaternion. For those series types that support item specific rotation, the rotations are multiplied together. Bar3DSeries ignores any rotation that is not around the y-axis. Surface3DSeries applies the rotation only to the selection pointer. Defaults to no rotation.

### meshSmooth : bool

If `true`, smooth versions of predefined meshes set via the mesh property are used. This property does not affect custom meshes used when the mesh is set to Abstract3DSeries.Mesh.UserDefined. Defaults to `false`.

### multiHighlightColor : color

The multiple item highlight color of the series.

See also colorStyle and GraphsTheme.multiHighlightColor.

### multiHighlightGradient : Gradient

The multiple item highlight gradient of the series.

See also colorStyle and GraphsTheme.multiHighlightGradient.

### name : string

The series name. It can be used in item label format with the tag `@seriesName`.

See also itemLabelFormat.

### singleHighlightColor : color

The single item highlight color of the series.

See also colorStyle and GraphsTheme.singleHighlightColor.

### singleHighlightGradient : Gradient

The single item highlight gradient of the series.

See also colorStyle and GraphsTheme.singleHighlightGradient.

### splineColor : color

The color of the spline.

### splineKnotting : real

The knot parametrization of the spline.

This parameter can change the profile of the curve. The spline is classified as a uniform Catmull-Rom spline at a value of `0.0`, a centripetal Catmull-Rom spline at a value of `0.5`, and a chordal Catmull-Rom spline at a value of `1.0`.

The value must be between `0.0` and `1.0`. The default value is `0.5`.

### splineLooping : bool

Determines whether the spline loops.

This adds a spline segment between the first and last points of the series connecting the spline into a loop.

The default value is `false`

### splineResolution : int

The resolution of the segments spline.

The number of vertices per spline segment, which is defined as the part between two points.

Must be a value above `2`. The default value is `10`.

### splineTension : real

The tension of the spline.

The spline uses maximum curvature for segments at a value of `0.0` Segments are completely straight at a value of `1.0` Must be between `0.0` and `1.0` The default value is `0.0`

### splineVisible : bool

Visibility of the spline. The default value is `true`.

### type : Abstract3DSeries.SeriesType `[read-only]`

The type of the series. One of the QAbstract3DSeries::SeriesType values.

### userDefinedMesh : string

The filename for a user defined custom mesh for objects that is used when mesh is Abstract3DSeries.Mesh.UserDefined.

Note: The file needs to be in the QtQuick3D mesh format. Use the `balsam` conversion tool to create a mesh from other 3D model formats.

### visible : bool

The visibility of the series. If `false`, the series is not rendered.

## Signal Documentation

### baseColorChanged(color color)

This signal is emitted when baseColor changes to color.

Note: The corresponding handler is `onBaseColorChanged`.

### baseGradientChanged(Gradient gradient)

This signal is emitted when baseGradient changes to gradient.

Note: The corresponding handler is `onBaseGradientChanged`.

### colorStyleChanged(GraphsTheme.ColorStyle style)

This signal is emitted when colorStyle changes to style.

Note: The corresponding handler is `onColorStyleChanged`.

### itemLabelChanged(string label)

This signal is emitted when itemLabel changes to label.

Note: The corresponding handler is `onItemLabelChanged`.

### itemLabelFormatChanged(string format)

This signal is emitted when itemLabelFormat changes to format.

Note: The corresponding handler is `onItemLabelFormatChanged`.

### itemLabelVisibilityChanged(bool visible)

This signal is emitted when itemLabelVisibility changes to visible.

Note: The corresponding handler is `onItemLabelVisibilityChanged`.

### `[since 6.10]` lightingModeChanged(Abstract3DSeries.LightingMode lightingMode)

This signal is emitted when lightingMode changes to lightingMode.

Note: The corresponding handler is `onLightingModeChanged`.

This signal was introduced in Qt 6.10.

### meshChanged(Abstract3DSeries.Mesh mesh)

This signal is emitted when mesh changes to mesh.

Note: The corresponding handler is `onMeshChanged`.

### meshRotationChanged(quaternion rotation)

This signal is emitted when meshRotation changes to rotation.

Note: The corresponding handler is `onMeshRotationChanged`.

### meshSmoothChanged(bool enabled)

This signal is emitted when meshSmooth changes to enabled.

Note: The corresponding handler is `onMeshSmoothChanged`.

### multiHighlightColorChanged(color color)

This signal is emitted when multiHighlightColor changes to color.

Note: The corresponding handler is `onMultiHighlightColorChanged`.

### multiHighlightGradientChanged(Gradient gradient)

This signal is emitted when multiHighlightGradient changes to gradient.

Note: The corresponding handler is `onMultiHighlightGradientChanged`.

### nameChanged(string name)

This signal is emitted when name changes to name.

Note: The corresponding handler is `onNameChanged`.

### singleHighlightColorChanged(color color)

This signal is emitted when singleHighlightColor changes to color.

Note: The corresponding handler is `onSingleHighlightColorChanged`.

### singleHighlightGradientChanged(Gradient gradient)

This signal is emitted when singleHighlightGradient changes to gradient.

Note: The corresponding handler is `onSingleHighlightGradientChanged`.

### userDefinedMeshChanged(string fileName)

This signal is emitted when userDefinedMesh changes to fileName.

Note: The corresponding handler is `onUserDefinedMeshChanged`.

### visibilityChanged(bool visible)

This signal is emitted when the series visibility changes to visible.

Note: The corresponding handler is `onVisibilityChanged`.

## Method Documentation

### void setMeshAxisAndAngle(vector3d axis, real angle)

A convenience function to construct a mesh rotation quaternion from axis and angle.

See also meshRotation.