# Documentation

### This is machine translation

Translated by
Mouseover text to see original. Click the button below to return to the English verison of the page.

# Rectangle Properties

Control rectangle appearance and behavior

Rectangle properties control the appearance and behavior of a rectangle object. By changing property values, you can modify certain aspects of the rectangle.

Starting in R2014b, you can use dot notation to query and set properties.

```h = rectangle; w = h.LineWidth; h.LineWidth = 3;```

If you are using an earlier release, use the `get` and `set` functions instead.

## Appearance

expand all

Amount of horizontal and vertical curvature, specified as a two element vector of the form `[x y]` or a scalar value. Use this property to vary the shape of the rectangle from rectangular to ellipsoidal. The horizontal curvature is the fraction of the width that is curved along the top and bottom edges. The vertical curvature is the fraction of the height that is curved along the left and right edges.

• To use different horizontal and vertical curvatures, specify a two-element vector of the form `[x y]`. The `x` element determines the horizontal curvature and the `y` element determines the vertical curvature. Specify `x` and `y` as values between 0 (no curvature) and 1 (maximum curvature). For example, a value of `[0 0]` creates a rectangle with square edges and value of `[1 1]` creates an ellipse.

• To use the same curvature for the horizontal and vertical edges, specify a scalar value in the range `[0,1]`. The shorter dimension determines the length of the curvature.

Example: `[0.5 0.6]`

Example: `0.75`

Outline color, specified as an RGB triplet or one of the color options listed in the table. The default RGB triplet value of `[0 0 0]` corresponds to black.

For a custom color, specify an RGB triplet. An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range `[0,1]`; for example, `[0.4 0.6 0.7]`. Alternatively, you can specify some common colors by name. This table lists the long and short color name options and the equivalent RGB triplet values.

OptionDescriptionEquivalent RGB Triplet
`'red'` or `'r'`Red`[1 0 0]`
`'green'` or `'g'`Green`[0 1 0]`
`'blue'` or `'b'`Blue`[0 0 1]`
`'yellow'` or `'y'`Yellow`[1 1 0]`
`'magenta'` or `'m'`Magenta`[1 0 1]`
`'cyan'` or `'c'`Cyan`[0 1 1]`
`'white'` or `'w'`White`[1 1 1]`
`'black'` or `'k'`Black`[0 0 0]`
`'none'`No colorNot applicable

Example: `'blue'`

Example: `[0 0 1]`

Fill color, specified as an RGB triplet or one of the color options listed in the table.

For a custom color, specify an RGB triplet. An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range `[0,1]`; for example, `[0.4 0.6 0.7]`. Alternatively, you can specify some common colors by name. This table lists the long and short color name options and the equivalent RGB triplet values.

OptionDescriptionEquivalent RGB Triplet
`'red'` or `'r'`Red`[1 0 0]`
`'green'` or `'g'`Green`[0 1 0]`
`'blue'` or `'b'`Blue`[0 0 1]`
`'yellow'` or `'y'`Yellow`[1 1 0]`
`'magenta'` or `'m'`Magenta`[1 0 1]`
`'cyan'` or `'c'`Cyan`[0 1 1]`
`'white'` or `'w'`White`[1 1 1]`
`'black'` or `'k'`Black`[0 0 0]`
`'none'`No colorNot applicable

Example: `'blue'`

Example: ```[0 0 1]```

Line style, specified as one of the line styles listed in this table.

Line StyleDescriptionResulting Line
`'-'`Solid line

`'--'`Dashed line

`':'`Dotted line

`'-.'`Dash-dotted line

`'none'`No lineNo line

Line width, specified as a positive value in point units.

Example: `0.75`

Sharp vertical and horizontal lines, specified as `'off'` or `'on'`.

If the associated figure has a `GraphicsSmoothing` property set to `'on'` and a `Renderer` property set to `'opengl'`, then the figure applies a smoothing technique to plots. In some cases, this smoothing technique can cause vertical and horizontal lines to appear uneven in thickness or color. Use the `AlignVertexCenters` property to eliminate the uneven appearance.

• `'off'` — Do not sharpen vertical or horizontal lines. The lines might appear uneven in thickness or color.

• `'on'` — Sharpen vertical and horizontal lines to eliminate an uneven appearance.

### Note

You must have a graphics card that supports this feature. To see if the feature is supported, type `opengl info`. If it is supported, then the returned fields contain the line ```SupportsAlignVertexCenters: 1```.

## Location and Size

expand all

Size and location of the rectangle, specified as a four-element vector of the form `[x y width height]`. Specify the values in data units. The `x` and `y` elements define the coordinate for the lower-left corner of the rectangle. The `width` and `height` elements define the dimensions of the rectangle.

Example: `[0.5 0.5 0.3 0.4]`

## Visibility

expand all

State of visibility, specified as one of these values:

• `'on'` — Display the object.

• `'off'` — Hide the object without deleting it. You still can access the properties of an invisible object.

Clipping of the object to the axes limits, specified as one of these values:

• `'on'` — Do not display parts of the object that are outside the axes limits.

