QAbstract3DGraph#

The QAbstract3DGraph class provides a window and render loop for graphs. More

Inheritance diagram of PySide6.QtDataVisualization.QAbstract3DGraph

Inherited by: Q3DSurface, Q3DScatter, Q3DBars

Synopsis#

Functions#

Virtual functions#

Signals#

Detailed Description#

This class subclasses a QWindow and provides render loop for graphs inheriting it.

You should not need to use this class directly, but one of its subclasses instead.

Anti-aliasing is turned on by default on C++, except in OpenGL ES2 environments, where anti-aliasing is not supported by Qt Data Visualization. To specify non-default anti-aliasing for a graph, give a custom surface format as a constructor parameter. You can use the convenience function qDefaultSurfaceFormat() to create the surface format object.

Note

QAbstract3DGraph sets window flag Qt::FramelessWindowHint on by default. If you want to display graph windows as standalone windows with regular window frame, clear this flag after constructing the graph. For example:

Q3DBars *graphWindow = new Q3DBars;
graphWindow->setFlags(graphWindow->flags() ^ Qt::FramelessWindowHint);
class PySide6.QtDataVisualization.QAbstract3DGraph#
PySide6.QtDataVisualization.QAbstract3DGraph.SelectionFlag#

Item selection modes. Values of this enumeration can be combined with OR operator.

  • QAbstract3DGraph.SelectionMultiSeries

  • Setting this mode means that items for all series at same position are highlighted, instead of just the selected item. The actual selection in the other series doesn’t change. Multi-series selection is not supported for Q3DScatter .

PySide6.QtDataVisualization.QAbstract3DGraph.ShadowQuality#

Quality of shadows.

Constant

Description

QAbstract3DGraph.ShadowQualityNone

Shadows are disabled.

QAbstract3DGraph.ShadowQualityLow

Shadows are rendered in low quality.

QAbstract3DGraph.ShadowQualityMedium

Shadows are rendered in medium quality.

QAbstract3DGraph.ShadowQualityHigh

Shadows are rendered in high quality.

QAbstract3DGraph.ShadowQualitySoftLow

Shadows are rendered in low quality with softened edges.

QAbstract3DGraph.ShadowQualitySoftMedium

Shadows are rendered in medium quality with softened edges.

QAbstract3DGraph.ShadowQualitySoftHigh

Shadows are rendered in high quality with softened edges.

PySide6.QtDataVisualization.QAbstract3DGraph.ElementType#

Type of an element in the graph.

Constant

Description

QAbstract3DGraph.ElementNone

No defined element.

QAbstract3DGraph.ElementSeries

A series (that is, an item in a series).

QAbstract3DGraph.ElementAxisXLabel

The x-axis label.

QAbstract3DGraph.ElementAxisYLabel

The y-axis label.

QAbstract3DGraph.ElementAxisZLabel

The z-axis label.

QAbstract3DGraph.ElementCustomItem

A custom item.

PySide6.QtDataVisualization.QAbstract3DGraph.OptimizationHint#

The optimization hint for rendering.

Constant

Description

QAbstract3DGraph.OptimizationDefault

Provides the full feature set at a reasonable performance.

QAbstract3DGraph.OptimizationStatic

Optimizes the rendering of static data sets at the expense of some features.

PySide6.QtDataVisualization.QAbstract3DGraph.activeInputHandler()#
Return type

PySide6.QtDataVisualization.QAbstract3DInputHandler

This property holds The active input handler used in the graph..

PySide6.QtDataVisualization.QAbstract3DGraph.activeInputHandlerChanged(inputHandler)#
Parameters

inputHandlerPySide6.QtDataVisualization.QAbstract3DInputHandler

PySide6.QtDataVisualization.QAbstract3DGraph.activeTheme()#
Return type

PySide6.QtDataVisualization.Q3DTheme

This property holds The active theme of the graph..

PySide6.QtDataVisualization.QAbstract3DGraph.activeThemeChanged(theme)#
Parameters

