Q3DBars

The Q3DBars class provides methods for rendering 3D bar graphs. More

Inheritance diagram of PySide6.QtDataVisualization.Q3DBars

Synopsis

Functions

Detailed Description

This class enables developers to render bar graphs in 3D and to view them by rotating the scene freely. Rotation is done by holding down the right mouse button and moving the mouse. Zooming is done by mouse wheel. Selection, if enabled, is done by left mouse button. The scene can be reset to default camera view by clicking mouse wheel. In touch devices rotation is done by tap-and-move, selection by tap-and-hold and zoom by pinch.

If no axes are set explicitly to Q3DBars , temporary default axes with no labels are created. These default axes can be modified via axis accessors, but as soon any axis is set explicitly for the orientation, the default axis for that orientation is destroyed.

Q3DBars supports more than one series visible at the same time. It is not necessary for all series to have the same amount of rows and columns. Row and column labels are taken from the first added series, unless explicitly defined to row and column axes.

How to construct a minimal Q3DBars graph

First, construct an instance of Q3DBars . Since we are running the graph as top level window in this example, we need to clear the Qt::FramelessWindowHint flag, which gets set by default:

Q3DBars bars;
bars.setFlags(bars.flags() ^ Qt::FramelessWindowHint);

After constructing Q3DBars , you can set the data window by changing the range on the row and column axes. It is not mandatory, as data window will default to showing all of the data in the series. If the amount of data is large, it is usually preferable to show just a portion of it. For the example, let’s set the data window to show first five rows and columns:

bars.rowAxis()->setRange(0, 4);
bars.columnAxis()->setRange(0, 4);

Now Q3DBars is ready to receive data to be rendered. Create a series with one row of 5 values:

QBar3DSeries *series = new QBar3DSeries;
QBarDataRow *data = new QBarDataRow;
*data << 1.0f << 3.0f << 7.5f << 5.0f << 2.2f;
series->dataProxy()->addRow(data);
bars.addSeries(series);

Note

We set the data window to 5 x 5, but we are adding only one row of data. This is ok, the rest of the rows will just be blank.

Finally you will need to set it visible:

bars.show();

The complete code needed to create and display this graph is:

#include <QtDataVisualization>

int main(int argc, char **argv)
{
    qputenv("QSG_RHI_BACKEND", "opengl");
    QGuiApplication app(argc, argv);


    Q3DBars bars;
    bars.setFlags(bars.flags() ^ Qt::FramelessWindowHint);


    bars.rowAxis()->setRange(0, 4);
    bars.columnAxis()->setRange(0, 4);


    QBar3DSeries *series = new QBar3DSeries;
    QBarDataRow *data = new QBarDataRow;
    *data << 1.0f << 3.0f << 7.5f << 5.0f << 2.2f;
    series->dataProxy()->addRow(data);
    bars.addSeries(series);


    bars.show();


    return app.exec();
}

And this is what those few lines of code produce:

../../_images/q3dbars-minimal.png

The scene can be rotated, zoomed into, and a bar can be selected to view its value, but no other interaction is included in this minimal code example. You can learn more by familiarizing yourself with the examples provided, like the Bars Example .

See also

Q3DScatter Q3DSurface Qt Data Visualization C++ Classes

class PySide6.QtDataVisualization.Q3DBars([format=None[, parent=None]])
Parameters

Constructs a new 3D bar graph with optional parent window and surface format.

PySide6.QtDataVisualization.Q3DBars.addAxis(axis)
Parameters

axisPySide6.QtDataVisualization.QAbstract3DAxis

Adds axis to the graph. The axes added via are not yet taken to use, is simply used to give the ownership of the axis to the graph. The axis must not be null or added to another graph.

PySide6.QtDataVisualization.Q3DBars.addSeries(series)
Parameters

seriesPySide6.QtDataVisualization.QBar3DSeries

Adds the series to the graph. A graph can contain multiple series, but only one set of axes, so the rows and columns of all series must match for the visualized data to be meaningful. If the graph has multiple visible series, only the primary series will generate the row or column labels on the axes in cases where the labels are not explicitly set to the axes. If the newly added series has specified a selected bar, it will be highlighted and any existing selection will be cleared. Only one added series can have an active selection.

PySide6.QtDataVisualization.Q3DBars.axes()
Return type

Returns the list of all added axes.

See also

addAxis()

PySide6.QtDataVisualization.Q3DBars.barSpacing()
Return type

PySide6.QtCore.QSizeF

See also

setBarSpacing()

PySide6.QtDataVisualization.Q3DBars.barSpacingChanged(spacing)
Parameters

spacingPySide6.QtCore.QSizeF

PySide6.QtDataVisualization.Q3DBars.barSpacingRelativeChanged(relative)
Parameters

relative – bool

PySide6.QtDataVisualization.Q3DBars.barThickness()
Return type

float

PySide6.QtDataVisualization.Q3DBars.barThicknessChanged(thicknessRatio)
Parameters

thicknessRatio – float

PySide6.QtDataVisualization.Q3DBars.columnAxis()
Return type

