QAbstract3DSeries#

The QAbstract3DSeries class is a base class for all data series. More

Inherited by: QSurface3DSeries, QScatter3DSeries, QBar3DSeries

Synopsis#

Functions#

Signals#

Detailed Description#

There are inherited classes for each supported series type: QBar3DSeries , QScatter3DSeries , and QSurface3DSeries .

For more information, see Qt Data Visualization Data Handling .

class PySide6.QtDataVisualization.QAbstract3DSeries#
PySide6.QtDataVisualization.QAbstract3DSeries.SeriesType#

Type of the series.

Constant

Description

QAbstract3DSeries.SeriesTypeNone

No series type.

QAbstract3DSeries.SeriesTypeBar

Series type for Q3DBars .

QAbstract3DSeries.SeriesTypeScatter

Series type for Q3DScatter .

QAbstract3DSeries.SeriesTypeSurface

Series type for Q3DSurface .

PySide6.QtDataVisualization.QAbstract3DSeries.Mesh#

Predefined mesh types. All styles are not usable with all visualization types.

Constant

Description

QAbstract3DSeries.MeshUserDefined

User defined mesh, set via userDefinedMesh property.

QAbstract3DSeries.MeshBar

Basic rectangular bar.

QAbstract3DSeries.MeshCube

Basic cube.

QAbstract3DSeries.MeshPyramid

Four-sided pyramid.

QAbstract3DSeries.MeshCone

Basic cone.

QAbstract3DSeries.MeshCylinder

Basic cylinder.

QAbstract3DSeries.MeshBevelBar

Slightly beveled (rounded) rectangular bar.

QAbstract3DSeries.MeshBevelCube

Slightly beveled (rounded) cube.

QAbstract3DSeries.MeshSphere

Sphere.

QAbstract3DSeries.MeshMinimal

The minimal 3D mesh: a triangular pyramid. Usable only with Q3DScatter .

QAbstract3DSeries.MeshArrow

Arrow pointing upwards.

QAbstract3DSeries.MeshPoint

2D point. Usable only with Q3DScatter . Shadows do not affect this style. Color style ColorStyleObjectGradient is not supported by this style.

PySide6.QtDataVisualization.QAbstract3DSeries.baseColor()#
Return type

PySide6.QtGui.QColor

This property holds The base color of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.baseColorChanged(color)#
Parameters

colorPySide6.QtGui.QColor

PySide6.QtDataVisualization.QAbstract3DSeries.baseGradient()#
Return type

PySide6.QtGui.QLinearGradient

This property holds The base gradient of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.baseGradientChanged(gradient)#
Parameters

gradientPySide6.QtGui.QLinearGradient

PySide6.QtDataVisualization.QAbstract3DSeries.colorStyle()#
Return type

ColorStyle

This property holds The color style for the series..

See also

ColorStyle

PySide6.QtDataVisualization.QAbstract3DSeries.colorStyleChanged(style)#
Parameters

styleColorStyle

PySide6.QtDataVisualization.QAbstract3DSeries.isItemLabelVisible()#
Return type

bool

This property holds The visibility of item labels in the graph..

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.

PySide6.QtDataVisualization.QAbstract3DSeries.isMeshSmooth()#
Return type

bool

This property holds Whether smooth versions of predefined meshes are used..

If true, smooth versions set via the mesh property are used. This property does not affect custom meshes used when the mesh is set to MeshUserDefined . Defaults to false.

PySide6.QtDataVisualization.QAbstract3DSeries.isVisible()#
Return type

bool

This property holds The visibility of the series..

If this property is false, the series is not rendered. Defaults to true.

PySide6.QtDataVisualization.QAbstract3DSeries.itemLabel()#
Return type

str

This property holds The formatted item label..

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

See also

itemLabelFormat

PySide6.QtDataVisualization.QAbstract3DSeries.itemLabelChanged(label)#
Parameters

label – str

PySide6.QtDataVisualization.QAbstract3DSeries.itemLabelFormat()#
Return type

str

This property holds 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: QBar3DSeries , QScatter3DSeries , QSurface3DSeries .

PySide6.QtDataVisualization.QAbstract3DSeries.itemLabelFormatChanged(format)#
Parameters

format – str

PySide6.QtDataVisualization.QAbstract3DSeries.itemLabelVisibilityChanged(visible)#
Parameters

visible – bool

PySide6.QtDataVisualization.QAbstract3DSeries.mesh()#
Return type

Mesh

This property holds The mesh of the items in the series..

For QSurface3DSeries , this property holds the selection pointer.

If the mesh is MeshUserDefined , then the userDefinedMesh property must also be set for items to render properly. The default value depends on the graph type.

PySide6.QtDataVisualization.QAbstract3DSeries.meshChanged(mesh)#
Parameters

meshMesh

PySide6.QtDataVisualization.QAbstract3DSeries.meshRotation()#
Return type

PySide6.QtGui.QQuaternion

This property holds The mesh rotation that is applied to all items of the series..

The rotation should be a normalized QQuaternion . For those series types that support item specific rotation, the rotations are multiplied together. QBar3DSeries ignores any rotation that is not around the y-axis. QSurface3DSeries applies the rotation only to the selection pointer. Defaults to no rotation.

PySide6.QtDataVisualization.QAbstract3DSeries.meshRotationChanged(rotation)#
Parameters

rotationPySide6.QtGui.QQuaternion

PySide6.QtDataVisualization.QAbstract3DSeries.meshSmoothChanged(enabled)#
Parameters