• `'off'` — Display the entire object, even if parts of it appear outside the axes limits. Parts of the object might appear outside the axes limits if you create a plot, set `hold on`, freeze the axis scaling, and then create the object so that it is larger than the original plot.

The `Clipping` property of the axes that contains the object must be set to `'on'`. Otherwise, this property has no effect. For more information about the clipping behavior, see the `Clipping` property of the axes.

### Note

`EraseMode` has been removed. You can delete code that accesses the `EraseMode` property with minimal impact. If you were using `EraseMode` to create line animations, use the `animatedline` function instead.

Technique to draw and erase objects, specified as one of these values:

• `'normal'` — Redraw the affected region of the display, performing the three-dimensional analysis necessary to correctly render all objects. This mode produces the most accurate picture, but is the slowest. The other modes are faster, but do not perform a complete redraw and, therefore, are less accurate.

• `'none'` — Do not erase the object when it is moved or destroyed. After you erase the object with `EraseMode,'none'`, it is still visible on the screen. However, you cannot print the object because MATLAB® does not store any information on its former location.

• `'xor'` — Draw and erase the object by performing an exclusive OR (XOR) with the color of the screen beneath it. This mode does not damage the color of the objects beneath it. However, the object color depends on the color of whatever is beneath it on the display.

• `'background'` — Erase the object by redrawing it in the axes background color, or the figure background color if the axes `Color` property is `'none'`. This damages objects that are behind the erased object, but properly colors the erased object.

