PySide6.QtGraphs.QAbstract3DSeries

class QAbstract3DSeries

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

Inherited by: QSurface3DSeries, QScatter3DSeries, QBar3DSeries

Synopsis

Properties

• baseColorᅟ - Base color of the series

• baseGradientᅟ - Base gradient of the series

• colorStyleᅟ - Color style for the series

• itemLabelᅟ - Formatted item label

• itemLabelFormatᅟ - Label format for data items in this series

• itemLabelVisibleᅟ - Visibility of item labels in the graph

• meshᅟ - Of the items in the series

• meshRotationᅟ - Mesh rotation that is applied to all items of the series

• meshSmoothᅟ - Whether smooth versions of predefined meshes are used

• multiHighlightColorᅟ - Multiple item highlight color of the series

• multiHighlightGradientᅟ - Multiple item highlight gradient of the series

• nameᅟ - Series name

• singleHighlightColorᅟ - Single item highlight color of the series

• singleHighlightGradientᅟ - Single item highlight gradient of the series

• typeᅟ - Of the series

• userDefinedMeshᅟ - Filename for a user defined custom mesh for objects

• visibleᅟ - Visibility of the series

Methods

• def baseColor()

• def baseGradient()

• def colorStyle()

• def isItemLabelVisible()

• def isMeshSmooth()

• def isVisible()

• def itemLabel()

• def itemLabelFormat()

• def mesh()

• def meshRotation()

• def multiHighlightColor()

• def multiHighlightGradient()

• def name()

• def setBaseColor()

• def setBaseGradient()

• def setColorStyle()

• def setItemLabelFormat()

• def setItemLabelVisible()

• def setMesh()

• def setMeshAxisAndAngle()

• def setMeshRotation()

• def setMeshSmooth()

• def setMultiHighlightColor()

• def setMultiHighlightGradient()

• def setName()

• def setSingleHighlightColor()

• def setSingleHighlightGradient()

• def setUserDefinedMesh()

• def setVisible()

• def singleHighlightColor()

• def singleHighlightGradient()

• def type()

• def userDefinedMesh()

Signals

• def baseColorChanged()

• def baseGradientChanged()

• def colorStyleChanged()

• def itemLabelChanged()

• def itemLabelFormatChanged()

• def itemLabelVisibleChanged()

• def meshChanged()

• def meshRotationChanged()

• def meshSmoothChanged()

• def multiHighlightColorChanged()

• def multiHighlightGradientChanged()

• def nameChanged()

• def singleHighlightColorChanged()

• def singleHighlightGradientChanged()

• def userDefinedMeshChanged()

• def visibleChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

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

For more information, see Qt Graphs Data Handling with 3D .

class SeriesType

Type of the series.

Constant	Description
QAbstract3DSeries.SeriesType.None	No series type.
QAbstract3DSeries.SeriesType.Bar	Series type for Q3DBarsWidgetItem .
QAbstract3DSeries.SeriesType.Scatter	Series type for Q3DScatterWidgetItem .
QAbstract3DSeries.SeriesType.Surface	Series type for Q3DSurfaceWidgetItem .

class Mesh

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

Constant	Description
QAbstract3DSeries.Mesh.UserDefined	User defined mesh, set via userDefinedMesh property.
QAbstract3DSeries.Mesh.Bar	Basic rectangular bar.
QAbstract3DSeries.Mesh.Cube	Basic cube.
QAbstract3DSeries.Mesh.Pyramid	Four-sided pyramid.
QAbstract3DSeries.Mesh.Cone	Basic cone.
QAbstract3DSeries.Mesh.Cylinder	Basic cylinder.
QAbstract3DSeries.Mesh.BevelBar	Slightly beveled (rounded) rectangular bar.
QAbstract3DSeries.Mesh.BevelCube	Slightly beveled (rounded) cube.
QAbstract3DSeries.Mesh.Sphere	Sphere.
QAbstract3DSeries.Mesh.Minimal	The minimal 3D mesh: a triangular pyramid. Usable only with Q3DScatterWidgetItem .
QAbstract3DSeries.Mesh.Arrow	Arrow pointing upwards.
QAbstract3DSeries.Mesh.Point	2D point. Usable only with Q3DScatterWidgetItem . Shadows do not affect this style. Color style ObjectGradient is not supported by this style.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property baseColorᅟ: QColor

This property holds The base color of the series..

See also

colorStyle seriesColors

Access functions:

• baseColor()

