class QHCandlestickModelMapper#

The QHCandlestickModelMapper class is a horizontal model mapper for a candlestick series. More

Inheritance diagram of PySide6.QtCharts.QHCandlestickModelMapper

Synopsis#

Properties#

  • closeColumnᅟ - Column of the model that contains the close values of the candlestick items in the series

  • firstSetRowᅟ - Row of the model that is used as the data source for the first item

  • highColumnᅟ - Column of the model that contains the high values of the candlestick items in the series

  • lastSetRowᅟ - Row of the model that is used as the data source for the last item

  • lowColumnᅟ - Column of the model that contains the low values of the candlestick items in the series

  • openColumnᅟ - Column of the model that contains the open values of the candlestick items in the series

  • timestampColumnᅟ - Column 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 horizontal model mapper is used to create a connection between a data model and QCandlestickSeries , so that each row in the data model defines a candlestick item and each column 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 closeColumnᅟ: int#

This property holds The column 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 firstSetRowᅟ: int#

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

The default value is -1 (invalid mapping).

Access functions:
property highColumnᅟ: int#

This property holds The column 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 lastSetRowᅟ: int#

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

The default value is -1 (invalid mapping).

Access functions:
property lowColumnᅟ: int#

This property holds The column 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 openColumnᅟ: int#

This property holds The column 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 timestampColumnᅟ: int#

This property holds The column 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 horizontal model mapper object which is a child of parent.

closeColumn()#
Return type:

int

See also

setCloseColumn()

Getter of property closeColumnᅟ .

closeColumnChanged()#

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

See also

closeColumn

Notification signal of property closeColumnᅟ .

firstSetRow()#
Return type:

int

See also

setFirstSetRow()

Getter of property firstSetRowᅟ .

firstSetRowChanged()#

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

See also

firstSetRow

Notification signal of property firstSetRowᅟ .

highColumn()#
Return type:

int

See also

setHighColumn()

Getter of property highColumnᅟ .

highColumnChanged()#

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

See also

highColumn

Notification signal of property highColumnᅟ .

lastSetRow()#
Return type:

int

See also

setLastSetRow()

Getter of property lastSetRowᅟ .

lastSetRowChanged()#

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

See also

lastSetRow

Notification signal of property lastSetRowᅟ .

lowColumn()#
Return type:

int

See also

setLowColumn()

Getter of property lowColumnᅟ .

lowColumnChanged()#

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

See also

lowColumn

Notification signal of property lowColumnᅟ .

openColumn()#
Return type:

int

See also

setOpenColumn()

Getter of property openColumnᅟ .

openColumnChanged()#

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

See also

openColumn

Notification signal of property openColumnᅟ .

setCloseColumn(closeColumn)#
Parameters:

closeColumn – int

See also

closeColumn()

Setter of property closeColumnᅟ .

setFirstSetRow(firstSetRow)#
Parameters:

firstSetRow – int

See also

firstSetRow()

Setter of property firstSetRowᅟ .

setHighColumn(highColumn)#
Parameters:

highColumn – int

See also

highColumn()

Setter of property highColumnᅟ .

setLastSetRow(lastSetRow)#
Parameters:

lastSetRow – int

See also

lastSetRow()

Setter of property lastSetRowᅟ .

setLowColumn(lowColumn)#
Parameters:

lowColumn – int

See also

lowColumn()

Setter of property lowColumnᅟ .

setOpenColumn(openColumn)#
Parameters:

openColumn – int

See also

openColumn()

Setter of property openColumnᅟ .

setTimestampColumn(timestampColumn)#
Parameters:

timestampColumn – int

Setter of property timestampColumnᅟ .

timestampColumn()#
Return type:

int

Getter of property timestampColumnᅟ .

timestampColumnChanged()#

Emitted when the column of the model that contains timestamp values is changed

See also

timestampColumn

Notification signal of property timestampColumnᅟ .