candle (Financial Time Series Toolbox)

Candle plot

Syntax

candle(tsobj)
candle(tsobj, color)
candle(tsobj, color, dateform)
candle(tsobj, color, dateform, ParameterName, ParameterValue, ...)
hcdl = candle(tsobj, color, dateform, ParameterName, 
ParameterValue, ...)

Arguments

tsobj
Financial time series object

color
(Optional) A three-element row vector representing RGB or a color identifier. (See plot in the MATLAB documentation.)

dateform
(Optional) Date string format used as the x-axis tick labels. (See datetick in the MATLAB documentation.) You can specify a dateform only when tsobj does not contain time-of-day data. If tsobj contains time-of-day data, dateform is retricted to 'dd-mmm-yyyy HH:MM'.

`tsobj`	Financial time series object
`color`	(Optional) A three-element row vector representing RGB or a color identifier. (See `plot` in the MATLAB documentation.)
`dateform`	(Optional) Date string format used as the x-axis tick labels. (See `datetick` in the MATLAB documentation.) You can specify a `dateform` only when `tsobj` does not contain time-of-day data. If `tsobj` contains time-of-day data, `dateform` is retricted to `'dd-mmm-yyyy HH:MM'`.

Description

candle(tsobj) generates a candle plot of the data in the financial time series object tsobj. tsobj must contain at least four data series representing the high, low, open, and closing prices. These series must have the names High, Low, Open, and Close (case-insensitive).

candle(tsobj, color) additionally specifies the color of the candle box.

candle(tsobj, color, dateform) additionally specifies the date string format used as the x-axis tick labels. See datestr in the Financial Toolbox documentation for a list of date string formats.

candle(tsobj, color, dateform, ParameterName, ParameterValue, ...) indicates the actual name(s) of the required data series if the data series do not have the default names. ParameterName can be

HighName: high prices series name
LowName: low prices series name
OpenName: open prices series name
CloseName: closing prices series name

hcdl = candle(tsobj, color, dateform, ParameterName, ParameterValue, ...) returns the handle to the patch objects and the line object that make up the candle plot. hdcl is a three-element column vector representing the handles to the two patches and one line that forms the candle plot.

Examples

Create a candle plot for Disney stock for the dates March 31, 1998 through April 30, 1998:

load disney.mat
candle(dis('3/31/98::4/30/98'))
title('Disney 3/31/98 to 4/30/98')

See Also

chartfts, highlow, plot

candle in the Financial Toolbox documentation

datetick and plot in the MATLAB documentation

busdays chaikosc