Mercurial > octave-nkf
changeset 18150:1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
* plot.txi: Add documentation about using set() to get default graphic
properties.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 18 Dec 2013 16:33:08 -0800 |
| parents | 190ef1764d30 |
| children | bf638abc95de |
| files | doc/interpreter/plot.txi |
| diffstat | 1 files changed, 9 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/plot.txi Wed Dec 18 16:13:39 2013 -0800 +++ b/doc/interpreter/plot.txi Wed Dec 18 16:33:08 2013 -0800 @@ -1226,18 +1226,21 @@ @noindent sets the range of the x-axis for the current axes object in the current -figure to @samp{[-10, 10]}. Additionally, calling set with a graphics -object index as the only argument returns a structure containing the -default values for all the properties for the given object type. For -example, +figure to @samp{[-10, 10]}. + +Default property values can also be queried if the @code{set} function is +called without a value argument. When only one argument is given (a graphic +handle) then a structure with defaults for all properties of the given object +type is returned. For example, @example set (gca ()) @end example @noindent -returns a structure containing the default property values for axes -objects. +returns a structure containing the default property values for axes objects. +If @code{set} is called with two arguments (a graphic handle and a property +name) then only the defaults for the requested property are returned. @DOCSTRING(get)