- Qt 6.8
- Qt Charts
- C++ Classes
- QCandlestickSet
- Qt Charts | Commercial or GPLv3

# QCandlestickSet Class

The QCandlestickSet class represents a single candlestick item in a candlestick chart. More...

Header: | `#include <QCandlestickSet>`
In QML: | CandlestickSet
Inherits: | QObject

- List of all members, including inherited members

## Properties

brush : QBrush close : qreal high : qreal low : qreal | open : qreal pen : QPen timestamp : qreal

## Public Functions

| QCandlestickSet(qreal timestamp = 0.0, QObject *parent = nullptr)
| QCandlestickSet(qreal open, qreal high, qreal low, qreal close, qreal timestamp = 0.0, QObject *parent = nullptr)
virtual | ~QCandlestickSet()
QBrush | brush() const
qreal | close() const
qreal | high() const
qreal | low() const
qreal | open() const
QPen | pen() const
void | setBrush(const QBrush &brush)
void | setClose(qreal close)
void | setHigh(qreal high)
void | setLow(qreal low)
void | setOpen(qreal open)
void | setPen(const QPen &pen)
void | setTimestamp(qreal timestamp)
qreal | timestamp() const

## Signals

void | brushChanged()
void | clicked()
void | closeChanged()
void | doubleClicked()
void | highChanged()
void | hovered(bool status)
void | lowChanged()
void | openChanged()
void | penChanged()
void | pressed()
void | released()
void | timestampChanged()

## Detailed Description

Five values are needed to create a graphical representation of a candlestick item: open, high, low, close, and timestamp. These values can be either passed to a QCandlestickSet constructor or set by using setOpen(), setHigh(), setLow(), setClose(), and setTimestamp().

See also QCandlestickSeries.

## Property Documentation

### brush : QBrush

This property holds the brush used to fill the candlestick item.

Access functions:

QBrush | brush() const
void | setBrush(const QBrush &brush)

Notifier signal:

void | brushChanged()

### close : qreal

This property holds the close value of the candlestick item.

Access functions:

qreal | close() const
void | setClose(qreal close)

Notifier signal:

void | closeChanged()

### high : qreal

This property holds the high value of the candlestick item.

Access functions:

qreal | high() const
void | setHigh(qreal high)

Notifier signal:

void | highChanged()

### low : qreal

This property holds the low value of the candlestick item.

Access functions:

qreal | low() const
void | setLow(qreal low)

Notifier signal:

void | lowChanged()

### open : qreal

This property holds the open value of the candlestick item.

Access functions:

qreal | open() const
void | setOpen(qreal open)

Notifier signal:

void | openChanged()

### pen : QPen

This property holds the pen used to draw the lines of the candlestick item.

Access functions:

QPen | pen() const
void | setPen(const QPen &pen)

Notifier signal:

void | penChanged()

### timestamp : qreal

This property holds the timestamp value of the candlestick item.

Access functions:

qreal | timestamp() const
void | setTimestamp(qreal timestamp)

Notifier signal:

void | timestampChanged()

## Member Function Documentation

### `[explicit]` QCandlestickSet::QCandlestickSet(qreal timestamp = 0.0, QObject *parent = nullptr)

Constructs a candlestick item with an optional timestamp and a parent.

### `[explicit]` QCandlestickSet::QCandlestickSet(qreal open, qreal high, qreal low, qreal close, qreal timestamp = 0.0, QObject *parent = nullptr)

Constructs a candlestick item with given ordered values. The values open, high, low, and close are mandatory. The values timestamp and parent are optional.

### `[virtual noexcept]` QCandlestickSet::~QCandlestickSet()

Destroys the candlestick item.

### `[signal]` void QCandlestickSet::brushChanged()

This signal is emitted when the candlestick item brush changes.

Note: Notifier signal for property brush.

See also brush.

### `[signal]` void QCandlestickSet::clicked()

This signal is emitted when the candlestick item is clicked.

### `[signal]` void QCandlestickSet::closeChanged()

This signal is emitted when the candlestick item close value changes.

Note: Notifier signal for property close.

See also close.

### `[signal]` void QCandlestickSet::doubleClicked()

This signal is emitted when the user double-clicks a candlestick item.

### `[signal]` void QCandlestickSet::highChanged()

This signal is emitted when the candlestick item high value changes.

Note: Notifier signal for property high.

See also high.

### `[signal]` void QCandlestickSet::hovered(bool status)

This signal is emitted when a mouse is hovered over a candlestick item.

When the mouse moves over the item, status turns `true`, and when the mouse moves away again, it turns `false`.

### `[signal]` void QCandlestickSet::lowChanged()

This signal is emitted when the candlestick item low value changes.

Note: Notifier signal for property low.

See also low.

### `[signal]` void QCandlestickSet::openChanged()

This signal is emitted when the candlestick item open value changes.

Note: Notifier signal for property open.

See also open.

### `[signal]` void QCandlestickSet::penChanged()

This signal is emitted when the candlestick item pen changes.

Note: Notifier signal for property pen.

See also pen.

### `[signal]` void QCandlestickSet::pressed()

This signal is emitted when the user clicks the candlestick item and holds down the mouse button.

### `[signal]` void QCandlestickSet::released()

This signal is emitted when the user releases the mouse press on the candlestick item.

### `[signal]` void QCandlestickSet::timestampChanged()

This signal is emitted when the candlestick item timestamp changes.

Note: Notifier signal for property timestamp.

See also timestamp.