Mercurial > hg > octave-lyh
annotate scripts/plot/plot.m @ 17289:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 19 Aug 2013 20:46:38 -0700 |
| parents | 87ba70043bfc |
| children | 68bcac3c043a |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14001
diff
changeset
|
1 ## Copyright (C) 1993-2012 John W. Eaton |
| 2313 | 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 | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 2313 | 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 | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 245 | 18 |
| 3368 | 19 ## -*- texinfo -*- |
|
10687
a8ce6bdecce5
Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents:
10121
diff
changeset
|
20 ## @deftypefn {Function File} {} plot (@var{y}) |
| 6895 | 21 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}) |
| 22 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}, @var{fmt}) | |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
23 ## @deftypefnx {Function File} {} plot (@dots{}, @var{property}, @var{value}, @dots{}) |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
24 ## @deftypefnx {Function File} {} plot (@var{x1}, @var{y1}, @dots{}, @var{xn}, @var{yn}) |
|
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17036
diff
changeset
|
25 ## @deftypefnx {Function File} {} plot (@var{hax}, @dots{}) |
|
10687
a8ce6bdecce5
Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents:
10121
diff
changeset
|
26 ## @deftypefnx {Function File} {@var{h} =} plot (@dots{}) |
|
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17036
diff
changeset
|
27 ## Produce 2-D plots. |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
28 ## |
|
11316
b7ff4a51ea88
plot.m: Eliminate present tense in first sentence of docstring.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
29 ## Many different combinations of arguments are possible. The simplest |
|
b7ff4a51ea88
plot.m: Eliminate present tense in first sentence of docstring.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
30 ## form is |
| 3426 | 31 ## |
| 3368 | 32 ## @example |
| 33 ## plot (@var{y}) | |
| 34 ## @end example | |
| 3426 | 35 ## |
| 3368 | 36 ## @noindent |
| 37 ## where the argument is taken as the set of @var{y} coordinates and the | |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
38 ## @var{x} coordinates are taken to be the range @code{1:numel (@var{y})}. |
| 5798 | 39 ## |
| 3368 | 40 ## If more than one argument is given, they are interpreted as |
| 3426 | 41 ## |
| 3368 | 42 ## @example |
| 6895 | 43 ## plot (@var{y}, @var{property}, @var{value}, @dots{}) |
| 3368 | 44 ## @end example |
| 3426 | 45 ## |
| 3368 | 46 ## @noindent |
| 6895 | 47 ## or |
| 6459 | 48 ## |
| 49 ## @example | |
| 50 ## plot (@var{x}, @var{y}, @var{property}, @var{value}, @dots{}) | |
| 51 ## @end example | |
| 52 ## | |
| 53 ## @noindent | |
| 6895 | 54 ## or |
| 55 ## | |
| 56 ## @example | |
| 57 ## plot (@var{x}, @var{y}, @var{fmt}, @dots{}) | |
| 58 ## @end example | |
| 59 ## | |
| 60 ## @noindent | |
| 61 ## and so on. Any number of argument sets may appear. The @var{x} and | |
| 62 ## @var{y} values are interpreted as follows: | |
| 3426 | 63 ## |
| 3368 | 64 ## @itemize @bullet |
| 65 ## @item | |
| 66 ## If a single data argument is supplied, it is taken as the set of @var{y} | |
| 67 ## coordinates and the @var{x} coordinates are taken to be the indices of | |
| 68 ## the elements, starting with 1. | |
| 3426 | 69 ## |
| 3368 | 70 ## @item |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
71 ## If @var{x} and @var{y} are scalars, a single point is plotted. |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
72 ## |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
73 ## @item |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
74 ## If both arguments are vectors, the elements of @var{y} are plotted versus |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
75 ## the elements of @var{x}. |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
76 ## |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
77 ## @item |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
78 ## If @var{x} is a vector and @var{y} is a matrix, then |
| 6177 | 79 ## the columns (or rows) of @var{y} are plotted versus @var{x}. |
| 2311 | 80 ## (using whichever combination matches, with columns tried first.) |
| 3426 | 81 ## |
| 3368 | 82 ## @item |
| 6177 | 83 ## If the @var{x} is a matrix and @var{y} is a vector, |
| 84 ## @var{y} is plotted versus the columns (or rows) of @var{x}. | |
| 2311 | 85 ## (using whichever combination matches, with columns tried first.) |
| 3426 | 86 ## |
| 3368 | 87 ## @item |
| 88 ## If both arguments are matrices, the columns of @var{y} are plotted | |
| 89 ## versus the columns of @var{x}. In this case, both matrices must have | |
| 90 ## the same number of rows and columns and no attempt is made to transpose | |
| 91 ## the arguments to make the number of rows match. | |
| 92 ## @end itemize | |
| 3426 | 93 ## |
| 6895 | 94 ## Multiple property-value pairs may be specified, but they must appear |
|
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17036
diff
changeset
|
95 ## in pairs. These arguments are applied to the line objects drawn by |
|
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
96 ## @code{plot}. Useful properties to modify are @qcode{"linestyle"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
97 ## @qcode{"linewidth"}, @qcode{"color"}, @qcode{"marker"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
98 ## @qcode{"markersize"}, @qcode{"markeredgecolor"}, @qcode{"markerfacecolor"}. |
| 3426 | 99 ## |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
100 ## The @var{fmt} format argument can also be used to control the plot style. |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
101 ## The format is composed of three parts: linestyle, markerstyle, color. |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
102 ## When a markerstyle is specified, but no linestyle, only the markers are |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
103 ## plotted. Similarly, if a linestyle is specified, but no markerstyle, then |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
104 ## only lines are drawn. If both are specified then lines and markers will |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
105 ## be plotted. If no @var{fmt} and no @var{property}/@var{value} pairs are |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
106 ## given, then the default plot style is solid lines with no markers and the |
|
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
107 ## color determined by the @qcode{"colororder"} property of the current axes. |
| 3426 | 108 ## |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
109 ## Format arguments: |
| 3426 | 110 ## |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
111 ## @table @asis |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
112 ## @item linestyle |
| 3426 | 113 ## |
|
17212
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
114 ## @multitable @columnfractions 0.06 0.94 |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
115 ## @item @samp{-} @tab Use solid lines (default). |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
116 ## @item @samp{--} @tab Use dashed lines. |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
117 ## @item @samp{:} @tab Use dotted lines. |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
118 ## @item @samp{-.} @tab Use dash-dotted lines. |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
119 ## @end multitable |
| 3426 | 120 ## |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
121 ## @item markerstyle |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
122 ## |
|
17212
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
123 ## @multitable @columnfractions 0.06 0.94 |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
124 ## @item @samp{+} @tab crosshair |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
125 ## @item @samp{o} @tab circle |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
126 ## @item @samp{*} @tab star |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
127 ## @item @samp{.} @tab point |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
128 ## @item @samp{x} @tab cross |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
129 ## @item @samp{s} @tab square |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
130 ## @item @samp{d} @tab diamond |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
131 ## @item @samp{^} @tab upward-facing triangle |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
132 ## @item @samp{v} @tab downward-facing triangle |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
133 ## @item @samp{>} @tab right-facing triangle |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
134 ## @item @samp{<} @tab left-facing triangle |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
135 ## @item @samp{p} @tab pentagram |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
136 ## @item @samp{h} @tab hexagram |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
137 ## @end multitable |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
138 ## |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
139 ## @item color |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
140 ## |
|
17212
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
141 ## @multitable @columnfractions 0.06 0.94 |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
142 ## @item @samp{k} @tab blacK |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
143 ## @item @samp{r} @tab Red |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
144 ## @item @samp{g} @tab Green |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
145 ## @item @samp{b} @tab Blue |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
146 ## @item @samp{m} @tab Magenta |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
147 ## @item @samp{c} @tab Cyan |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
148 ## @item @samp{w} @tab White |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
149 ## @end multitable |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
150 ## |
|
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
151 ## @item @qcode{";key;"} |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
152 ## Here @qcode{"key"} is the label to use for the plot legend. |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
153 ## @end table |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
154 ## |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
155 ## The @var{fmt} argument may also be used to assign legend keys. |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
156 ## To do so, include the desired label between semicolons after the |
|
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
157 ## formatting sequence described above, e.g., @qcode{"+b;Key Title;"}. |
|
17212
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
158 ## Note that the last semicolon is required and Octave will generate |
|
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
159 ## an error if it is left out. |
| 3683 | 160 ## |
| 3368 | 161 ## Here are some plot examples: |
| 3426 | 162 ## |
| 3368 | 163 ## @example |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
164 ## plot (x, y, "or", x, y2, x, y3, "m", x, y4, "+") |
| 3368 | 165 ## @end example |
| 3426 | 166 ## |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
167 ## This command will plot @code{y} with red circles, @code{y2} with solid |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
168 ## lines, @code{y3} with solid magenta lines, and @code{y4} with points |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
169 ## displayed as @samp{+}. |
| 3426 | 170 ## |
| 3368 | 171 ## @example |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
172 ## plot (b, "*", "markersize", 10) |
| 3368 | 173 ## @end example |
| 3426 | 174 ## |
| 6672 | 175 ## This command will plot the data in the variable @code{b}, |
|
17212
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
176 ## with points displayed as @samp{*} and a marker size of 10. |
| 3683 | 177 ## |
| 178 ## @example | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
179 ## @group |
| 3683 | 180 ## t = 0:0.1:6.3; |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
181 ## plot (t, cos(t), "-;cos(t);", t, sin(t), "-b;sin(t);"); |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
182 ## @end group |
| 3683 | 183 ## @end example |
| 184 ## | |
| 185 ## This will plot the cosine and sine functions and label them accordingly | |
|
17212
d87179b38bcf
doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents:
17199
diff
changeset
|
186 ## in the legend. |
| 6820 | 187 ## |
|
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17036
diff
changeset
|
188 ## If the first argument @var{hax} is an axes handle, then plot into this axis, |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17036
diff
changeset
|
189 ## rather than the current axes returned by @code{gca}. |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
190 ## |
|
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17036
diff
changeset
|
191 ## The optional return value @var{h} is a vector of graphics handles to |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17036
diff
changeset
|
192 ## the created line objects. |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
193 ## |
|
17199
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
194 ## To save a plot, in one of several image formats such as PostScript |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
195 ## or PNG, use the @code{print} command. |
|
85e55da61409
doc: Clarify description of plot format.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
196 ## |
|
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17036
diff
changeset
|
197 ## @seealso{axis, box, grid, hold, legend, title, xlabel, ylabel, xlim, ylim, ezplot, errorbar, fplot, line, plot3, polar, loglog, semilogx, semilogy, subplot} |
| 3368 | 198 ## @end deftypefn |
| 4 | 199 |
| 2314 | 200 ## Author: jwe |
| 201 | |
|
17036
08dd9458684a
Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents:
15015
diff
changeset
|
202 function h = plot (varargin) |
| 4 | 203 |
|
17036
08dd9458684a
Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents:
15015
diff
changeset
|
204 [hax, varargin, nargs] = __plt_get_axis_arg__ ("plot", varargin{:}); |
|
10730
390d93e20531
Plot commands now print usage information without errors
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
205 |
|
390d93e20531
Plot commands now print usage information without errors
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
206 if (nargs < 1) |
|
14846
460a3c6d8bf1
maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
207 print_usage (); |
|
10730
390d93e20531
Plot commands now print usage information without errors
Rik <octave@nomad.inbox5.com>
parents:
10687
diff
changeset
|
208 endif |
| 7216 | 209 |
|
17219
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17212
diff
changeset
|
210 oldfig = []; |
|
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17212
diff
changeset
|
211 if (isempty (hax)) |
|
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17212
diff
changeset
|
212 oldfig = get (0, "currentfigure"); |
|
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17212
diff
changeset
|
213 endif |
| 7215 | 214 unwind_protect |
|
17036
08dd9458684a
Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents:
15015
diff
changeset
|
215 hax = newplot (hax); |
|
08dd9458684a
Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents:
15015
diff
changeset
|
216 htmp = __plt__ ("plot", hax, varargin{:}); |
| 7215 | 217 unwind_protect_cleanup |
|
17036
08dd9458684a
Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents:
15015
diff
changeset
|
218 if (! isempty (oldfig)) |
|
08dd9458684a
Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents:
15015
diff
changeset
|
219 set (0, "currentfigure", oldfig); |
|
08dd9458684a
Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents:
15015
diff
changeset
|
220 endif |
| 7215 | 221 end_unwind_protect |
| 6302 | 222 |
| 223 if (nargout > 0) | |
|
17036
08dd9458684a
Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents:
15015
diff
changeset
|
224 h = htmp; |
| 6302 | 225 endif |
| 4 | 226 |
| 227 endfunction | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
228 |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
229 |
| 15015 | 230 %!demo |
| 231 %! x = 1:5; y = 1:5; | |
| 232 %! plot (x,y,'g'); | |
|
17198
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
233 %! title ('plot() of green line at 45 degrees'); |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
234 |
| 15015 | 235 %!demo |
| 236 %! x = 1:5; y = 1:5; | |
| 237 %! plot (x,y,'g*'); | |
|
17198
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
238 %! title ('plot() of green stars along a line at 45 degrees'); |
| 15015 | 239 |
| 240 %!demo | |
| 241 %! x1 = 1:5; y1 = 1:5; | |
| 242 %! x2 = 5:9; y2 = 5:-1:1; | |
| 243 %! plot (x1,y1,'bo-', x2,y2,'rs-'); | |
| 244 %! axis ('tight'); | |
|
17198
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
245 %! title ({'plot() of blue circles ascending and red squares descending'; |
|
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17126
diff
changeset
|
246 %! 'connecting lines drawn'}); |
| 15015 | 247 |