• setBaseColor()

• Signal baseColorChanged()

property baseGradientᅟ: QLinearGradient

This property holds The base gradient of the series..

See also

colorStyle seriesGradients

Access functions:

• baseGradient()

• setBaseGradient()

• Signal baseGradientChanged()

property colorStyleᅟ: QGraphsTheme.ColorStyle

This property holds The color style for the series..

See also

ColorStyle

Access functions:

• colorStyle()

• setColorStyle()

• Signal colorStyleChanged()

property itemLabelᅟ: 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

Access functions:

• itemLabel()

• Signal itemLabelChanged()

property itemLabelFormatᅟ: 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.

See also

QBar3DSeries QScatter3DSeries QSurface3DSeries

Access functions:

• itemLabelFormat()

• setItemLabelFormat()

• Signal itemLabelFormatChanged()

property itemLabelVisibleᅟ: 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.

See also

itemLabelFormat itemLabel

Access functions:

• isItemLabelVisible()

• setItemLabelVisible()

• Signal itemLabelVisibleChanged()

property meshᅟ: QAbstract3DSeries.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.

Access functions:

• mesh()

• setMesh()

• Signal meshChanged()

property meshRotationᅟ: 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.

Access functions:

• meshRotation()

• setMeshRotation()

• Signal meshRotationChanged()

property meshSmoothᅟ: 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.

Access functions:

• isMeshSmooth()

• setMeshSmooth()

• Signal meshSmoothChanged()

property multiHighlightColorᅟ: QColor

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

See also

colorStyle multiHighlightColor

Access functions:

• multiHighlightColor()

• setMultiHighlightColor()

• Signal multiHighlightColorChanged()

property multiHighlightGradientᅟ: QLinearGradient

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

See also

colorStyle multiHighlightGradient

Access functions:

• multiHighlightGradient()

• setMultiHighlightGradient()

• Signal multiHighlightGradientChanged()

property 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

Access functions:

• name()

• setName()

• Signal nameChanged()

property singleHighlightColorᅟ: QColor

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

See also

colorStyle singleHighlightColor

Access functions:

• singleHighlightColor()

• setSingleHighlightColor()

• Signal singleHighlightColorChanged()

property singleHighlightGradientᅟ: QLinearGradient

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

See also

colorStyle singleHighlightGradient

Access functions:

• singleHighlightGradient()

• setSingleHighlightGradient()

• Signal singleHighlightGradientChanged()

property typeᅟ: QAbstract3DSeries.SeriesType

This property holds The type of the series..

Access functions:

• type()

property userDefinedMeshᅟ: 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 QtQuick3D mesh format. Use the balsam conversion tool to create a mesh from other 3D model formats.

Access functions:

• userDefinedMesh()

• setUserDefinedMesh()

• Signal userDefinedMeshChanged()

property visibleᅟ: bool

This property holds The visibility of the series..

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

Access functions:

• isVisible()

• setVisible()

• Signal visibleChanged()

baseColor()

Return type:

QColor

See also

setBaseColor()

Getter of property baseColorᅟ .

baseColorChanged(color)

Parameters:

color – QColor

Notification signal of property baseColorᅟ .

baseGradient()

Return type:

QLinearGradient

See also

setBaseGradient()

Getter of property baseGradientᅟ .

baseGradientChanged(gradient)

Parameters:

gradient – QLinearGradient

Notification signal of property baseGradientᅟ .

colorStyle()

Return type:

ColorStyle

See also

setColorStyle()

Getter of property colorStyleᅟ .

colorStyleChanged(style)

Parameters:

style – ColorStyle

Notification signal of property colorStyleᅟ .

isItemLabelVisible()

Return type:

bool

Getter of property itemLabelVisibleᅟ .

isMeshSmooth()

Return type:

bool

Getter of property meshSmoothᅟ .

isVisible()

Return type:

bool

Getter of property visibleᅟ .

itemLabel()

Return type:

str

Getter of property itemLabelᅟ .

itemLabelChanged(label)

Parameters:

label – str

Notification signal of property itemLabelᅟ .

itemLabelFormat()

Return type:

str

See also

setItemLabelFormat()

Getter of property itemLabelFormatᅟ .

itemLabelFormatChanged(format)

Parameters:

format – str

Notification signal of property itemLabelFormatᅟ .

itemLabelVisibleChanged(visible)

Parameters:

visible – bool

Notification signal of property itemLabelVisibleᅟ .

