Home > freetb4matlab > graceplot > alternatives > legend.m

legend

PURPOSE ^

%

SYNOPSIS ^

function legend (varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {} legend (@var{st1}, @var{st2}, @var{st3}, @var{...})
% @deftypefnx {Function File} {} legend (@var{st1}, @var{st2}, @var{st3}, @var{...}, @var{pos})
% @deftypefnx {Function File} {} legend (@var{matstr})
% @deftypefnx {Function File} {} legend (@var{matstr}, @var{pos})
% @deftypefnx {Function File} {} legend (@var{cell})
% @deftypefnx {Function File} {} legend (@var{cell}, @var{pos})
% @deftypefnx {Function File} {} legend ('@var{func}')
%
% Legend puts a legend on the current plot using the specified strings
% as labels. Use independant strings (@var{st1}, @var{st2}, @var{st3}...), a
% matrix of strings (@var{matstr}), or a cell array of strings (@var{cell}) to
% specify legends. Legend works on line graphs, bar graphs, etc...
% Be sure to call plot before calling legend.
%
% @var{pos} optionally  places the legend in the specified location:
%
% @multitable @columnfractions 0.1 0.1 0.8
% @item @tab 0 @tab
%   Don't move the legend box (default)
% @item @tab 1 @tab
%   Upper right-hand corner
% @item @tab 2 @tab
%   Upper left-hand corner
% @item @tab 3 @tab
%   Lower left-hand corner
% @item @tab 4 @tab
%   Lower right-hand corner
% @item @tab -1 @tab
%   To the top right of the plot
% @item @tab -2 @tab
%   To the bottom right of the plot
% @item @tab -3 @tab
%   To the bottom of the plot
% @item @tab [@var{x}, @var{y}] @tab
%   To the arbitrary postion in plot [@var{x}, @var{y}]
% @end multitable
%
% Some specific functions are directely avaliable using @var{func}:
%
% @table @code
% @item show
%   Show legends from the plot
% @item hide
% @itemx off
%   Hide legends from the plot
% @item boxon
%   Draw a box around legends
% @item boxoff
%   Withdraw the box around legends
% @item left
%   Text is to the left of the keys
% @item right
%   Text is to the right of the keys
% @end table
%
% REQUIRES: unix piping functionality, grep, sed and awk
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003