Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

candle (fts)

Time series 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.)

dateform

(Optional) Date character vector format used as the x-axis tick labels. (See datetick.) You can specify a dateform only when tsobj does not contain time-of-day data. If tsobj contains time-of-day data, dateform is restricted 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 character vector format used as the x-axis tick labels. See datestr for a list of date character vector formats.

candle(tsobj,color,dateform,'ParameterName',ParameterValue, ...) indicates the actual names 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

collapse all

This example shows how to 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')

Introduced before R2006a

Was this topic helpful?