PySide6.QtGraphs.QScatter3DSeries

class QScatter3DSeries

The QScatter3DSeries class represents a data series in a 3D scatter graph.

Details

Warning

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

This class manages the series-specific visual elements, as well as the series data (via a data proxy).

Regarding the proxy-series relationship, it is crucial to highlight a couple of key points. In this context, data is stored in series and users can access the dataset through the series. This series is controlled or represented by a proxy object. Thus, the proxy can be used to manage various operations on the data and update the actual dataset. However, it is necessary to create a series associated with this proxy to edit the dataset.

If no data proxy is set explicitly for the series, the series creates a default proxy. Setting another proxy will destroy the existing proxy and all data added to the series.

QScatter3DSeries supports the following format tags for setItemLabelFormat() :

@xTitle	Title from x-axis
@yTitle	Title from y-axis
@zTitle	Title from z-axis
@xLabel	Item value formatted using the format of the x-axis. For more information, see labelFormat .
@yLabel	Item value formatted using the format of the y-axis. For more information, see labelFormat .
@zLabel	Item value formatted using the format of the z-axis. For more information, see labelFormat .
@seriesName	Name of the series

For example:

proxy.setItemLabelFormat("@yTitle for (@xLabel, @zLabel): %.1f")

See also

Qt Graphs Data Handling with 3D

Inherited by: QSpline3DSeries

Synopsis

Properties

• dataArrayᅟ - Data array for the series

• dataProxyᅟ - Active data proxy

• itemSizeᅟ - Item size for the series

• scaleArrayᅟ - Scale array for the series

• selectedItemᅟ - Item that is selected in the series

Methods

• def __init__()

• def clearArray()

• def clearScaleArray()

• def dataArray()

• def dataProxy()

• def itemSize()

• def scaleArray()

• def selectedItem()

• def setDataArray()

• def setDataProxy()

• def setItemSize()

• def setScaleArray()

• def setSelectedItem()

Signals

• def dataArrayChanged()

• def dataProxyChanged()

• def itemSizeChanged()

• def scaleArrayChanged()

• def selectedItemChanged()

Static functions

• def invalidSelectionIndex()

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

Note

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

property dataArrayᅟ: list of QScatterDataItem

This property holds Data array for the series..

Holds the reference to the data array.

dataArrayChanged signal is emitted when data array is set, unless newDataArray is identical to the previous one.

Note

Before doing anything regarding the data array, a series must be created for the relevant proxy.

See also

clearArray()

Access functions:

• dataArray()

• setDataArray()

• Signal dataArrayChanged()

property dataProxyᅟ: QScatterDataProxy

This property holds The active data proxy..

Sets the active data proxy for the series to proxy. The series assumes ownership of any proxy set to it and deletes any previously set proxy when a new one is added. The proxy argument cannot be null or set to another series.

Access functions:

• dataProxy()

• setDataProxy()

• Signal dataProxyChanged()

property itemSizeᅟ: float

This property holds Item size for the series..

The size must be between 0.0f and 1.0f. Setting the size to 0.0f causes the item size to be automatically scaled based on the total number of items in all the series for the graph.

The preset default is 0.0f.

Access functions:

• itemSize()

• setItemSize()

• Signal itemSizeChanged()

property scaleArrayᅟ: list of list of 3D

This property holds Scale array for the series..

Holds the reference to the scale array.

scaleArrayChanged signal is emitted when scale array is set, unless newScaleArray is identical to the previous one.

Note

Before doing anything regarding the scale array, a series must be created for the relevant proxy.

Note

If a scale is not specified for the data, a default value of (1.0,1.0,1.0) will be used.

See also

clearScaleArray()

Access functions:

• scaleArray()

• setScaleArray()

• Signal scaleArrayChanged()

property selectedItemᅟ: int

This property holds The item that is selected in the series..

Selects the item at the index index in the data array of the series. Only one item can be selected at a time.

To clear the selection from this series, invalidSelectionIndex() is set as index. If this series is added to a graph, the graph can adjust the selection according to user interaction or if it becomes invalid. Selecting an item on another added series will also clear the selection.

Removing items from or inserting items into the series before the selected item will adjust the selection so that the same item will stay selected.

See also

clearSelection()

Access functions:

• selectedItem()

• setSelectedItem()

• Signal selectedItemChanged()

__init__([parent=None])

Parameters:

parent – QObject

Constructs a scatter 3D series with the parent parent.

__init__(dataProxy[, parent=None])

Parameters:

• dataProxy – QScatterDataProxy

• parent – QObject

Constructs a scatter 3D series with the data proxy dataProxy and the parent parent.

clearArray()

Clears the data array.

clearScaleArray()

Clears the scale array.

dataArray()

Return type:

.list of QScatterDataItem

See also

setDataArray()

Getter of property dataArrayᅟ .

dataArrayChanged(array)

Parameters:

array – .list of QScatterDataItem

Notification signal of property dataArrayᅟ .

dataProxy()

Return type:

QScatterDataProxy

See also

setDataProxy()

Getter of property dataProxyᅟ .

dataProxyChanged(proxy)

Parameters:

proxy – QScatterDataProxy

Notification signal of property dataProxyᅟ .

static invalidSelectionIndex()

Return type:

int

Returns an invalid index for selection. This index is set to the selectedItem property to clear the selection from this series.

See also

clearSelection()

itemSize()

Return type:

float

See also

setItemSize()

Getter of property itemSizeᅟ .

itemSizeChanged(size)

Parameters:

size – float

Notification signal of property itemSizeᅟ .

scaleArray()

Return type:

.list of list of 3D

See also

setScaleArray()

Getter of property scaleArrayᅟ .

scaleArrayChanged(scaleArray)

Parameters:

scaleArray – .list of list of 3D

Notification signal of property scaleArrayᅟ .

selectedItem()

Return type:

int

See also

setSelectedItem()

Getter of property selectedItemᅟ .

selectedItemChanged(index)

Parameters:

index – int

Notification signal of property selectedItemᅟ .

setDataArray(newDataArray)

Parameters:

newDataArray – .list of QScatterDataItem

See also

dataArray()

Setter of property dataArrayᅟ .

setDataProxy(proxy)

Parameters:

proxy – QScatterDataProxy

See also

dataProxy()

Setter of property dataProxyᅟ .

setItemSize(size)

Parameters:

size – float

See also

itemSize()

Setter of property itemSizeᅟ .

setScaleArray(newScaleArray)

Parameters:

newScaleArray – .list of list of 3D

See also

scaleArray()

Setter of property scaleArrayᅟ .

setSelectedItem(index)

Parameters:

index – int

See also

selectedItem()

Setter of property selectedItemᅟ .