MATLAB always prints figures as if the `EraseMode` property of all objects is set to `'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 mathematically combines layers of colors and ignores three-dimensional sorting to obtain greater rendering speed. However, MATLAB does not apply these techniques to the printed output. Use the `getframe` command or other screen capture applications to create an image of a figure containing nonnormal mode objects.

## Identifiers

expand all

Type of graphics object, returned as `'rectangle'`. Use this property to find all objects of a given type within a plotting hierarchy, for example, searching for the type using `findobj`.

Tag to associate with the object, specified as a character vector or string.

Use this property to find objects in a hierarchy. For example, you can use the `findobj` function to find objects that have a specific `Tag` property value.

Example: `'January Data'`

Data to associate with the object, specified as any MATLAB data, for example, a scalar, vector, matrix, cell array, character array, table, or structure. MATLAB does not use this data.

To associate multiple sets of data or to attach a field name to the data, use the `getappdata` and `setappdata` functions.

Example: `1:100`

## Parent/Child

expand all

Parent, specified as an `Axes`, `Group`, or `Transform` object.

The object has no children. You cannot set this property.

Visibility of the object handle in the `Children` property of the parent, specified as one of these values:

• `'on'` — Object handle is always visible.

• `'off'` — Object handle is invisible at all times. This option is useful for preventing unintended changes to the UI by another function. Set the `HandleVisibility` to `'off'` to temporarily hide the handle during the execution of that function.

• `'callback'` — Object handle is visible from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line. This option blocks access to the object at the command line, but allows callback functions to access it.

If the object is not listed in the `Children` property of the parent, then functions that obtain object handles by searching the object hierarchy or querying handle properties cannot return it. This includes `get`, `findobj`, `gca`, `gcf`, `gco`, `newplot`, `cla`, `clf`, and `close`.

Hidden object handles are still valid. Set the root `ShowHiddenHandles` property to `'on'` to list all object handles regardless of their `HandleVisibility` property setting.

## Interactive Control

expand all

Mouse-click callback, specified as one of these values:

• Function handle

• Cell array containing a function handle and additional arguments

• Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

Use this property to execute code when you click the object. If you specify this property using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:

• Clicked object — You can access properties of the clicked object from within the callback function.

• Event data — This argument is empty for this property. Replace it with the tilde character (`~`) in the function definition to indicate that this argument is not used.

For more information on how to use function handles to define callback functions, see Callback Definition.

### Note

If the `PickableParts` property is set to `'none'` or if the `HitTest` property is set to `'off'`, then this callback does not execute.

Context menu, specified as a `ContextMenu` object. Use this property to display a context menu when you right-click the object. Create the context menu using the `uicontextmenu` function.

### Note

If the `PickableParts` property is set to `'none'` or if the `HitTest` property is set to `'off'`, then the context menu does not appear.

Selection state, specified as one of these values:

• `'on'` — Selected. If you click the object when in plot edit mode, then MATLAB sets its `Selected` property to `'on'`. If the `SelectionHighlight` property also is set to `'on'`, then MATLAB displays selection handles around the object.

• `'off'` — Not selected.

Display of selection handles when selected, specified as one of these values:

• `'on'` — Display selection handles when the `Selected` property is set to `'on'`.

• `'off'` — Never display selection handles, even when the `Selected` property is set to `'on'`.

## Callback Execution Control

expand all

Ability to capture mouse clicks, specified as one of these values:

• `'visible'` — Can capture mouse clicks when visible. The `Visible` property must be set to `'on'` and you must click a part of the `Rectangle` object that has a defined color. You cannot click a part that has an associated color property set to `'none'`. The `HitTest` property determines if the `Rectangle` object responds to the click or if an ancestor does.

• `'all'` — Can capture mouse clicks regardless of visibility. The `Visible` property can be set to `'on'` or `'off'` and you can click a part of the `Rectangle` object that has no color. The `HitTest` property determines if the `Rectangle` object responds to the click or if an ancestor does.

• `'none'` — Cannot capture mouse clicks. Clicking the `Rectangle` object passes the click through it to the object below it in the current view of the figure window. The `HitTest` property has no effect.

Response to captured mouse clicks, specified as one of these values:

• `'on'` — Trigger the `ButtonDownFcn` callback of the `Rectangle` object. If you have defined the `UIContextMenu` property, then invoke the context menu.

• `'off'` — Trigger the callbacks for the nearest ancestor of the `Rectangle` object that has:

• The `HitTest` property set to `'on'`

• The `PickableParts` property set to a value that enables the ancestor to capture mouse clicks.

### Note

The `PickableParts` property determines if the `Rectangle` object can capture mouse clicks. If it cannot, then the `HitTest` property has no effect.

Callback interruption, specified as `'on'` or `'off'`. The `Interruptible` property determines if a running callback can be interrupted.

### Note

There are two callback states to consider:

• The running callback is the currently executing callback.

• The interrupting callback is a callback that tries to interrupt the running callback.

Whenever MATLAB invokes a callback, that callback attempts to interrupt a running callback. The `Interruptible` property of the object owning the running callback determines if interruption is allowed. If interruption is not allowed, then the `BusyAction` property of the object owning the interrupting callback determines if it is discarded or put in the queue.

If the `ButtonDownFcn` callback of the `Rectangle` object is the running callback, then the `Interruptible` property determines if it another callback can interrupt it:

• `'on'` — Interruptible. Interruption occurs at the next point where MATLAB processes the queue, such as when there is a `drawnow`, `figure`, `getframe`, `waitfor`, or `pause` command.

• If the running callback contains one of these commands, then MATLAB stops the execution of the callback at this point and executes the interrupting callback. MATLAB resumes executing the running callback when the interrupting callback completes. For more information, see Interrupt Callback Execution.

• If the running callback does not contain one of these commands, then MATLAB finishes executing the callback without interruption.

• `'off'` — Not interruptible. MATLAB finishes executing the running callback without any interruptions.

Callback queuing specified as `'queue'` or `'cancel'`. The `BusyAction` property determines how MATLAB handles the execution of interrupting callbacks.

There are two callback states to consider:

• The running callback is the currently executing callback.

• The interrupting callback is a callback that tries to interrupt the running callback.

Whenever MATLAB invokes a callback, that callback attempts to interrupt a running callback. The `Interruptible` property of the object owning the running callback determines if interruption is allowed. If interruption is not allowed, then the `BusyAction` property of the object owning the interrupting callback determines if it is discarded or put in the queue.

If a callback of the `Rectangle` object tries to interrupt a running callback that cannot be interrupted, then the `BusyAction` property determines if it is discarded or put in the queue. Specify the `BusyAction` property as one of these values:

• `'queue'` — Put the interrupting callback in a queue to be processed after the running callback finishes execution. This is the default behavior.

• `'cancel'` — Discard the interrupting callback.

## Creation and Deletion Control

expand all

Creation callback, specified as one of these values:

• Function handle

• Cell array containing a function handle and additional arguments

• Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

Use this property to execute code when you create the object. MATLAB executes the callback after creating the object and setting all of its properties. Setting the `CreateFcn` property on an existing object has no effect. To have an effect, you must specify the `CreateFcn` property during object creation. One way to specify the property during object creation is to set the default property value for the object. See Default Property Values for more information.

If you specify this callback using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:

• Created object — You can access properties of the object from within the callback function. You also can access the object through the `CallbackObject` property of the root, which can be queried using the `gcbo` function.

• Event data — This argument is empty for this property. Replace it with the tilde character (`~`) in the function definition to indicate that this argument is not used.

For more information on how to use function handles to define callback functions, see Callback Definition.

Deletion callback, specified as one of these values:

• Function handle

• Cell array containing a function handle and additional arguments

• Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

Use this property to execute code when you delete the object MATLAB executes the callback before destroying the object so that the callback can access its property values.

If you specify this callback using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:

• Deleted object — You can access properties of the object from within the callback function. You also can access the object through the `CallbackObject` property of the root, which can be queried using the `gcbo` function.

• Event data — This argument is empty for this property. Replace it with the tilde character (`~`) in the function definition to indicate that this argument is not used.

For more information on how to use function handles to define callback functions, see Callback Definition.

Deletion status, returned as `'off'` or `'on'`. MATLAB sets the `BeingDeleted` property to `'on'` when the delete function of the object begins execution (see the `DeleteFcn` property). The `BeingDeleted` property remains set to `'on'` until the object no longer exists.

Check the value of the `BeingDeleted` property to verify that the object is not about to be deleted before querying or modifying it.