<html lang="en">
<head>
<title>Searching Properties - GNU Octave</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Octave">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Graphics-Data-Structures.html#Graphics-Data-Structures" title="Graphics Data Structures">
<link rel="prev" href="Graphics-Object-Properties.html#Graphics-Object-Properties" title="Graphics Object Properties">
<link rel="next" href="Managing-Default-Properties.html#Managing-Default-Properties" title="Managing Default Properties">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Searching-Properties"></a>
<p>
Next: <a rel="next" accesskey="n" href="Managing-Default-Properties.html#Managing-Default-Properties">Managing Default Properties</a>,
Previous: <a rel="previous" accesskey="p" href="Graphics-Object-Properties.html#Graphics-Object-Properties">Graphics Object Properties</a>,
Up: <a rel="up" accesskey="u" href="Graphics-Data-Structures.html#Graphics-Data-Structures">Graphics Data Structures</a>
<hr>
</div>
<h4 class="subsection">15.3.4 Searching Properties</h4>
<!-- findobj scripts/plot/findobj.m -->
<p><a name="doc_002dfindobj"></a>
<div class="defun">
— Function File: <var>h</var> = <b>findobj</b> ()<var><a name="index-findobj-1527"></a></var><br>
— Function File: <var>h</var> = <b>findobj</b> (<var>prop_name, prop_value</var>)<var><a name="index-findobj-1528"></a></var><br>
— Function File: <var>h</var> = <b>findobj</b> (<var>"-property", prop_name</var>)<var><a name="index-findobj-1529"></a></var><br>
— Function File: <var>h</var> = <b>findobj</b> (<var>"-regexp", prop_name, pattern</var>)<var><a name="index-findobj-1530"></a></var><br>
— Function File: <var>h</var> = <b>findobj</b> (<var>"flat", <small class="dots">...</small></var>)<var><a name="index-findobj-1531"></a></var><br>
— Function File: <var>h</var> = <b>findobj</b> (<var>h, <small class="dots">...</small></var>)<var><a name="index-findobj-1532"></a></var><br>
— Function File: <var>h</var> = <b>findobj</b> (<var>h, "-depth", d, <small class="dots">...</small></var>)<var><a name="index-findobj-1533"></a></var><br>
<blockquote><p>Find graphics object with specified property values. The simplest form is
<pre class="example"> findobj (<var>prop_name</var>, <var>prop_value</var>)
</pre>
<p class="noindent">which returns all of the handles to the objects with the name
<var>prop_name</var> and the name <var>prop_value</var>. The search can be limited
to a particular object or set of objects and their descendants by
passing a handle or set of handles <var>h</var> as the first argument to
<code>findobj</code>.
<p>The depth of hierarchy of objects to which to search to can be limited
with the "-depth" argument. To limit the number depth of the hierarchy
to search to <var>d</var> generations of children, and example is
<pre class="example"> findobj (<var>h</var>, "-depth", <var>d</var>, <var>prop_name</var>, <var>prop_value</var>)
</pre>
<p>Specifying a depth <var>d</var> of 0, limits the search to the set of object
passed in <var>h</var>. A depth <var>d</var> of 0 is equivalent to the "-flat"
argument.
<p>A specified logical operator may be applied to the pairs of <var>prop_name</var>
and <var>prop_value</var>. The supported logical operators are "-and", "-or",
"-xor", "-not".
<p>The objects may also be matched by comparing a regular expression to the
property values, where property values that match <code>regexp
(</code><var>prop_value</var><code>, </code><var>pattern</var><code>)</code> are returned. Finally, objects may be
matched by property name only, using the "-property" option.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dget.html#doc_002dget">get</a>, <a href="doc_002dset.html#doc_002dset">set</a>.
</p></blockquote></div>
<!-- findall scripts/plot/findall.m -->
<p><a name="doc_002dfindall"></a>
<div class="defun">
— Function File: <var>h</var> = <b>findall</b> ()<var><a name="index-findall-1534"></a></var><br>
— Function File: <var>h</var> = <b>findall</b> (<var>prop_name, prop_value</var>)<var><a name="index-findall-1535"></a></var><br>
— Function File: <var>h</var> = <b>findall</b> (<var>h, <small class="dots">...</small></var>)<var><a name="index-findall-1536"></a></var><br>
— Function File: <var>h</var> = <b>findall</b> (<var>h, "-depth", d, <small class="dots">...</small></var>)<var><a name="index-findall-1537"></a></var><br>
<blockquote><p>Find graphics object with specified property values including hidden handles.
<p>This function performs the same function as <code>findobj</code>, but it
includes hidden objects in its search. For full documentation, see
<code>findobj</code>.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dget.html#doc_002dget">get</a>, <a href="doc_002dset.html#doc_002dset">set</a>, <a href="doc_002dfindobj.html#doc_002dfindobj">findobj</a>, <a href="doc_002dallchild.html#doc_002dallchild">allchild</a>.
</p></blockquote></div>
</body></html>
