HBoxPlotModelMapper QML Type | Qt Charts 5.11

Qt 5.11 | Qt Charts | QML Types | HBoxPlotModelMapper QML Type

Qt 5.11.0 Reference Documentation

# HBoxPlotModelMapper QML Type

Horizontal model mapper for box plot series. More...

Import Statement: | import QtCharts 2.2
Instantiates: | QHBoxPlotModelMapper

- List of all members, including inherited members

## Properties

- columnCount : int
- firstBoxSetRow : int
- firstColumn : int
- lastBoxSetRow : int
- model : SomeModel
- series : AbstractBarSeries

## Detailed Description

The HBoxPlotModelMapper type enables 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 a BoxPlotSeries type, so that each row in the data model defines a box-and-whiskers item and each column maps to the range and three median values of the box-and-whiskers item.

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

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

The following QML code snippet creates a box plot series with three box-and-whiskers items (assuming the model has at least four rows). Each box-and-whiskers item contains data starting from column 1. The name of an item is defined by the row header.

      BoxPlotSeries {
          HBoxPlotModelMapper {
              model: myCustomModel // QAbstractItemModel derived implementation
              firstBoxSetRow: 1
              lastBoxSetRow: 3
              firstColumn: 1
          }
      }

See also VBoxPlotModelMapper.

## Property Documentation

columnCount : int

The number of columns of the model that are mapped as the data for the box plot series. The minimum and default value is -1 (number limited to the number of columns in the model).

firstBoxSetRow : int

The row of the model is used as the data source for the first box-and-whiskers item. The default value is -1 (invalid mapping).

firstColumn : int

The column of the model that contains the first values of the box-and-whiskers items in the box plot series. The default value is 0.

lastBoxSetRow : int

The row of the model is used as the data source for the last box-and-whiskers item. The default value is -1 (invalid mapping).

model : SomeModel

The data model that is used by the mapper. You need to implement the model and expose it to QML.

Note: The model has to support adding and removing rows or columns and modifying the data in the cells.

series : AbstractBarSeries

The box plot series that is used by the mapper. All the data in the series is discarded when it is set to the mapper. When the new series is specified, the old series is disconnected (but it preserves its data).