kandy 0.7.0 Help

statCandlestick

The statCandlestick function creates a new plotting context with new dataset which contains the "candlestick" statistic calculated on sample of four numeric variables (open, high, low, close) in several groups defined by x. This statistic is used to plot financial data, showing the increase or decrease in value.

Arguments

X

Type of x categories

x

Required

Iterable<X> Column<X> String

The x argument is used to provide the x-categories of candle.

open

Required

Iterable Column String

The open argument is used to provide the opening value of candle.

high

Required

Iterable Column String

The high argument is used to provide the high (maximum) value of candle.

low

Required

Iterable Column String

The low argument is used to provide the low (minimum) value of candle.

close

Required

Iterable Column String

The close argument is used to provide the closing value of candle.

Statistic properties

In this context, there are the following statistical properties that can be used to create mappings, customize tooltips, etc.

Stat.x

Column<X>

The Stat.x contains candle x category.

Stat.open

Column<Double>

The Stat.open contains candle open. Equals to input open.

Stat.close

Column<Double>

The Stat.close contains candle close. Equals to input close.

Stat.min

Column<Double>

The Stat.min contains candle minimum. Equals to input low.

Stat.lower

Column<Double>

The Stat.lower contains lower candle edges (i.e. smaller of open/close).

Stat.upper

Column<Double>

The Stat.upper contains upper candle edges (i.e. greater of open/close).

Stat.max

Column<Double>

The Stat.min contains candle maximum. Equals to input high.

Stat.isIncreased

Column<Boolean>

The Stat.isIncreased contains candle increase indicator: true if close value is greater than open value.

Last modified: 25 March 2024