Home > freetb4matlab > plot > legend.m

legend

PURPOSE ^

%

SYNOPSIS ^

function legend (varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {} legend (@var{st1}, @var{st2}, @dots{})
% @deftypefnx {Function File} {} legend (@var{st1}, @var{st2}, @dots{}, 'location', @var{pos})
% @deftypefnx {Function File} {} legend (@var{matstr})
% @deftypefnx {Function File} {} legend (@var{matstr}, 'location', @var{pos})
% @deftypefnx {Function File} {} legend (@var{cell})
% @deftypefnx {Function File} {} legend (@var{cell}, 'location', @var{pos})
% @deftypefnx {Function File} {} legend ('@var{func}')
%
% Display a legend for the current axes using the specified strings
% as labels.  Legend entries may be specified as individual character
% string arguments, a character array, or a cell array of character
% strings.  Legend works on line graphs, bar graphs, etc.  A plot must
% exist before legend is called.
%
% The optional parameter @var{pos} specifies the location of the legend
% as follows:
%
% @multitable @columnfractions 0.06 0.14 0.80
% @item @tab north @tab
%   center top
% @item @tab south @tab
%   center bottom
% @item @tab east @tab
%   right center
% @item @tab west @tab
%   left center
% @item @tab northeast @tab
%   right top (default)
% @item @tab northwest @tab
%   left top
% @item @tab southeast @tab
%   right bottom
% @item @tab southwest @tab
%   left bottom
% @item 
% @item @tab outside @tab
%   can be appended to any location string
% @end multitable
%
% Some specific functions are directly available using @var{func}:
%
% @table @asis
% @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
% @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