PySide6.QtDataVisualization.QCategory3DAxis

See also

setColumnAxis()

PySide6.QtDataVisualization.Q3DBars.columnAxisChanged(axis)
Parameters

axisPySide6.QtDataVisualization.QCategory3DAxis

PySide6.QtDataVisualization.Q3DBars.floorLevel()
Return type

float

See also

setFloorLevel()

PySide6.QtDataVisualization.Q3DBars.floorLevelChanged(level)
Parameters

level – float

PySide6.QtDataVisualization.Q3DBars.insertSeries(index, series)
Parameters

Inserts the series into the position index in the series list. If the series has already been added to the list, it is moved to the new index.

Note

When moving a series to a new index that is after its old index, the new position in list is calculated as if the series was still in its old index, so the final index is actually the index decremented by one.

PySide6.QtDataVisualization.Q3DBars.isBarSpacingRelative()
Return type

bool

PySide6.QtDataVisualization.Q3DBars.isMultiSeriesUniform()
Return type

bool

PySide6.QtDataVisualization.Q3DBars.multiSeriesUniformChanged(uniform)
Parameters

uniform – bool

PySide6.QtDataVisualization.Q3DBars.primarySeries()
Return type

PySide6.QtDataVisualization.QBar3DSeries

PySide6.QtDataVisualization.Q3DBars.primarySeriesChanged(series)
Parameters

seriesPySide6.QtDataVisualization.QBar3DSeries

PySide6.QtDataVisualization.Q3DBars.releaseAxis(axis)
Parameters

axisPySide6.QtDataVisualization.QAbstract3DAxis

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

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

PySide6.QtDataVisualization.Q3DBars.removeSeries(series)
Parameters

seriesPySide6.QtDataVisualization.QBar3DSeries

Removes the series from the graph.

PySide6.QtDataVisualization.Q3DBars.rowAxis()
Return type

PySide6.QtDataVisualization.QCategory3DAxis

See also

setRowAxis()

PySide6.QtDataVisualization.Q3DBars.rowAxisChanged(axis)
Parameters

axisPySide6.QtDataVisualization.QCategory3DAxis

PySide6.QtDataVisualization.Q3DBars.selectedSeries()
Return type

PySide6.QtDataVisualization.QBar3DSeries

PySide6.QtDataVisualization.Q3DBars.selectedSeriesChanged(series)
Parameters

seriesPySide6.QtDataVisualization.QBar3DSeries

PySide6.QtDataVisualization.Q3DBars.seriesList()
Return type

Returns the list of series added to this graph.

PySide6.QtDataVisualization.Q3DBars.setBarSpacing(spacing)
Parameters

spacingPySide6.QtCore.QSizeF

See also

barSpacing()

PySide6.QtDataVisualization.Q3DBars.setBarSpacingRelative(relative)
Parameters

relative – bool

PySide6.QtDataVisualization.Q3DBars.setBarThickness(thicknessRatio)
Parameters

thicknessRatio – float

See also

barThickness()

PySide6.QtDataVisualization.Q3DBars.setColumnAxis(axis)
Parameters

axisPySide6.QtDataVisualization.QCategory3DAxis

Sets the axis of the active column to axis. Implicitly calls addAxis() to transfer the ownership of the axis to this graph.

If axis is null, a temporary default axis with no labels is created. This temporary axis is destroyed if another axis is set explicitly to the same orientation.

PySide6.QtDataVisualization.Q3DBars.setFloorLevel(level)
Parameters

level – float

See also

floorLevel()

PySide6.QtDataVisualization.Q3DBars.setMultiSeriesUniform(uniform)
Parameters

uniform – bool

PySide6.QtDataVisualization.Q3DBars.setPrimarySeries(series)
Parameters

seriesPySide6.QtDataVisualization.QBar3DSeries

Sets series as the primary series of the graph. The primary series determines the row and column axis labels when the labels are not explicitly set to the axes.

If the specified series is not yet added to the graph, setting it as the primary series will also implicitly add it to the graph.

If the primary series itself is removed from the graph, this property resets to default.

If series is null, this property resets to default. Defaults to the first added series or zero if no series are added to the graph.

See also

primarySeries()

PySide6.QtDataVisualization.Q3DBars.setRowAxis(axis)
Parameters

axisPySide6.QtDataVisualization.QCategory3DAxis

Sets the axis of the active row to axis. Implicitly calls addAxis() to transfer the ownership of the axis to this graph.

If axis is null, a temporary default axis with no labels is created. This temporary axis is destroyed if another axis is set explicitly to the same orientation.

PySide6.QtDataVisualization.Q3DBars.setValueAxis(axis)
Parameters

axisPySide6.QtDataVisualization.QValue3DAxis

See also

valueAxis()

PySide6.QtDataVisualization.Q3DBars.valueAxis()
Return type

PySide6.QtDataVisualization.QValue3DAxis

See also

setValueAxis()

PySide6.QtDataVisualization.Q3DBars.valueAxisChanged(axis)
Parameters

axisPySide6.QtDataVisualization.QValue3DAxis