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 refer to a particular object and property:

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

If you are using an earlier release, use the get and set functions to query and set properties.

Appearance

expand all

CurvatureAmount of horizontal and vertical curvature[0 0] (default) | two-element vector | scalar

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

EdgeColorOutline color[0 0 0] (default) | RGB triplet | color string | 'none'

Outline color, specified as an RGB triplet, a color string, or 'none'. The 'none' option makes the edge invisible. The default RGB triplet value of [0 0 0] corresponds to black.

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]. This table lists RGB triplet values that have equivalent color strings.

Long NameShort NameRGB Triplet
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

Example: 'blue'

Example: [0 0 1]

FaceColorFill color'none' (default) | RGB triplet | color string

Fill color, specified as 'none', an RGB triplet, or a color string. The 'none' option makes the fill invisible.

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]. This table lists RGB triplet values that have equivalent color strings.

Long NameShort NameRGB Triplet
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

Example: 'blue'

Example: [0 0 1]

LineStyleLine style'-' (default) | '--' | ':' | '-.' | 'none'

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

StringLine StyleResulting Line
'-'Solid line

'--'Dashed line

':'Dotted line

'-.'Dash-dotted line

'none'No lineNo line

LineWidthLine width0.5 (default) | positive value

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

Example: 0.75

AlignVertexCentersSharp vertical and horizontal lines'off' (default) | 'on'

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

PositionSize and location of rectangle[0 0 1 1] (default) | four-element vector

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

VisibleVisibility of rectangle'on' (default) | 'off'

Visibility of rectangle, specified as one of these values:

  • 'on' — Display the rectangle.

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

ClippingClipping of rectangle to axes limits'on' (default) | 'off'

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

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

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

EraseMode(removed) Technique to draw and erase objects'normal' (default) | 'none' | 'xor' | 'background'

    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

TypeType of graphics object'rectangle'

This property is read only.

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.

TagTag to associate with rectangle'' (default) | string

Tag to associate with the rectangle, specified as a string. Tags provide a way to identify graphics objects. Use this property to find all objects with a specific tag within a plotting hierarchy, for example, searching for the tag using findobj.

Example: 'January Data'

UserDataData to associate with rectangle[] (default) | scalar, vector, or matrix | cell array | character array | table | structure

Data to associate with the rectangle object, specified as 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

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | struct | table | cell

DisplayName(unused) Legend text description'' (default) | string

    Note:   The behavior of the DisplayName property changed in R2014b, and it is not recommended. Rectangle objects do not use this property since legends do not include rectangle objects. This property might be removed in a future release.

Annotation(unused) Legend icon display styleAnnotation object

    Note:   The behavior of the Annotation property changed in R2014b, and it is not recommended. Rectangle objects do not use this property since legends do not include rectangle objects. This property might be removed in a future release.

Parent/Child

expand all

ParentParent of rectangleaxes object | group object | transform object

Parent of rectangle, specified as an axes, group, or transform object.

ChildrenChildren of rectangleempty GraphicsPlaceholder array

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

HandleVisibilityVisibility of object handle'on' (default) | 'off' | 'callback'

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

  • 'on' — List the rectangle object.

  • 'off' — Do not list the rectangle object. Use this option to hide object handles when a callback invokes a function that could damage the GUI, such as evaluating a user-typed string.

  • 'callback' — List the rectangle object in the Children property of the parent from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line. Use this option to protect a GUI from command-line users, while allowing callbacks to have access to objects.

If the rectangle 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

ButtonDownFcnMouse-click callback'' (default) | function handle | cell array | string

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

  • Function handle

  • Cell array containing a function handle and additional arguments

  • String 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 rectangle. If you specify this property using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:

  • The rectangle object — You can access properties of the rectangle 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.

Example: @myCallback

Example: {@myCallback,arg3}

UIContextMenuContext menuuicontextmenu object

Context menu, specified as a uicontextmenu object. Use this property to display a context menu when you right-click the rectangle. 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.

SelectedSelection state'off' (default) | 'on'

Selection state, specified as one of these values:

  • 'on' — Selected. If you click the rectangle 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 rectangle.

  • 'off' — Not selected.

SelectionHighlightDisplay of selection handles when selected'on' (default) | 'off'

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

PickablePartsAbility to capture mouse clicks'visible' (default) | 'all' | 'none'

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 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 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 that has no color. The HitTest property determines if the rectangle responds to the click or if an ancestor does.

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

HitTestResponse to captured mouse clicks'on' (default) | 'off'

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

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

  • 'off' — Trigger the callbacks for the nearest ancestor of the rectangle that has a HitTest property set to 'on' and a PickableParts property 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.

InterruptibleCallback interruption'on' (default) | 'off'

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 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.

BusyActionCallback queuing'queue' (default) | 'cancel'

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

    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 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

CreateFcnCreation callback'' (default) | function handle | cell array | string

Creation callback, specified as one of these values:

  • Function handle

  • Cell array containing a function handle and additional arguments

  • String 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 rectangle. Setting the CreateFcn property on an existing rectangle has no effect. You must define a default value for this property, or define this property using a Name,Value pair during rectangle creation. MATLAB executes the callback after creating the rectangle and setting all of its properties.

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

  • The rectangle object — You can access properties of the rectangle object from within the callback function. You also can access the rectangle 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.

Example: @myCallback

Example: {@myCallback,arg3}

DeleteFcnDeletion callback'' (default) | function handle | cell array | string

Deletion callback, specified as one of these values:

  • Function handle

  • Cell array containing a function handle and additional arguments

  • String 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 rectangle. MATLAB executes the callback before destroying the rectangle 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:

  • The rectangle object — You can access properties of the rectangle object from within the callback function. You also can access the rectangle 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.

Example: @myCallback

Example: {@myCallback,arg3}

BeingDeletedDeletion status of rectangle'off' (default) | 'on'

This property is read only.

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

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

Was this topic helpful?