MATLAB Function Reference Previous page   Next Page
Hggroup Properties

Modifying Properties

You can set and query graphics object properties using the set and get commands.

To change the default values of properties, see Setting Default Property Values.

See Group Objects for general information on this type of object.

Hggroup Property Descriptions

This section provides a description of properties. Curly braces { } enclose default values.

BeingDeleted                 on | {off} Read Only

This object is being deleted. The BeingDeleted property provides a mechanism that you can use to determine whether objects are in the process of being deleted. MATLAB sets the BeingDeleted property to on when the object's delete function callback is called (see the DeleteFcn property). It remains set to on while the delete function executes, after which the object no longer exists.

For example, an object's delete function might call other functions that act on a number of different objects. These functions might not need to perform actions on objects if the objects are going to be deleted, and therefore can check the object's BeingDeleted property before acting.

BusyAction                   cancel | {queue}

Callback routine interruption. The BusyAction property enables you to control how MATLAB handles events that potentially interrupt executing callbacks. If there is a callback function executing, callbacks invoked subsequently always attempt to interrupt it.

If the Interruptible property of the object whose callback is executing is set to on (the default), then interruption occurs at the next point where the event queue is processed. If the Interruptible property is off, the BusyAction property (of the object owning the executing callback) determines how MATLAB handles the event. The choices are

ButtonDownFcn                string or function handle

Button press callback function. A callback that executes whenever you press a mouse button while the pointer is over the children of the hggroup object.

This property can be

The expression executes in the MATLAB workspace.

See Function Handle Callbacks for information on how to use function handles to define the callbacks.

Children                     array of graphics object handles

Children of the hggroup object. An array containing the handles of all objects parented to the hggroup object (whether visible or not).

Note that if a child object's HandleVisibility property is set to callback or off, its handle does not appear in the hggroup Children property unless you set the Root ShowHiddenHandles property to on:

Clipping                     {on} | off

Clipping mode. MATLAB clips stairs plots to the axes plot box by default. If you set Clipping to off, lines might be displayed outside the axes plot box.

CreateFcn                    string or function handle

Callback executed during object creation. This property defines a callback routine that executes when MATLAB creates an hggroup object. You must define this property as a default value for hggroup objects. For example, the statement

defines a default value on the Root level that applies to every hggroup object created in a MATLAB session. Whenever you create an hggroup object, the function associated with the function handle @myCreateFcn executes.

MATLAB executes the callback after setting all the hggroup object's properties. Setting the CreateFcn property on an existing hggroup object has no effect.

The handle of the object whose CreateFcn is being executed is accessible only through the Root CallbackObject property, which can be queried using gcbo.

See Function Handle Callbacks for information on how to use function handles to define the callback function.

DeleteFcn                    string or function handle

Callback executed during object deletion. A callback that executes when the hggroup object is deleted (e.g., this might happen when you issue a delete command on the hggroup object, its parent axes, or the figure containing it). MATLAB executes the callback before destroying the object's properties so the callback routine can query these values.

The handle of the object whose DeleteFcn is being executed is accessible only through the Root CallbackObject property, which can be queried using gcbo.

See Function Handle Callbacks for information on how to use function handles to define the callback function.

See the BeingDeleted property for related information.

EraseMode                    {normal} | none | xor | background

Erase mode. This property controls the technique MATLAB uses to draw and erase hggroup child objects. Alternative erase modes are useful for creating animated sequences, where control of the way individual objects are redrawn is necessary to improve performance and obtain the desired effect.

Set the axes background color with the axes Color property. Set the figure background color with the figure Color property.

Printing with Nonnormal Erase Modes

MATLAB always prints figures as if the EraseMode of all objects is normal. This means graphics objects created with EraseMode set to none, xor, or background can look different on screen than on paper. On screen, MATLAB may mathematically combine layers of colors (e.g., performing an XOR of a pixel color with that of the pixel behind it) and ignore three-dimensional sorting to obtain greater rendering speed. However, these techniques are not applied to the printed output.

You can use the MATLAB getframe command or other screen capture applications to create an image of a figure containing nonnormal mode objects.

