freemat-data 4.0-5build1 / usr / share / freemat / toolbox / graph / text.m

% TEXT TEXT Add Text Label to Plot
% 
% Usage
% 
% Adds a text label to the currently active plot.  The general
% syntax for it is use is either
% 
%    text(x,y,'label')
% 
% where x and y are both vectors of the same length, in which
% case the text 'label' is added to the current plot at each of the
% coordinates x(i),y(i) (using the current axis to map these to screen
% coordinates).  The second form supplies a cell-array of strings
% as the second argument, and allows you to place many labels simultaneously
% 
%    text(x,y,{'label1','label2',....})
% 
% where the number of elements in the cell array must match the size of
% vectors x and y.  You can also specify properties for the labels
% via
% 
%    handles = text(x,y,{labels},properties...)
% 

% Copyright (c) 2002-2006 Samit Basu
% Licensed under the GPL

function handles = text(varargin)
if (nargin < 3)
  error 'text requires at least three arguments, the x and y location vectors and the strings'
end
xvec = varargin{1};
yvec = varargin{2};
labels = varargin{3};
varargin(1:3) = [];
if (length(xvec) ~= length(yvec))
  error 'vectors x and y must be the same length'
end

if (isa(labels,'char'))
  labelarray = repmat({labels},[length(xvec),1]);
elseif (iscellstr(labels))
  labelarray = labels;
  if (length(labelarray) ~= length(xvec))
    error 'number of labels much match the length of the x and y vectors'
  end
else
  error 'labels must be either a single string or a cell array of strings.'
end

if (nargout > 0)
  handles = [];
end

for (i=1:numel(xvec))
  h = htext('position',[xvec(i),yvec(i)],'string',labelarray{i},varargin{:});
  if (nargout > 0)
    handles = [handles,h];
  end
end