themePySide6.QtDataVisualization.Q3DTheme

PySide6.QtDataVisualization.QAbstract3DGraph.addCustomItem(item)#
Parameters

itemPySide6.QtDataVisualization.QCustom3DItem

Return type

int

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

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

Items are rendered in the order they have been inserted. The rendering order needs to be taken into account when having solid and transparent items.

PySide6.QtDataVisualization.QAbstract3DGraph.addInputHandler(inputHandler)#
Parameters

inputHandlerPySide6.QtDataVisualization.QAbstract3DInputHandler

Adds the given inputHandler to the graph. The input handlers added via are not taken in to use directly. Only the ownership of the inputHandler is given to the graph. The inputHandler must not be null or already added to another graph.

PySide6.QtDataVisualization.QAbstract3DGraph.addTheme(theme)#
Parameters

themePySide6.QtDataVisualization.Q3DTheme

Adds the given theme to the graph. The themes added via are not taken in to use directly. Only the ownership of the theme is given to the graph. The theme must not be null or already added to another graph.

PySide6.QtDataVisualization.QAbstract3DGraph.aspectRatio()#
Return type

float

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.

Note

Has no effect on Q3DBars .

PySide6.QtDataVisualization.QAbstract3DGraph.aspectRatioChanged(ratio)#
Parameters

ratio – float

PySide6.QtDataVisualization.QAbstract3DGraph.clearSelection()#

Clears selection from all attached series.

PySide6.QtDataVisualization.QAbstract3DGraph.currentFps()#
Return type

float

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.

See also

measureFps

PySide6.QtDataVisualization.QAbstract3DGraph.currentFpsChanged(fps)#
Parameters

fps – float

PySide6.QtDataVisualization.QAbstract3DGraph.customItems()#
Return type

Returns the list of all added custom items.

See also

addCustomItem()

PySide6.QtDataVisualization.QAbstract3DGraph.hasContext()#
Return type

bool

Returns true if the OpenGL context of the graph has been successfully initialized. Trying to use a graph when the context initialization has failed typically results in a crash. A common reason for a context initialization failure is lack of sufficient platform support for OpenGL.

PySide6.QtDataVisualization.QAbstract3DGraph.hasSeries(series)#
Parameters

seriesPySide6.QtDataVisualization.QAbstract3DSeries

Return type

bool

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

PySide6.QtDataVisualization.QAbstract3DGraph.horizontalAspectRatio()#
Return type

float

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 Q3DBars , which handles scaling on the horizontal plane via the barThickness and barSpacing properties. Polar graphs also ignore this property.

PySide6.QtDataVisualization.QAbstract3DGraph.horizontalAspectRatioChanged(ratio)#
Parameters

ratio – float

PySide6.QtDataVisualization.QAbstract3DGraph.inputHandlers()#
Return type

Returns the list of all added input handlers.

PySide6.QtDataVisualization.QAbstract3DGraph.isOrthoProjection()#
Return type

bool

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

Defaults to false.

Note

Shadows will be disabled when set to true.

PySide6.QtDataVisualization.QAbstract3DGraph.isPolar()#
Return type

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.

See also

orthoProjection radialLabelOffset

PySide6.QtDataVisualization.QAbstract3DGraph.isReflection()#
Return type

bool

This property holds Whether floor reflections are on or off..

Defaults to false.

Affects only Q3DBars . However, in Q3DBars graphs holding both positive and negative values, reflections are not supported for custom items that intersect the floor plane. In that case, reflections should be turned off to avoid incorrect rendering.

If using a custom surface format, the stencil buffer needs to be defined ( setStencilBufferSize() ) for reflections to work.

See also

reflectivity

PySide6.QtDataVisualization.QAbstract3DGraph.locale()#
Return type

PySide6.QtCore.QLocale

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

Defaults to the "C" locale.

See also

labelFormat

