QCandlestickModelMapper#

Abstract model mapper class for candlestick series. More…

Inherited by: QVCandlestickModelMapper, QHCandlestickModelMapper

Synopsis#

Properties#

model - Defines the model that is used by the mapper
series - Defines the QCandlestickSeries object that is used by the mapper

Functions#

def close ()
def firstSetSection ()
def high ()
def lastSetSection ()
def low ()
def model ()
def open ()
def series ()
def setClose (close)
def setFirstSetSection (firstSetSection)
def setHigh (high)
def setLastSetSection (lastSetSection)
def setLow (low)
def setModel (model)
def setOpen (open)
def setSeries (series)
def setTimestamp (timestamp)
def timestamp ()

Virtual functions#

def orientation ()

Signals#

def modelReplaced ()
def seriesReplaced ()

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 allow the use of a QAbstractItemModel -derived model as a data source for a chart series, creating a connection between a QCandlestickSeries and the model object. A model mapper maintains an equal size across all QCandlestickSets .

Note

The model used must support adding and removing rows/columns and modifying the data of the cells.

class PySide6.QtCharts.QCandlestickModelMapper([parent=None])#

Parameters:: parent – PySide6.QtCore.QObject

Constructs a model mapper object as a child of parent.

Note

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

property PᅟySide6.QtCharts.QCandlestickModelMapper.model: PySide6.QtCore.QAbstractItemModel#

This property Defines the model that is used by the mapper..

Access functions:

model ()
setModel (model)
Signal modelReplaced ()

property PᅟySide6.QtCharts.QCandlestickModelMapper.series: PySide6.QtCharts.QCandlestickSeries#

This property Defines the QCandlestickSeries object that is used by the mapper..

Note

All data in the series is discarded when it is set to the mapper. When a new series is specified, the old series is disconnected (preserving its data).

Access functions:

series ()
setSeries (series)
Signal seriesReplaced ()

PySide6.QtCharts.QCandlestickModelMapper.close()#

Return type:: int

Returns the row/column of the model that contains the close values of the sets in the series. Default value is -1 (invalid mapping).

See also

setClose()

PySide6.QtCharts.QCandlestickModelMapper.firstSetSection()#

Return type:: int

Returns the section of the model that is used as the data source for the first candlestick set. Default value is -1 (invalid mapping).

See also

setFirstSetSection()

PySide6.QtCharts.QCandlestickModelMapper.high()#

Return type:: int

Returns the row/column of the model that contains the high values of the sets in the series. Default value is -1 (invalid mapping).

See also

setHigh()

PySide6.QtCharts.QCandlestickModelMapper.lastSetSection()#

Return type:: int

Returns the section of the model that is used as the data source for the last candlestick set. Default value is -1 (invalid mapping).

See also

setLastSetSection()

PySide6.QtCharts.QCandlestickModelMapper.low()#

Return type:: int

Returns the row/column of the model that contains the low values of the sets in the series. Default value is -1 (invalid mapping).

See also

setLow()

PySide6.QtCharts.QCandlestickModelMapper.model()#

Return type:: PySide6.QtCore.QAbstractItemModel

See also

setModel()

Getter of property model .

PySide6.QtCharts.QCandlestickModelMapper.modelReplaced()#

Emitted when the model, to which the mapper is connected, has changed.

See also

model

Notification signal of property model .

PySide6.QtCharts.QCandlestickModelMapper.open()#

Return type:: int

Returns the row/column of the model that contains the open values of the sets in the series. Default value is -1 (invalid mapping).

See also

setOpen()

abstract PySide6.QtCharts.QCandlestickModelMapper.orientation()#

Return type:: Orientation

Returns the orientation that is used when QCandlestickModelMapper accesses the model. This determines whether the consecutive values of the set are read from rows ( Horizontal ) or from columns ( Vertical ).

PySide6.QtCharts.QCandlestickModelMapper.series()#

Return type:: PySide6.QtCharts.QCandlestickSeries

See also

setSeries()

Getter of property series .

PySide6.QtCharts.QCandlestickModelMapper.seriesReplaced()#

Emitted when the series to which mapper is connected to has changed.

See also

series

Notification signal of property series .

PySide6.QtCharts.QCandlestickModelMapper.setClose(close)#

Parameters:: close – int

Sets the row/column of the model that contains the close values of the sets in the series. Default value is -1 (invalid mapping).

See also

close()

PySide6.QtCharts.QCandlestickModelMapper.setFirstSetSection(firstSetSection)#

Parameters:: firstSetSection – int

Sets the section of the model that is used as the data source for the first candlestick set. Parameter firstSetSection specifies the section of the model. Default value is -1.

See also

firstSetSection()

PySide6.QtCharts.QCandlestickModelMapper.setHigh(high)#

Parameters:: high – int

Sets the row/column of the model that contains the high values of the sets in the series. Default value is -1 (invalid mapping).

See also

high()

PySide6.QtCharts.QCandlestickModelMapper.setLastSetSection(lastSetSection)#

Parameters:: lastSetSection – int

Sets the section of the model that is used as the data source for the last candlestick set. Parameter lastSetSection specifies the section of the model. Default value is -1.

See also

lastSetSection()

PySide6.QtCharts.QCandlestickModelMapper.setLow(low)#

Parameters:: low – int

Sets the row/column of the model that contains the low values of the sets in the series. Default value is -1 (invalid mapping).

See also

low()

PySide6.QtCharts.QCandlestickModelMapper.setModel(model)#

Parameters:: model – PySide6.QtCore.QAbstractItemModel

See also

model()

Setter of property model .

PySide6.QtCharts.QCandlestickModelMapper.setOpen(open)#

Parameters:: open – int

Sets the row/column of the model that contains the open values of the sets in the series. Default value is -1 (invalid mapping).

See also

open()

PySide6.QtCharts.QCandlestickModelMapper.setSeries(series)#

Parameters:: series – PySide6.QtCharts.QCandlestickSeries

See also

series()

Setter of property series .

PySide6.QtCharts.QCandlestickModelMapper.setTimestamp(timestamp)#

Parameters:: timestamp – int

Sets the row/column of the model that contains the timestamp values of the sets in the series. Default value is -1 (invalid mapping).

See also

timestamp()

PySide6.QtCharts.QCandlestickModelMapper.timestamp()#

Return type:: int

Returns the row/column of the model that contains the timestamp values of the sets in the series. Default value is -1 (invalid mapping).

See also

setTimestamp()