Searching Properties - GNU Octave
Description: GNU Octave

Next: Managing Default Properties, Previous: Graphics Object Properties, Up: Graphics Data Structures

#### 15.3.4 Searching Properties

— Function File: h = findobj ()
— Function File: h = findobj (prop_name, prop_value)
— Function File: h = findobj ('-property', prop_name)
— Function File: h = findobj ('-regexp', prop_name, pattern)
— Function File: h = findobj ('flat', ...)
— Function File: h = findobj (h, ...)
— Function File: h = findobj (h, '-depth', d, ...)

> Find object with specified property values. The simplest form is

>               findobj (prop_name, prop_Value)

> which returns all of the handles to the objects with the name prop_name and the name prop_Value. The search can be limited to a particular object or set of objects and their descendants by passing a handle or set of handles h as the first argument to `findobj`.

> 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 d generations of children, and example is

>               findobj (h, '-depth', d, prop_Name, prop_Value)

> Specifying a depth d of 0, limits the search to the set of object passed in h. A depth d of 0 is equivalent to the '-flat' argument.

> A specified logical operator may be applied to the pairs of prop_Name and prop_Value. The supported logical operators are '-and', '-or', '-xor', '-not'.

> The objects may also be matched by comparing a regular expression to the property values, where property values that match `regexp (`prop_Value`,` pattern`)` are returned. Finally, objects may be matched by property name only, using the '-property' option.

> See also: get, set.

— Function File: h = findall ()
— Function File: h = findall (prop_name, prop_value)
— Function File: h = findall (h, ...)
— Function File: h = findall (h, "-depth", d, ...)

> Find object with specified property values including hidden handles.

> This function performs the same function as `findobj`, but it includes hidden objects in its search. For full documentation, see `findobj`.

> See also: get, set, findobj, allchild.