PySide6.QtDataVisualization.QAbstract3DGraph.localeChanged(locale)#
Parameters

localePySide6.QtCore.QLocale

PySide6.QtDataVisualization.QAbstract3DGraph.margin()#
Return type

float

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 beed changed from the default values. Defaults to -1.0.

Note

Setting a smaller margin for a scatter graph than the automatically determined margin can cause the scatter items at the edges of the graph to overlap with the graph background.

Note

On scatter and surface graphs, if the margin is small in comparison to the axis label size, the positions of the edge labels of the axes are adjusted to avoid overlap with the edge labels of the neighboring axes.

PySide6.QtDataVisualization.QAbstract3DGraph.marginChanged(margin)#
Parameters

margin – float

PySide6.QtDataVisualization.QAbstract3DGraph.measureFps()#
Return type

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.

See also

currentFps

PySide6.QtDataVisualization.QAbstract3DGraph.measureFpsChanged(enabled)#
Parameters

enabled – bool

PySide6.QtDataVisualization.QAbstract3DGraph.optimizationHints()#
Return type

OptimizationHints

This property holds Whether the default or static mode is used for rendering optimization..

The default mode provides the full feature set at a reasonable level of performance. 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. Defaults to OptimizationDefault .

Note

On some environments, large graphs using static optimization may not render, because all of the items are rendered using a single draw call, and different graphics drivers support different maximum vertice counts per call. This is mostly an issue on 32bit and OpenGL ES2 platforms. To work around this issue, choose an item mesh with a low vertex count or use the point mesh.

See also

mesh

PySide6.QtDataVisualization.QAbstract3DGraph.optimizationHintsChanged(hints)#
Parameters

hintsOptimizationHints

PySide6.QtDataVisualization.QAbstract3DGraph.orthoProjectionChanged(enabled)#
Parameters

enabled – bool

PySide6.QtDataVisualization.QAbstract3DGraph.polarChanged(enabled)#
Parameters

enabled – bool

PySide6.QtDataVisualization.QAbstract3DGraph.queriedGraphPosition()#
Return type

PySide6.QtGui.QVector3D

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

This read-only property contains the results from 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.

Note

Bar graphs only allow querying graph position at the graph floor level, so the y-value is always zero for bar graphs and the valid queries can be only made at screen positions that contain the floor of the graph.

PySide6.QtDataVisualization.QAbstract3DGraph.queriedGraphPositionChanged(data)#
Parameters

dataPySide6.QtGui.QVector3D

PySide6.QtDataVisualization.QAbstract3DGraph.radialLabelOffset()#
Return type

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.

See also

polar

PySide6.QtDataVisualization.QAbstract3DGraph.radialLabelOffsetChanged(offset)#
Parameters

offset – float

PySide6.QtDataVisualization.QAbstract3DGraph.reflectionChanged(enabled)#
Parameters

enabled – bool

PySide6.QtDataVisualization.QAbstract3DGraph.reflectivity()#
Return type

float

This property holds Floor reflectivity..

Larger numbers make the floor more reflective. The valid range is [0...1]. Defaults to 0.5.

Note

Affects only Q3DBars .

See also

reflection

PySide6.QtDataVisualization.QAbstract3DGraph.reflectivityChanged(reflectivity)#
Parameters

reflectivity – float

PySide6.QtDataVisualization.QAbstract3DGraph.releaseCustomItem(item)#
Parameters

itemPySide6.QtDataVisualization.QCustom3DItem

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

Note

If the same item is added back to the graph, the texture or the texture file needs to be re-set.

PySide6.QtDataVisualization.QAbstract3DGraph.releaseInputHandler(inputHandler)#
Parameters

inputHandlerPySide6.QtDataVisualization.QAbstract3DInputHandler

Releases the ownership of the inputHandler back to the caller, if it was added to this graph. If the released inputHandler is in use there will be no input handler active after this call.

If the default input handler is released and added back later, it behaves as any other input handler would.

