[Ln,Bd,Range] = band(X,Low,High...)
[Ln,Bd,Range] = band(Range,X,Low,High,...)
[Ln,Bd,Range] = band(Ax,Range,X,Low,High,...)
Ax
[ numeric ] - Handle to axes in which the graph will be plotted; if not specified, the current axes will used.
Range
[ numeric ] - Date range; if not specified the entire range of the input time series object will be plotted.
X
[ tseries ] - Input time series whose columns will be ploted as a line graph (referred to as center lines).
Low
[ tseries ] - Time series that defines the lower edge of each band.
High
[ tseries ] - Time series that defines the upper edge of each band plotted.
Ln
[ numeric ] - Handles to lines plotted.
Bd
[ numeric ] - Handles to bands (patch objects) plotted.
Range
[ numeric ] - Date range actually plotted.
'datePosition='
[ 'centre'
| 'end'
| 'start'
] - Position of each date point within a given period span.
'dateTick='
[ numeric | Inf
] - Vector of dates locating tick marks on the X-axis; Inf means they will be created automatically.
'excludeFromLegend='
[ *true*
| false
] - Excluce bands from legend.
'grid='
[ 'bottom'
| 'top'
] - Place grid on top or bottom.
'relative='
[ true
| false
] - If true
, the lower and upper edge will be constructed by subtracting Low
from X
and adding High
to X
, respectively; otherwise, Low
and High
will be interpreted as absolute positions of the edges.
'tight='
[ true
| false
] - Make the y-axis tight.
'white='
[ numeric | 0.85
] - Percentage of white color mixed with the respective center line color and used to fill the band area.
See help on built-in plot
function for other options available.
See dat2str
for details on date format options.
'dateFormat='
[ char | cellstr | 'YYYYFP'
] - Date format string, or array of format strings (possibly different for each date).
'freqLetters='
[ char | 'YHQBMW'
] - Six letters used to represent the six possible frequencies of IRIS dates, in this order: yearly, half-yearly, quarterly, bi-monthly, monthly, and weekly (such as the 'Q'
in '2010Q1'
).
'months='
[ cellstr | {'January',...,'December'}
] - Twelve strings representing the names of the twelve months.
'standinMonth='
[ numeric | 'last'
| 1
] - Month that will represent a lower-than-monthly-frequency date if the month is part of the date format string.
If one (or more) of the input time series, X
, Low
, or High
, consists of more than one column, the graph is constructructed as follows:
One column in X
, multiple columns in Low
or High
- multiple bands are plotted around a single center line.
Multiple columns in X
, one column in Low
or High
- a single band is plotted around each of the center lines, each band constructed from the same lower and upper edge data; this setup makes sense only with the option 'relative=' true
.
Multiple columns in X
, mutliple columns in Low
or High
- a single band is plotted around each of the center lines, each band constructed from different data.