Mercurial > hg > octave-thorsten
annotate scripts/plot/pie.m @ 14001:5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
* voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m,
clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m,
findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m,
trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m:
Update documentation for functions returning a graphics handle h.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 06 Dec 2011 13:09:17 -0800 |
| parents | c792872f8942 |
| children | 22c50cbad2ce |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 2007-2011 David Bateman |
| 7118 | 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 -*- | |
|
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
20 ## @deftypefn {Function File} {} pie (@var{x}) |
|
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
21 ## @deftypefnx {Function File} {} pie (@var{x}, @var{explode}) |
| 7118 | 22 ## @deftypefnx {Function File} {} pie (@dots{}, @var{labels}) |
| 23 ## @deftypefnx {Function File} {} pie (@var{h}, @dots{}); | |
| 24 ## @deftypefnx {Function File} {@var{h} =} pie (@dots{}); | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
25 ## Produce a 2-D pie chart. |
| 7118 | 26 ## |
|
8325
b93ac0586e4b
spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents:
7313
diff
changeset
|
27 ## Called with a single vector argument, produces a pie chart of the |
| 7118 | 28 ## elements in @var{x}, with the size of the slice determined by percentage |
| 29 ## size of the values of @var{x}. | |
| 30 ## | |
| 31 ## The variable @var{explode} is a vector of the same length as @var{x} that | |
| 32 ## if non zero 'explodes' the slice from the pie chart. | |
| 33 ## | |
| 34 ## If given @var{labels} is a cell array of strings of the same length as | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
35 ## @var{x}, giving the labels of each of the slices of the pie chart. |
| 7118 | 36 ## |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
37 ## The optional return value @var{h} is a list of handles to the patch |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
38 ## and text objects generating the plot. |
| 7118 | 39 ## |
| 11330 | 40 ## @seealso{pie3, bar, stem} |
| 7118 | 41 ## @end deftypefn |
| 42 | |
| 43 ## Very roughly based on pie.m from octave-forge whose author was | |
| 44 ## Daniel Heiserer <Daniel.heiserer@physik.tu-muenchen.de> | |
| 45 | |
| 46 function retval = pie (varargin) | |
| 47 | |
| 7215 | 48 [h, varargin] = __plt_get_axis_arg__ ("pie", varargin{:}); |
| 49 | |
| 7118 | 50 if (nargin < 1) |
| 51 print_usage (); | |
| 7215 | 52 else |
| 7118 | 53 oldh = gca (); |
| 54 unwind_protect | |
| 55 axes (h); | |
| 56 newplot (); | |
| 11330 | 57 tmp = __pie__ ("pie", h, varargin{:}); |
| 7118 | 58 unwind_protect_cleanup |
| 59 axes (oldh); | |
| 60 end_unwind_protect | |
| 61 endif | |
| 62 | |
| 63 if (nargout > 0) | |
| 64 retval = tmp; | |
| 65 endif | |
| 7119 | 66 |
| 7118 | 67 endfunction |
| 68 | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
69 |
| 7120 | 70 %!demo |
| 71 %! pie ([3, 2, 1], [0, 0, 1]); | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
72 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); |
| 7120 | 73 |
| 74 %!demo | |
| 75 %! pie ([3, 2, 1], [0, 0, 1], {"Cheddar", "Swiss", "Camembert"}); | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
76 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); |
| 7120 | 77 %! axis ([-2,2,-2,2]); |
|
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
78 |
|
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
79 %!demo |
|
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
80 %! pie ([0.17, 0.34, 0.41], {"Cheddar", "Swiss", "Camembert"}); |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
81 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); |
|
11341
3c7ba1e3dc21
Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents:
11330
diff
changeset
|
82 %! axis ([-2,2,-2,2]); |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
83 %! title ("missing slice"); |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
84 |