QScatter3DSeries Class | Qt Data Visualization 5.9

Qt 5.9 | Qt Data Visualization | C++ Classes | QScatter3DSeries

Qt 5.9.6 Reference Documentation

# QScatter3DSeries Class

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

Header: | #include <QScatter3DSeries>
Since: | QtDataVisualization 1.0
Instantiated By: | Scatter3DSeries
Inherits: | QAbstract3DSeries

- List of all members, including inherited members

## Properties

- dataProxy : QScatterDataProxy *
- itemSize : float
- selectedItem : int

- 17 properties inherited from QAbstract3DSeries
- 1 property inherited from QObject

## Public Functions

| QScatter3DSeries(QObject *parent = Q_NULLPTR)
| QScatter3DSeries(QScatterDataProxy *dataProxy, QObject *parent = Q_NULLPTR)
virtual | ~QScatter3DSeries()
QScatterDataProxy * | dataProxy() const
float | itemSize() const
int | selectedItem() const
void | setDataProxy(QScatterDataProxy *proxy)
void | setItemSize(float size)
void | setSelectedItem(int index)

- 33 public functions inherited from QAbstract3DSeries
- 32 public functions inherited from QObject

## Signals

void | dataProxyChanged(QScatterDataProxy *proxy)
void | itemSizeChanged(float size)
void | selectedItemChanged(int index)

- 16 signals inherited from QAbstract3DSeries
- 2 signals inherited from QObject

## Static Public Members

int | invalidSelectionIndex()

- 10 static public members inherited from QObject

### Additional Inherited Members

- 1 public slot inherited from QObject
- 1 public variable inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject

## Detailed Description

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

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

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 it.

QScatter3DSeries supports the following format tags for QAbstract3DSeries::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 QValue3DAxis::setLabelFormat().
@yLabel | Item value formatted using the format of the y-axis. For more information, see QValue3DAxis::setLabelFormat().
@zLabel | Item value formatted using the format of the z-axis. For more information, see QValue3DAxis::setLabelFormat().
@seriesName | Name of the series

For example:

      proxy->setItemLabelFormat(QStringLiteral("@valueTitle for (@rowLabel, @colLabel): %.1f"));

See also Qt Data Visualization Data Handling.

## Property Documentation

### dataProxy : QScatterDataProxy *

This property holds the active data proxy.

Access functions:

QScatterDataProxy * | dataProxy() const
void | setDataProxy(QScatterDataProxy *proxy)

Notifier signal:

void | dataProxyChanged(QScatterDataProxy *proxy)

### itemSize : float

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:

float | itemSize() const
void | setItemSize(float size)

Notifier signal:

void | itemSizeChanged(float size)

### selectedItem : int

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

Access functions:

int | selectedItem() const
void | setSelectedItem(int index)

Notifier signal:

void | selectedItemChanged(int index)

## Member Function Documentation

### QScatter3DSeries::QScatter3DSeries(QObject *parent = Q_NULLPTR)

Constructs a scatter 3D series with the parent parent.

### QScatter3DSeries::QScatter3DSeries(QScatterDataProxy *dataProxy, QObject *parent = Q_NULLPTR)

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

### `[virtual]` QScatter3DSeries::~QScatter3DSeries()

Deletes the scatter 3D series.

### `[static]` int QScatter3DSeries::invalidSelectionIndex()

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

See also QAbstract3DGraph::clearSelection().

### void QScatter3DSeries::setDataProxy(QScatterDataProxy *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.

Note: Setter function for property dataProxy.

See also dataProxy().

### void QScatter3DSeries::setSelectedItem(int index)

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 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 to the series before the selected item will adjust the selection so that the same item will stay selected.

Note: Setter function for property selectedItem.

See also selectedItem() and QAbstract3DGraph::clearSelection().