PySide6.QtGraphsWidgets.Q3DBarsWidgetItem¶

class Q3DBarsWidgetItem¶

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

Synopsis¶

Properties¶

barSeriesMarginᅟ - Margin between series columns in X and Z dimensions. Sensible values are on the range [0,1)
barSpacingᅟ - Bar spacing in the X and Z dimensions
barSpacingRelativeᅟ - Whether spacing is absolute or relative to bar thickness
barThicknessᅟ - Bar thickness ratio between the X and Z dimensions
columnAxisᅟ - Axis attached to the active column
floorLevelᅟ - Floor level for the bar graph in Y-axis data coordinates
multiSeriesUniformᅟ - Whether bars are to be scaled with proportions set to a single series bar even if there are multiple series displayed
primarySeriesᅟ - Primary series of the graph
rowAxisᅟ - Axis attached to the active row
selectedSeriesᅟ - Selected series or a null value
valueAxisᅟ

Methods¶

def __init__()
def addAxis()
def addSeries()
def axes()
def barSeriesMargin()
def barSpacing()
def barThickness()
def columnAxis()
def floorLevel()
def insertSeries()
def isBarSpacingRelative()
def isMultiSeriesUniform()
def primarySeries()
def releaseAxis()
def removeSeries()
def rowAxis()
def selectedSeries()
def seriesList()
def setBarSeriesMargin()
def setBarSpacing()
def setBarSpacingRelative()
def setBarThickness()
def setColumnAxis()
def setFloorLevel()
def setMultiSeriesUniform()
def setPrimarySeries()
def setRowAxis()
def setValueAxis()
def valueAxis()

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¶

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

This class enables developers to render 3D bar graphs and view them by freely rotating the scene. Rotation is achieved by holding down the right mouse button and moving the mouse, while zooming is accomplished using the mouse wheel. If enabled, selection is performed with the left mouse button. The scene can be reset to the default camera view by clicking the mouse wheel. On touch devices, rotation is achieved by tap-and-move, selection by tap-and-hold, and zooming by pinch.

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

Q3DBarsWidgetItem supports more than one visible series at the same time. All series don’t need to have the same number of rows and columns. Row and column labels are taken from the first added series unless explicitly defined for row and column axes.

Q3DBarsWidgetItem has transparency support. This feature allows you to adjust the opacity of the bars, making them partially see-through, fully transparent, or opaque.

How to construct a minimal Q3DBarsWidgetItem graph¶

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

quickWidget = QQuickWidget()
bars = Q3DBarsWidgetItem()
bars.setWidget(quickWidget)
bars.widget().setMinimumSize(QSize(256, 256))

After constructing Q3DBarsWidgetItem , you can set the data window by changing the range on the row and column axes. It is not mandatory, as the 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 example, let’s set the data window to display the first five rows and columns:

bars.rowAxis().setRange(0, 4)
bars.columnAxis().setRange(0, 4)

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