PySide6.QtDataVisualization.QAbstract3DGraph.releaseTheme(theme)#
Parameters

themePySide6.QtDataVisualization.Q3DTheme

Releases the ownership of the theme back to the caller, if it was added to this graph. If the released theme is in use, a new default theme will be created and set active.

If the default theme is released and added back later, it behaves as any other theme would.

PySide6.QtDataVisualization.QAbstract3DGraph.removeCustomItem(item)#
Parameters

itemPySide6.QtDataVisualization.QCustom3DItem

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

PySide6.QtDataVisualization.QAbstract3DGraph.removeCustomItemAt(position)#
Parameters

positionPySide6.QtGui.QVector3D

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

PySide6.QtDataVisualization.QAbstract3DGraph.removeCustomItems()#

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

PySide6.QtDataVisualization.QAbstract3DGraph.renderToImage([msaaSamples=0[, imageSize=QSize()]])#
Parameters
Return type

PySide6.QtGui.QImage

Renders current frame to an image of imageSize. Default size is the window size. Image is rendered with antialiasing level given in msaaSamples. Default level is 0.

Returns the rendered image.

Note

OpenGL ES2 does not support anitialiasing, so msaaSamples is always forced to 0.

PySide6.QtDataVisualization.QAbstract3DGraph.scene()#
Return type

PySide6.QtDataVisualization.Q3DScene

This property holds The Q3DScene pointer that can be used to manipulate the scene and access the scene elements, such as the active camera..

This property is read-only.

PySide6.QtDataVisualization.QAbstract3DGraph.selectedAxis()#
Return type

PySide6.QtDataVisualization.QAbstract3DAxis

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 pointer to the selected axis, or null.

See also

selectedElement

PySide6.QtDataVisualization.QAbstract3DGraph.selectedCustomItem()#
Return type

PySide6.QtDataVisualization.QCustom3DItem

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

Returns the pointer to the selected custom item, or null.

See also

selectedElement

PySide6.QtDataVisualization.QAbstract3DGraph.selectedCustomItemIndex()#
Return type

int

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

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

See also

selectedElement

PySide6.QtDataVisualization.QAbstract3DGraph.selectedElement()#
Return type

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 by the Axis Range Dragging With Labels Example .

PySide6.QtDataVisualization.QAbstract3DGraph.selectedElementChanged(type)#
Parameters

typeElementType

PySide6.QtDataVisualization.QAbstract3DGraph.selectedLabelIndex()#
Return type

int

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 the index of the selected label, or -1.

See also

selectedElement

PySide6.QtDataVisualization.QAbstract3DGraph.selectionMode()#
Return type

SelectionFlags

This property holds Item selection mode..

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

See also

SelectionFlags

PySide6.QtDataVisualization.QAbstract3DGraph.selectionModeChanged(mode)#
Parameters

modeSelectionFlags

PySide6.QtDataVisualization.QAbstract3DGraph.setActiveInputHandler(inputHandler)#
Parameters

inputHandlerPySide6.QtDataVisualization.QAbstract3DInputHandler

This property holds The active input handler used in the graph..

PySide6.QtDataVisualization.QAbstract3DGraph.setActiveTheme(theme)#
Parameters

themePySide6.QtDataVisualization.Q3DTheme

This property holds The active theme of the graph..

PySide6.QtDataVisualization.QAbstract3DGraph.setAspectRatio(ratio)#
Parameters

ratio – float

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.

Note

Has no effect on Q3DBars .

PySide6.QtDataVisualization.QAbstract3DGraph.setHorizontalAspectRatio(ratio)#
Parameters

ratio – float

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 Q3DBars , which handles scaling on the horizontal plane via the barThickness and barSpacing properties. Polar graphs also ignore this property.

PySide6.QtDataVisualization.QAbstract3DGraph.setLocale(locale)#
Parameters

localePySide6.QtCore.QLocale

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

Defaults to the "C" locale.

See also

labelFormat