enabled – bool

PySide6.QtDataVisualization.QAbstract3DSeries.multiHighlightColor()#
Return type

PySide6.QtGui.QColor

This property holds The multiple item highlight color of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.multiHighlightColorChanged(color)#
Parameters

colorPySide6.QtGui.QColor

PySide6.QtDataVisualization.QAbstract3DSeries.multiHighlightGradient()#
Return type

PySide6.QtGui.QLinearGradient

This property holds The multiple item highlight gradient of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.multiHighlightGradientChanged(gradient)#
Parameters

gradientPySide6.QtGui.QLinearGradient

PySide6.QtDataVisualization.QAbstract3DSeries.name()#
Return type

str

This property holds The series name..

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

See also

itemLabelFormat

PySide6.QtDataVisualization.QAbstract3DSeries.nameChanged(name)#
Parameters

name – str

PySide6.QtDataVisualization.QAbstract3DSeries.setBaseColor(color)#
Parameters

colorPySide6.QtGui.QColor

This property holds The base color of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.setBaseGradient(gradient)#
Parameters

gradientPySide6.QtGui.QLinearGradient

This property holds The base gradient of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.setColorStyle(style)#
Parameters

styleColorStyle

This property holds The color style for the series..

See also

ColorStyle

PySide6.QtDataVisualization.QAbstract3DSeries.setItemLabelFormat(format)#
Parameters

format – str

This property holds 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: QBar3DSeries , QScatter3DSeries , QSurface3DSeries .

PySide6.QtDataVisualization.QAbstract3DSeries.setItemLabelVisible(visible)#
Parameters

visible – bool

This property holds The visibility of item labels in the graph..

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.

PySide6.QtDataVisualization.QAbstract3DSeries.setMesh(mesh)#
Parameters

meshMesh

This property holds The mesh of the items in the series..

For QSurface3DSeries , this property holds the selection pointer.

If the mesh is MeshUserDefined , then the userDefinedMesh property must also be set for items to render properly. The default value depends on the graph type.

PySide6.QtDataVisualization.QAbstract3DSeries.setMeshAxisAndAngle(axis, angle)#
Parameters

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

See also

meshRotation

PySide6.QtDataVisualization.QAbstract3DSeries.setMeshRotation(rotation)#
Parameters

rotationPySide6.QtGui.QQuaternion

This property holds The mesh rotation that is applied to all items of the series..

The rotation should be a normalized QQuaternion . For those series types that support item specific rotation, the rotations are multiplied together. QBar3DSeries ignores any rotation that is not around the y-axis. QSurface3DSeries applies the rotation only to the selection pointer. Defaults to no rotation.

PySide6.QtDataVisualization.QAbstract3DSeries.setMeshSmooth(enable)#
Parameters

enable – bool

This property holds Whether smooth versions of predefined meshes are used..

If true, smooth versions set via the mesh property are used. This property does not affect custom meshes used when the mesh is set to MeshUserDefined . Defaults to false.

PySide6.QtDataVisualization.QAbstract3DSeries.setMultiHighlightColor(color)#
Parameters

colorPySide6.QtGui.QColor

This property holds The multiple item highlight color of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.setMultiHighlightGradient(gradient)#
Parameters

gradientPySide6.QtGui.QLinearGradient

This property holds The multiple item highlight gradient of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.setName(name)#
Parameters

name – str

This property holds The series name..

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

See also

itemLabelFormat

PySide6.QtDataVisualization.QAbstract3DSeries.setSingleHighlightColor(color)#
Parameters

colorPySide6.QtGui.QColor

This property holds The single item highlight color of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.setSingleHighlightGradient(gradient)#
Parameters

gradientPySide6.QtGui.QLinearGradient

This property holds The single item highlight gradient of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.setUserDefinedMesh(fileName)#
Parameters

fileName – str

This property holds The filename for a user defined custom mesh for objects..

The custom mesh is used when mesh is MeshUserDefined .

Note

The file needs to be in the Wavefront OBJ format and include vertices, normals, and UVs. It also needs to be in triangles.

PySide6.QtDataVisualization.QAbstract3DSeries.setVisible(visible)#
Parameters

visible – bool

This property holds The visibility of the series..

If this property is false, the series is not rendered. Defaults to true.

PySide6.QtDataVisualization.QAbstract3DSeries.singleHighlightColor()#
Return type

PySide6.QtGui.QColor

This property holds The single item highlight color of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.singleHighlightColorChanged(color)#
Parameters

colorPySide6.QtGui.QColor

PySide6.QtDataVisualization.QAbstract3DSeries.singleHighlightGradient()#
Return type

PySide6.QtGui.QLinearGradient

This property holds The single item highlight gradient of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.singleHighlightGradientChanged(gradient)#
Parameters

gradientPySide6.QtGui.QLinearGradient

PySide6.QtDataVisualization.QAbstract3DSeries.type()#
Return type

SeriesType

This property holds The type of the series..

PySide6.QtDataVisualization.QAbstract3DSeries.userDefinedMesh()#
Return type

str

This property holds The filename for a user defined custom mesh for objects..

The custom mesh is used when mesh is MeshUserDefined .

Note

The file needs to be in the Wavefront OBJ format and include vertices, normals, and UVs. It also needs to be in triangles.

PySide6.QtDataVisualization.QAbstract3DSeries.userDefinedMeshChanged(fileName)#
Parameters

fileName – str

PySide6.QtDataVisualization.QAbstract3DSeries.visibilityChanged(visible)#
Parameters

visible – bool