class QVCandlestickModelMapper#

The QVCandlestickModelMapper class is a vertical model mapper for a candlestick series. More

Inheritance diagram of PySide6.QtCharts.QVCandlestickModelMapper

Synopsis#

Properties#

  • closeRowᅟ - Row of the model that contains the close values of the candlestick items in the series

  • firstSetColumnᅟ - Column of the model that is used as the data source for the first item

  • highRowᅟ - Row of the model that contains the high values of the candlestick items in the series

  • lastSetColumnᅟ - Column of the model that is used as the data source for the last item

  • lowRowᅟ - Row of the model that contains the low values of the candlestick items in the series

  • openRowᅟ - Row of the model that contains the open values of the candlestick items in the series

  • timestampRowᅟ - Row of the model that contains the timestamp values of the candlestick items in the series

Methods#

Signals#

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#

Model mappers enable using a data model derived from the QAbstractItemModel class as a data source for a chart. A vertical model mapper is used to create a connection between a data model and QCandlestickSeries , so that each column in the data model defines a candlestick item and each row maps to the open, high, low, close, and timestamp values of the candlestick item.

Both model and candlestick series properties can be used to manipulate the data. The model mapper keeps the candlestick series and the data model in sync.

The model mapper ensures that all the candlestick items in the candlestick series have equal sizes. Therefore, adding or removing a value from a candlestick item causes the same change to be made in all the candlestick items in the candlestick series.

Note

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

property closeRowᅟ: int#

This property holds The row of the model that contains the close values of the candlestick items in the series..

The default value is -1 (invalid mapping).

Access functions:
property firstSetColumnᅟ: int#

This property holds The column of the model that is used as the data source for the first item..

The default value is -1 (invalid mapping).

Access functions:
property highRowᅟ: int#

This property holds The row of the model that contains the high values of the candlestick items in the series..

The default value is -1 (invalid mapping).

Access functions:
property lastSetColumnᅟ: int#

This property holds The column of the model that is used as the data source for the last item..

The default value is -1 (invalid mapping).

Access functions:
property lowRowᅟ: int#

This property holds The row of the model that contains the low values of the candlestick items in the series..

The default value is -1 (invalid mapping).

Access functions:
property openRowᅟ: int#

This property holds The row of the model that contains the open values of the candlestick items in the series..

The default value is -1 (invalid mapping).

Access functions:
property timestampRowᅟ: int#

This property holds The row of the model that contains the timestamp values of the candlestick items in the series..

The default value is -1 (invalid mapping).

Access functions:
__init__([parent=None])#
Parameters:

parentQObject

Constructs a vertical model mapper object which is a child of parent.

closeRow()#
Return type:

int

See also

setCloseRow()

Getter of property closeRowᅟ .

closeRowChanged()#

Emitted when the row of the model that contains close values is changed.

See also

closeRow

Notification signal of property closeRowᅟ .

firstSetColumn()#
Return type:

int

Getter of property firstSetColumnᅟ .

firstSetColumnChanged()#

Emitted when the column of the model that contains the data of the first item is changed.

See also

firstSetColumn

Notification signal of property firstSetColumnᅟ .

highRow()#
Return type:

int

See also

setHighRow()

Getter of property highRowᅟ .

highRowChanged()#

Emitted when the row of the model that contains high values is changed.

See also

highRow

Notification signal of property highRowᅟ .

lastSetColumn()#
Return type:

int

Getter of property lastSetColumnᅟ .

lastSetColumnChanged()#

Emitted when the column of the model that contains the data of the last item is changed.

See also

lastSetColumn

Notification signal of property lastSetColumnᅟ .

lowRow()#
Return type:

int

See also

setLowRow()

Getter of property lowRowᅟ .

lowRowChanged()#

Emitted when the row of the model that contains low values is changed.

See also

lowRow

Notification signal of property lowRowᅟ .

openRow()#
Return type:

int

See also

setOpenRow()

Getter of property openRowᅟ .

openRowChanged()#

Emitted when the row of the model that contains open values is changed.

See also

openRow

Notification signal of property openRowᅟ .

setCloseRow(closeRow)#
Parameters:

closeRow – int

See also

closeRow()

Setter of property closeRowᅟ .

setFirstSetColumn(firstSetColumn)#
Parameters:

firstSetColumn – int

See also

firstSetColumn()

Setter of property firstSetColumnᅟ .

setHighRow(highRow)#
Parameters:

highRow – int

See also

highRow()

Setter of property highRowᅟ .

setLastSetColumn(lastSetColumn)#
Parameters:

lastSetColumn – int

See also

lastSetColumn()

Setter of property lastSetColumnᅟ .

setLowRow(lowRow)#
Parameters:

lowRow – int

See also

lowRow()

Setter of property lowRowᅟ .

setOpenRow(openRow)#
Parameters:

openRow – int

See also

openRow()

Setter of property openRowᅟ .

setTimestampRow(timestampRow)#
Parameters:

timestampRow – int

See also

timestampRow()

Setter of property timestampRowᅟ .

timestampRow()#
Return type:

int

Getter of property timestampRowᅟ .

timestampRowChanged()#

Emitted when the row of the model that contains timestamp values is changed.

See also

timestampRow

Notification signal of property timestampRowᅟ .