PySide6.QtDataVisualization.QAbstract3DGraph.setMargin(margin)#
Parameters

margin – float

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 beed changed from the default values. Defaults to -1.0.

Note

Setting a smaller margin for a scatter graph than the automatically determined margin can cause the scatter items at the edges of the graph to overlap with the graph background.

Note

On scatter and surface graphs, if the margin is small in comparison to the axis label size, the positions of the edge labels of the axes are adjusted to avoid overlap with the edge labels of the neighboring axes.

PySide6.QtDataVisualization.QAbstract3DGraph.setMeasureFps(enable)#
Parameters

enable – 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.

See also

currentFps

PySide6.QtDataVisualization.QAbstract3DGraph.setOptimizationHints(hints)#
Parameters

hintsOptimizationHints

This property holds Whether the default or static mode is used for rendering optimization..

The default mode provides the full feature set at a reasonable level of performance. 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. Defaults to OptimizationDefault .

Note

On some environments, large graphs using static optimization may not render, because all of the items are rendered using a single draw call, and different graphics drivers support different maximum vertice counts per call. This is mostly an issue on 32bit and OpenGL ES2 platforms. To work around this issue, choose an item mesh with a low vertex count or use the point mesh.

See also

mesh

PySide6.QtDataVisualization.QAbstract3DGraph.setOrthoProjection(enable)#
Parameters

enable – bool

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

Defaults to false.

Note

Shadows will be disabled when set to true.

PySide6.QtDataVisualization.QAbstract3DGraph.setPolar(enable)#
Parameters

enable – 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.

See also

orthoProjection radialLabelOffset

PySide6.QtDataVisualization.QAbstract3DGraph.setRadialLabelOffset(offset)#
Parameters

offset – 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.

See also

polar

PySide6.QtDataVisualization.QAbstract3DGraph.setReflection(enable)#
Parameters

enable – bool

This property holds Whether floor reflections are on or off..

Defaults to false.

Affects only Q3DBars . However, in Q3DBars graphs holding both positive and negative values, reflections are not supported for custom items that intersect the floor plane. In that case, reflections should be turned off to avoid incorrect rendering.

If using a custom surface format, the stencil buffer needs to be defined ( setStencilBufferSize() ) for reflections to work.

See also

reflectivity

PySide6.QtDataVisualization.QAbstract3DGraph.setReflectivity(reflectivity)#
Parameters

reflectivity – float

This property holds Floor reflectivity..

Larger numbers make the floor more reflective. The valid range is [0...1]. Defaults to 0.5.

Note

Affects only Q3DBars .

See also

reflection

PySide6.QtDataVisualization.QAbstract3DGraph.setSelectionMode(mode)#
Parameters

modeSelectionFlags

This property holds Item selection mode..

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

See also

SelectionFlags

PySide6.QtDataVisualization.QAbstract3DGraph.setShadowQuality(quality)#
Parameters

qualityShadowQuality

This property holds The quality of the shadow..

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

Note

If setting the shadow quality to a certain level fails, the level is lowered until it is successfully set. The shadowQualityChanged signal is emitted each time a change is made.

See also

ShadowQuality

PySide6.QtDataVisualization.QAbstract3DGraph.shadowQuality()#
Return type

ShadowQuality

This property holds The quality of the shadow..

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

Note

If setting the shadow quality to a certain level fails, the level is lowered until it is successfully set. The shadowQualityChanged signal is emitted each time a change is made.

See also

ShadowQuality

PySide6.QtDataVisualization.QAbstract3DGraph.shadowQualityChanged(quality)#
Parameters

qualityShadowQuality

PySide6.QtDataVisualization.QAbstract3DGraph.shadowsSupported()#
Return type

bool

Returns true if shadows are supported with the current configuration. OpenGL ES2 configurations do not support shadows.

PySide6.QtDataVisualization.QAbstract3DGraph.themes()#
Return type

Returns the list of all added themes.

See also

addTheme()