- Qt 5.15
- Qt Charts
- C++ Classes
- QVCandlestickModelMapper
- Qt Charts | Commercial or GPLv3

# QVCandlestickModelMapper Class

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

Header: | #include <QVCandlestickModelMapper>
Since: | Qt 5.8
Instantiated By: | VCandlestickModelMapper
Inherits: | QCandlestickModelMapper

This class was introduced in Qt 5.8.

- List of all members, including inherited members

## Properties

- closeRow : int
- firstSetColumn : int
- highRow : int
- lastSetColumn : int

- lowRow : int
- openRow : int
- timestampRow : int

## Public Functions

| QVCandlestickModelMapper(QObject *parent = nullptr)
int | closeRow() const
int | firstSetColumn() const
int | highRow() const
int | lastSetColumn() const
int | lowRow() const
int | openRow() const
void | setCloseRow(int closeRow)
void | setFirstSetColumn(int firstSetColumn)
void | setHighRow(int highRow)
void | setLastSetColumn(int lastSetColumn)
void | setLowRow(int lowRow)
void | setOpenRow(int openRow)
void | setTimestampRow(int timestampRow)
int | timestampRow() const

## Reimplemented Public Functions

virtual Qt::Orientation | orientation() const override

## Signals

void | closeRowChanged()
void | firstSetColumnChanged()
void | highRowChanged()
void | lastSetColumnChanged()
void | lowRowChanged()
void | openRowChanged()
void | timestampRowChanged()

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

See also QCandlestickSeries, QCandlestickSet, and QHCandlestickModelMapper.

## Property Documentation

### 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:

int | closeRow() const
void | setCloseRow(int closeRow)

Notifier signal:

void | closeRowChanged()

### 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:

int | firstSetColumn() const
void | setFirstSetColumn(int firstSetColumn)

Notifier signal:

void | firstSetColumnChanged()

### 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:

int | highRow() const
void | setHighRow(int highRow)

Notifier signal:

void | highRowChanged()

### 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:

int | lastSetColumn() const
void | setLastSetColumn(int lastSetColumn)

Notifier signal:

void | lastSetColumnChanged()

### 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:

int | lowRow() const
void | setLowRow(int lowRow)

Notifier signal:

void | lowRowChanged()

### 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:

int | openRow() const
void | setOpenRow(int openRow)

Notifier signal:

void | openRowChanged()

### 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:

int | timestampRow() const
void | setTimestampRow(int timestampRow)

Notifier signal:

void | timestampRowChanged()

## Member Function Documentation

### QVCandlestickModelMapper::QVCandlestickModelMapper(QObject *parent = nullptr)

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

### `[signal]` void QVCandlestickModelMapper::closeRowChanged()

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

Note: Notifier signal for property closeRow.

See also closeRow.

### `[signal]` void QVCandlestickModelMapper::firstSetColumnChanged()

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

Note: Notifier signal for property firstSetColumn.

See also firstSetColumn.

### `[signal]` void QVCandlestickModelMapper::highRowChanged()

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

Note: Notifier signal for property highRow.

See also highRow.

### `[signal]` void QVCandlestickModelMapper::lastSetColumnChanged()

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

Note: Notifier signal for property lastSetColumn.

See also lastSetColumn.

### `[signal]` void QVCandlestickModelMapper::lowRowChanged()

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

Note: Notifier signal for property lowRow.

See also lowRow.

### `[signal]` void QVCandlestickModelMapper::openRowChanged()

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

Note: Notifier signal for property openRow.

See also openRow.

### `[signal]` void QVCandlestickModelMapper::timestampRowChanged()

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

Note: Notifier signal for property timestampRow.

See also timestampRow.

### `[override virtual]` Qt::Orientation QVCandlestickModelMapper::orientation() const

Reimplements: QCandlestickModelMapper::orientation() const.

Returns Qt::Vertical. This means that values of the item are read from columns.