HandleVisibility             {on} | callback | off

Control access to object's handle by command-line users and GUIs. This property determines when an object's handle is visible in its parent's list of children. HandleVisibility is useful for preventing command-line users from accidentally accessing the hggroup object.

Functions Affected by Handle Visibility

When a handle is not visible in its parent's list of children, it cannot be returned by functions that obtain handles by searching the object hierarchy or querying handle properties. This includes get, findobj, gca, gcf, gco, newplot, cla, clf, and close.

Properties Affected by Handle Visibility

When a handle's visibility is restricted using callback or off, the object's handle does not appear in its parent's Children property, figures do not appear in the root's CurrentFigure property, objects do not appear in the root's CallbackObject property or in the figure's CurrentObject property, and axes do not appear in their parent's CurrentAxes property.

Overriding Handle Visibility

You can set the root ShowHiddenHandles property to on to make all handles visible regardless of their HandleVisibility settings (this does not affect the values of the HandleVisibility properties). See also findall.

Handle Validity

Handles that are hidden are still valid. If you know an object's handle, you can set and get its properties, and pass it to any function that operates on handles.

HitTest                      {on} | off

Pickable by mouse click. HitTest determines whether the hggroup object can become the current object (as returned by the gco command and the figure CurrentObject property) as a result of a mouse click on the hggroup child objects. Note that to pick the hggroup object, its children must have their HitTest property set to off.

If the hggroup object's HitTest is off, clicking it picks the object behind it.

Interruptible                {on} | off

Callback routine interruption mode. The Interruptible property controls whether an hggroup object callback can be interrupted by callbacks invoked subsequently.

Only callbacks defined for the ButtonDownFcn property are affected by the Interruptible property. MATLAB checks for events that can interrupt a callback only when it encounters a drawnow, figure, getframe, or pause command in the routine. See the BusyAction property for related information.

Setting Interruptible to on allows any graphics object's callback to interrupt callback routines originating from an hggroup property. Note that MATLAB does not save the state of variables or the display (e.g., the handle returned by the gca or gcf command) when an interruption occurs.

Parent                       axes handle

Parent of hggroup object. This property contains the handle of the hggroup object's parent object. The parent of an hggroup object is the axes, hggroup, or hgtransform object that contains it.

See Objects That Can Contain Other Objects for more information on parenting graphics objects.

Selected                     on | {off}

Is object selected? When you set this property to on, MATLAB displays selection handles at the corners and midpoints of hggroup child objects if the SelectionHighlight property is also on (the default).

SelectionHighlight           {on} | off

Objects are highlighted when selected. When the Selected property is on, MATLAB indicates the selected state by drawing selection handles on the hggroup child objects. When SelectionHighlight is off, MATLAB does not draw the handles.

Tag                          string

User-specified object label. The Tag property provides a means to identify graphics objects with a user-specified label. This is particularly useful when you are constructing interactive graphics programs that would otherwise need to define object handles as global variables or pass them as arguments between callbacks.

For example, you might create an hggroup object and set the Tag property:

When you want to access the object, you can use findobj to find its handle. For example,

Type                         string (read only)

Type of graphics object. This property contains a string that identifies the class of graphics object. For hggroup objects, Type is 'hggroup'. The following statement finds all the hggroup objects in the current axes.

UIContextMenu                handle of a uicontextmenu object

Associate a context menu with the hggroup object. Assign this property the handle of a uicontextmenu object created in the hggroup object's figure. Use the uicontextmenu function to create the context menu. MATLAB displays the context menu whenever you right-click over the hggroup object.

UserData                     array

User-specified data. This property can be any data you want to associate with the hggroup object (including cell arrays and structures). The hggroup object does not set values for this property, but you can access it using the set and get functions.

Visible                      {on} | off

Visibility of hggroup object and its children. By default, hggroup object visibility is on. This means all children of the hggroup are visible unless the child object's Visible property is set to off. Setting an hggroup object's Visible property to off also makes its children invisible.

Previous page  hggroup hgload Next page

© 1994-2005 The MathWorks, Inc.