Mercurial > hg > octave-lyh

comparison scripts/plot/scatter.m @ 17126:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links. * doc/interpreter/plot.txi: Add @findex entries that were in xlim.m * scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axes.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/closereq.m, scripts/plot/colorbar.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m, scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m, scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m, scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m, scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m, scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m, scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m, scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m, scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m, scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m, scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m, scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m, scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m, scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m, scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m, scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m, scripts/plot/zlim.m: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 13:53:30 -0700
parents 1cbdd14711c5
children df4c4b7708a4
comparison
equal deleted inserted replaced
17125:d4549655b92e 17126:eaab03308c0b
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} scatter (@var{x}, @var{y}) 20 ## @deftypefn {Function File} {} scatter (@var{x}, @var{y})
21 ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{s}) 21 ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{s})
22 ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{s}, @var{c}) 22 ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{s}, @var{c})
23 ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{s}, @var{c}, @var{style}) 23 ## @deftypefnx {Function File} {} scatter (@dots{}, @var{style})
24 ## @deftypefnx {Function File} {} scatter (@var{x}, @var{y}, @var{s}, @var{c}, @var{prop}, @var{val})
25 ## @deftypefnx {Function File} {} scatter (@dots{}, "filled") 24 ## @deftypefnx {Function File} {} scatter (@dots{}, "filled")
26 ## @deftypefnx {Function File} {} scatter (@var{h}, @dots{}) 25 ## @deftypefnx {Function File} {} scatter (@dots{}, @var{prop}, @var{val}, @dots{})
26 ## @deftypefnx {Function File} {} scatter (@var{hax}, @dots{})
27 ## @deftypefnx {Function File} {@var{h} =} scatter (@dots{}) 27 ## @deftypefnx {Function File} {@var{h} =} scatter (@dots{})
28 ## 28 ## Draw a 2-D scatter plot.
29 ## Draw a scatter plot of the data. A marker is plotted at each point 29 ##
30 ## defined by the points in the vectors @var{x} and @var{y}. The size of 30 ## A marker is plotted at each point defined by the coordinates in the vectors
31 ## the markers used is determined by the @var{s}, which can be a scalar or 31 ## @var{x} and @var{y}.
32 ## a vector of the same length as @var{x} and @var{y}. If @var{s} is not 32 ##
33 ## given or is an empty matrix, then the default value of 8 points is used. 33 ## The size of the markers is determined by @var{s}, which can be a scalar
34 ## or a vector of the same length as @var{x} and @var{y}. If @var{s}
35 ## is not given, or is an empty matrix, then a default value of 8 points is
36 ## used.
34 ## 37 ##
35 ## The color of the markers is determined by @var{c}, which can be a string 38 ## The color of the markers is determined by @var{c}, which can be a string
36 ## defining a fixed color; a 3-element vector giving the red, green,and blue 39 ## defining a fixed color; a 3-element vector giving the red, green, and blue
37 ## components of the color; a vector of the same length as @var{x} that gives 40 ## components of the color; a vector of the same length as @var{x} that gives
38 ## a scaled index into the current colormap; or an @var{n}-by-3 matrix defining 41 ## a scaled index into the current colormap; or an @nospell{Nx3} matrix defining
39 ## the colors of each of the markers individually. 42 ## the RGB color of each marker individually.
40 ## 43 ##
41 ## The marker to use can be changed with the @var{style} argument, that is a 44 ## The marker to use can be changed with the @var{style} argument, that is a
42 ## string defining a marker in the same manner as the @code{plot} command. 45 ## string defining a marker in the same manner as the @code{plot} command.
43 ## If the argument @code{"filled"} is given then the markers as filled. All 46 ## If no marker is specified it defaults to 'o' or circles.
44 ## additional arguments are passed to the underlying patch command. 47 ## If the argument "filled" is given then the markers are filled.
48 ##
49 ## Additional property/value pairs are passed directly to the underlying
50 ## patch object.
51 ##
52 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
53 ## rather than the current axes returned by @code{gca}.
45 ## 54 ##
46 ## The optional return value @var{h} is a graphics handle to the created patch 55 ## The optional return value @var{h} is a graphics handle to the created patch
47 ## object. 56 ## object.
48 ## 57 ##
49 ## Example: 58 ## Example:
54 ## y = randn (100, 1); 63 ## y = randn (100, 1);
55 ## scatter (x, y, [], sqrt (x.^2 + y.^2)); 64 ## scatter (x, y, [], sqrt (x.^2 + y.^2));
56 ## @end group 65 ## @end group
57 ## @end example 66 ## @end example
58 ## 67 ##
59 ## @seealso{plot, patch, scatter3} 68 ## @seealso{scatter3, patch, plot}
60 ## @end deftypefn 69 ## @end deftypefn
61 70
62 function retval = scatter (varargin) 71 function retval = scatter (varargin)
63 72
64 [hax, varargin, nargin] = __plt_get_axis_arg__ ("scatter", varargin{:}); 73 [hax, varargin, nargin] = __plt_get_axis_arg__ ("scatter", varargin{:});