octave_packages/m/plot/line.m

   1 ## Copyright (C) 2005-2012 John W. Eaton
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} line ()
  21 ## @deftypefnx {Function File} {} line (@var{x}, @var{y})
  22 ## @deftypefnx {Function File} {} line (@var{x}, @var{y}, @var{z})
  23 ## @deftypefnx {Function File} {} line (@var{x}, @var{y}, @var{z}, @var{property}, @var{value}, @dots{})
  24 ## Create line object from @var{x} and @var{y} and insert in current
  25 ## axes object.  Return a handle (or vector of handles) to the line
  26 ## objects created.
  27 ##
  28 ## Multiple property-value pairs may be specified for the line, but they
  29 ## must appear in pairs.
  30 ## @end deftypefn
  31
  32 ## Author: jwe
  33
  34 function h = line (varargin)
  35
  36   ## make a default line object, and make it the current axes for
  37   ## the current figure.
  38   tmp = __line__ (gca (), varargin{:});
  39
  40   if (nargout > 0)
  41     h = tmp;
  42   endif
  43
  44 endfunction
  45
  46 %!test
  47 %! hf = figure ("visible", "off");
  48 %! unwind_protect
  49 %!   h = line;
  50 %!   assert (findobj (hf, "type", "line"), h);
  51 %!   assert (get (h, "xdata"), [0 1], eps);
  52 %!   assert (get (h, "ydata"), [0 1], eps);
  53 %!   assert (get (h, "type"), "line");
  54 %!   assert (get (h, "color"), get (0, "defaultlinecolor"));
  55 %!   assert (get (h, "linestyle"), get (0, "defaultlinelinestyle"));
  56 %!   assert (get (h, "linewidth"), get (0, "defaultlinelinewidth"), eps);
  57 %! unwind_protect_cleanup
  58 %!   close (hf);
  59 %! end_unwind_protect