mesh()

Return type:

Mesh

See also

setMesh()

Getter of property meshᅟ .

meshChanged(mesh)

Parameters:

mesh – Mesh

Notification signal of property meshᅟ .

meshRotation()

Return type:

QQuaternion

See also

setMeshRotation()

Getter of property meshRotationᅟ .

meshRotationChanged(rotation)

Parameters:

rotation – QQuaternion

Notification signal of property meshRotationᅟ .

meshSmoothChanged(enabled)

Parameters:

enabled – bool

Notification signal of property meshSmoothᅟ .

multiHighlightColor()

Return type:

QColor

See also

setMultiHighlightColor()

Getter of property multiHighlightColorᅟ .

multiHighlightColorChanged(color)

Parameters:

color – QColor

Notification signal of property multiHighlightColorᅟ .

multiHighlightGradient()

Return type:

QLinearGradient

See also

setMultiHighlightGradient()

Getter of property multiHighlightGradientᅟ .

multiHighlightGradientChanged(gradient)

Parameters:

gradient – QLinearGradient

Notification signal of property multiHighlightGradientᅟ .

name()

Return type:

str

See also

setName()

Getter of property nameᅟ .

nameChanged(name)

Parameters:

name – str

Notification signal of property nameᅟ .

setBaseColor(color)

Parameters:

color – QColor

See also

baseColor()

Setter of property baseColorᅟ .

setBaseGradient(gradient)

Parameters:

gradient – QLinearGradient

See also

baseGradient()

Setter of property baseGradientᅟ .

setColorStyle(style)

Parameters:

style – ColorStyle

See also

colorStyle()

Setter of property colorStyleᅟ .

setItemLabelFormat(format)

Parameters:

format – str

See also

itemLabelFormat()

Setter of property itemLabelFormatᅟ .

setItemLabelVisible(visible)

Parameters:

visible – bool

See also

isItemLabelVisible()

Setter of property itemLabelVisibleᅟ .

setMesh(mesh)

Parameters:

mesh – Mesh

See also

mesh()

Setter of property meshᅟ .

setMeshAxisAndAngle(axis, angle)

Parameters:

• axis – QVector3D

• angle – float

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

See also

meshRotation

setMeshRotation(rotation)

Parameters:

rotation – QQuaternion

See also

meshRotation()

Setter of property meshRotationᅟ .

setMeshSmooth(enable)

Parameters:

enable – bool

See also

isMeshSmooth()

Setter of property meshSmoothᅟ .

setMultiHighlightColor(color)

Parameters:

color – QColor

See also

multiHighlightColor()

Setter of property multiHighlightColorᅟ .

setMultiHighlightGradient(gradient)

Parameters:

gradient – QLinearGradient

See also

multiHighlightGradient()

Setter of property multiHighlightGradientᅟ .

setName(name)

Parameters:

name – str

See also

name()

Setter of property nameᅟ .

setSingleHighlightColor(color)

Parameters:

color – QColor

See also

singleHighlightColor()

Setter of property singleHighlightColorᅟ .

setSingleHighlightGradient(gradient)

Parameters:

gradient – QLinearGradient

See also

singleHighlightGradient()

Setter of property singleHighlightGradientᅟ .

setUserDefinedMesh(fileName)

Parameters:

fileName – str

See also

userDefinedMesh()

Setter of property userDefinedMeshᅟ .

setVisible(visible)

Parameters:

visible – bool

See also

isVisible()

Setter of property visibleᅟ .

singleHighlightColor()

Return type:

QColor

See also

setSingleHighlightColor()

Getter of property singleHighlightColorᅟ .

singleHighlightColorChanged(color)

Parameters:

color – QColor

Notification signal of property singleHighlightColorᅟ .

singleHighlightGradient()

Return type:

QLinearGradient

See also

setSingleHighlightGradient()

Getter of property singleHighlightGradientᅟ .

singleHighlightGradientChanged(gradient)

Parameters:

gradient – QLinearGradient

Notification signal of property singleHighlightGradientᅟ .

type()

Return type:

SeriesType

Getter of property typeᅟ .

userDefinedMesh()

Return type:

str

See also

setUserDefinedMesh()

Getter of property userDefinedMeshᅟ .

userDefinedMeshChanged(fileName)

Parameters:

fileName – str

Notification signal of property userDefinedMeshᅟ .

visibleChanged(visible)

Parameters:

visible – bool

Notification signal of property visibleᅟ .