series = QBar3DSeries()
data = QBarDataRow()
data << QBarDataItem(1.0f) << QBarDataItem(3.0f) << QBarDataItem(7.5f) << QBarDataItem(5.0f)
     << QBarDataItem(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 okay; the rest of the rows will just be blank.

Finally you will need to set it visible:

bars.widget().show()

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

if __name__ == "__main__":

    app = QApplication([])
    quickWidget = QQuickWidget()
    bars = Q3DBarsWidgetItem()
    bars.setWidget(quickWidget)
    bars.widget().setMinimumSize(QSize(256, 256))
    bars.rowAxis().setRange(0, 4)
    bars.columnAxis().setRange(0, 4)
    series = QBar3DSeries()
    data = QBarDataRow()
    data << QBarDataItem(1.0f) << QBarDataItem(3.0f) << QBarDataItem(7.5f) << QBarDataItem(5.0f)
         << QBarDataItem(2.2f)
    series.dataProxy().addRow(data)
    bars.addSeries(series)
    bars.widget().show()
    sys.exit(app.exec())

And this is what those few lines of code produce:

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

See also

Q3DScatterWidgetItem Q3DSurfaceWidgetItem Qt Graphs C++ Classes for 3D

Note

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

property barSeriesMarginᅟ: QSizeF¶

This property holds Margin between series columns in X and Z dimensions. Sensible values are on the range [0,1)..

Preset to (0.0, 0.0) by default. This property enables showing bars from different series side by side, but with space between columns.

See also

barSpacing

Access functions:

barSeriesMargin()
setBarSeriesMargin()
Signal barSeriesMarginChanged()

property barSpacingᅟ: QSizeF¶

This property holds Bar spacing in the X and Z dimensions..

Preset to (1.0, 1.0) by default. Spacing is affected by the barSpacingRelative property.

See also

barSpacingRelative multiSeriesUniform barSeriesMargin

Access functions:

barSpacing()
setBarSpacing()
Signal barSpacingChanged()

property barSpacingRelativeᅟ: bool¶

This property holds Whether spacing is absolute or relative to bar thickness..

If it is true, the value of 0.0 means that the bars are placed side-to-side, 1.0 means that a space as wide as the thickness of one bar is left between the bars, and so on. Preset to true.

Access functions:

isBarSpacingRelative()
setBarSpacingRelative()
Signal barSpacingRelativeChanged()

property barThicknessᅟ: float¶

This property holds The bar thickness ratio between the X and Z dimensions..

The value 1.0 means that the bars are as wide as they are deep, whereas 0.5 makes them twice as deep as they are wide. Preset to 1.0 by default.

Access functions:

barThickness()
setBarThickness()
Signal barThicknessChanged()

property columnAxisᅟ: QCategory3DAxis¶

This property holds The axis attached to the active column..

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.

See also

addAxis() releaseAxis()

Access functions:

columnAxis()
setColumnAxis()
Signal columnAxisChanged()

property floorLevelᅟ: float¶

This property holds The floor level for the bar graph in Y-axis data coordinates..

The actual floor level will be restricted by the Y-axis minimum and maximum values. Defaults to zero.

Access functions:

floorLevel()
setFloorLevel()
Signal floorLevelChanged()

property multiSeriesUniformᅟ: bool¶

This property holds Whether bars are to be scaled with proportions set to a single series bar even if there are multiple series displayed..

If set to true, bar spacing will be correctly applied only to the X-axis. Preset to false by default.

Access functions:

isMultiSeriesUniform()
setMultiSeriesUniform()
Signal multiSeriesUniformChanged()

property primarySeriesᅟ: QBar3DSeries¶

This property holds The primary series of the graph..

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.

Access functions:

primarySeries()
setPrimarySeries()
Signal primarySeriesChanged()

property rowAxisᅟ: QCategory3DAxis¶

This property holds The axis attached to the active row..

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.

See also

addAxis() releaseAxis()

Access functions:

rowAxis()
setRowAxis()
Signal rowAxisChanged()

property selectedSeriesᅟ: QBar3DSeries¶

This property holds The selected series or a null value..

If selectionMode has the SelectionMultiSeries flag set, this property holds the series that owns the selected bar.

Access functions:

selectedSeries()
Signal selectedSeriesChanged()

property valueAxisᅟ: QValue3DAxis¶

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

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

See also

addAxis() releaseAxis()

Access functions:

valueAxis()
setValueAxis()
Signal valueAxisChanged()

__init__([parent=None])¶

Parameters:: parent – QObject

Constructs a new 3D bar graph with the optional parent.

addAxis(axis)¶

Parameters:: axis – QAbstract3DAxis

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

See also

releaseAxis() setValueAxis() setRowAxis() setColumnAxis()

addSeries(series)¶

Parameters:: series – 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 for 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.

See also

seriesList() primarySeries hasSeries()

axes()¶

Return type:: .list of QAbstract3DAxis

Returns the list of all added axes.

See also

addAxis()

barSeriesMargin()¶

Return type:: QSizeF

See also

setBarSeriesMargin()

Getter of property barSeriesMarginᅟ .

barSeriesMarginChanged(margin)¶

Parameters:: margin – QSizeF

Notification signal of property barSeriesMarginᅟ .

barSpacing()¶

Return type:: QSizeF

See also

setBarSpacing()

Getter of property barSpacingᅟ .

barSpacingChanged(spacing)¶

Parameters:: spacing – QSizeF

Notification signal of property barSpacingᅟ .

barSpacingRelativeChanged(relative)¶

Parameters:: relative – bool

Notification signal of property barSpacingRelativeᅟ .

barThickness()¶

Return type:: float

See also

setBarThickness()

Getter of property barThicknessᅟ .

barThicknessChanged(thicknessRatio)¶

Parameters:: thicknessRatio – float

Notification signal of property barThicknessᅟ .

columnAxis()¶

Return type:: QCategory3DAxis

See also

setColumnAxis()

Getter of property columnAxisᅟ .

columnAxisChanged(axis)¶

Parameters:: axis – QCategory3DAxis

Notification signal of property columnAxisᅟ .

floorLevel()¶

Return type:: float

See also

setFloorLevel()

Getter of property floorLevelᅟ .

floorLevelChanged(level)¶

Parameters:: level – float

Notification signal of property floorLevelᅟ .

insertSeries(index, series)¶

Parameters:

index – int
series – QBar3DSeries

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 the list is calculated as if the series was still in its old index, so the final index is actually the index decremented by one.

isBarSpacingRelative()¶

Return type:: bool

Getter of property barSpacingRelativeᅟ .

isMultiSeriesUniform()¶

Return type:: bool

Getter of property multiSeriesUniformᅟ .

multiSeriesUniformChanged(uniform)¶

Parameters:: uniform – bool

Notification signal of property multiSeriesUniformᅟ .

primarySeries()¶

Return type:: QBar3DSeries

See also

setPrimarySeries()

Getter of property primarySeriesᅟ .

primarySeriesChanged(series)¶

Parameters:: series – QBar3DSeries

Notification signal of property primarySeriesᅟ .

releaseAxis(axis)¶

Parameters:: axis – 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.

See also

addAxis() setValueAxis() setRowAxis() setColumnAxis()

removeSeries(series)¶

Parameters:: series – QBar3DSeries

Removes the series from the graph.

See also

hasSeries()

rowAxis()¶

Return type:: QCategory3DAxis

See also

setRowAxis()

Getter of property rowAxisᅟ .

rowAxisChanged(axis)¶

Parameters:: axis – QCategory3DAxis

Notification signal of property rowAxisᅟ .

selectedSeries()¶

Return type:: QBar3DSeries

Getter of property selectedSeriesᅟ .

selectedSeriesChanged(series)¶

Parameters:: series – QBar3DSeries

Notification signal of property selectedSeriesᅟ .

seriesList()¶

Return type:: .list of QBar3DSeries

Returns the list of series added to this graph.

See also

hasSeries()

setBarSeriesMargin(margin)¶

Parameters:: margin – QSizeF

See also

barSeriesMargin()

Setter of property barSeriesMarginᅟ .

setBarSpacing(spacing)¶

Parameters:: spacing – QSizeF

See also

barSpacing()

Setter of property barSpacingᅟ .

setBarSpacingRelative(relative)¶

Parameters:: relative – bool

See also

isBarSpacingRelative()

Setter of property barSpacingRelativeᅟ .

setBarThickness(thicknessRatio)¶

Parameters:: thicknessRatio – float

See also

barThickness()

Setter of property barThicknessᅟ .

setColumnAxis(axis)¶

Parameters:: axis – QCategory3DAxis

See also

columnAxis()

Setter of property columnAxisᅟ .

setFloorLevel(level)¶

Parameters:: level – float

See also

floorLevel()

Setter of property floorLevelᅟ .

setMultiSeriesUniform(uniform)¶

Parameters:: uniform – bool

See also

isMultiSeriesUniform()

Setter of property multiSeriesUniformᅟ .

setPrimarySeries(series)¶

Parameters:: series – QBar3DSeries

See also

primarySeries()

Setter of property primarySeriesᅟ .

setRowAxis(axis)¶

Parameters:: axis – QCategory3DAxis

See also

rowAxis()

Setter of property rowAxisᅟ .

setValueAxis(axis)¶

Parameters:: axis – QValue3DAxis

See also

valueAxis()

Setter of property valueAxisᅟ .

valueAxis()¶

Return type:: QValue3DAxis

See also

setValueAxis()

Getter of property valueAxisᅟ .

valueAxisChanged(axis)¶

Parameters:: axis – QValue3DAxis

Notification signal of property valueAxisᅟ .