Navigation

Operators and Keywords

Function List:

C++ API

: set (h, property, value, …)
: set (h, properties, values)
: set (h, pv)
: value_list = set (h, property)
: all_value_list = set (h)

Set named property values for the graphics handle (or vector of graphics handles) h.

There are three ways to give the property names and values:

  • as a comma separated list of property, value pairs

    Here, each property is a string containing the property name, each value is a value of the appropriate type for the property.

  • as a cell array of strings properties containing property names and a cell array values containing property values.

    In this case, the number of columns of values must match the number of elements in properties. The first column of values contains values for the first entry in properties, etc. The number of rows of values must be 1 or match the number of elements of h. In the first case, each handle in h will be assigned the same values. In the latter case, the first handle in h will be assigned the values from the first row of values and so on.

  • as a structure array pv

    Here, the field names of pv represent the property names, and the field values give the property values. In contrast to the previous case, all elements of pv will be set in all handles in h independent of the dimensions of pv.

set is also used to query the list of values a named property will take. clist = set (h, "property") will return the list of possible values for "property" in the cell list clist. If no output variable is used then the list is formatted and printed to the screen.

If no property is specified (slist = set (h)) then a structure slist is returned where the fieldnames are the properties of the object h and the fields are the list of possible values for each property. If no output variable is used then the list is formatted and printed to the screen.

For example, 

hf = figure ();
set (hf, "paperorientation")
⇒  paperorientation:  [ landscape |{portrait} |rotated ]

shows the paperorientation property can take three values with the default being "portrait".

See also: get.

Package: octave