Primitive Surface Properties

Control primitive surface appearance and behavior

Primitive surface properties control the appearance and behavior of primitive surface objects. By changing property values, you can modify certain aspects of the primitive surface.

Starting in R2014b, you can use dot notation to refer to a particular object and property:

h = surface;
c = h.CData;
h.CDataMapping = 'direct';

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

Faces

expand all

FaceColorFace color'flat' (default) | 'interp' | 'none' | 'texturemap' | RGB triplet or color string

Face color, specified as one of these values:

  • 'flat' — Use uniform face colors. Use the CData values. The color data at the first vertex determines the color for the entire face. You cannot use this value when the FaceAlpha property is set to 'interp'.

  • 'interp' — Interpolate the face colors. Bilinear interpolation of the CData values at each vertex determines the colors. You cannot use this value when the FaceAlpha property is set to 'flat'.

  • 'none' — Do not draw the faces.

  • 'texturemap' — Transform the color data in CData so that it conforms to the surface.

  • RGB triplet or color string — Use the same color for all of the faces.

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]

FaceAlphaFace transparency1 (default) | scalar in range [0,1] | 'flat' | 'interp'

Face transparency, specified as one of these values:

  • Scalar in range [0,1] — Use the same transparency value for all of the faces. A value of 1 is fully opaque and 0 is completely transparent.

  • 'flat' — Use uniform transparency across each face. Use the AlphaData values to determine the transparency values. The alpha data at the first vertex determines the transparency for the entire face. You must first specify the AlphaData property as a matrix equal in size to ZData. You cannot use this value when the FaceColor property is set to 'interp'.

  • 'interp' — Interpolate the transparency across each face. Bilinear interpolation of the AlphaData values at each vertex determines the transparency values. You must first specify the AlphaData property as a matrix equal in size to ZData. You cannot use this value when the FaceColor property is set to 'flat'.

FaceLightingEffect of light objects on faces'flat' (default) | 'gouraud' | 'none'

Effect of light objects on faces, specified as one of these values:

  • 'flat' — Apply light uniformly across the faces. Use this value to view faceted objects.

  • 'gouraud' — Vary the light across the faces. Calculate the light at the vertices and then linearly interpolate the light across the faces. Use this value to view curved surfaces.

  • 'none' — Do not apply light from light objects to the faces.

    Note:   The 'phong' value has been removed. Use 'gouraud' instead.

BackFaceLightingFace lighting when normals point away from camera'reverslit' (default) | 'unlit' | 'lit'

Face lighting when the vertex normals point away from camera, specified as one of these values:

  • 'reverslit' — Light the face as if the vertex normal pointed towards the camera.

  • 'unlit' — Do not light the face.

  • 'lit' — Light the face according to the vertex normal.

Use this property to discriminate between the internal and external surfaces of an object. For an example, see Back Face Lighting.

Edges

expand all

EdgeColorEdge line color[0 0 0] (default) | 'none' | 'flat' | 'interp' | RGB triplet or color string

Surface edge line color, specified as one of these values:

  • 'none' — Do not draw edges.

  • 'flat' — Draw uniform edge colors. Use the CData value of the first vertex of the face to determine the color for each edge. You cannot use this value when the EdgeAlpha property is set to 'interp'.

  • 'interp' — Interpolate the edge colors. Use a linear interpolation of the CData values at the face vertices to determine the edge color. You cannot use this value when the EdgeAlpha property is set to 'flat'.

  • RGB triplet or color string — Use the same color for all edges.

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]

EdgeAlphaSurface edge transparency1 (default) | scalar value in range[0,1] | 'flat' | 'interp'

Surface edge transparency, specified as one of these values:

  • Scalar in range[0,1] — Use the same transparency value for all of the edges. A value of 1 is fully opaque and 0 is completely transparent.

  • 'flat' — Use uniform transparency across each edge. Use the values in AlphaData to determine the transparency for each edge. The value at the first vertex of the face determines the transparency for the edge. You must specify AlphaData as a matrix equal in size to ZData. You cannot use this value when the EdgeColor property is set to 'interp'.

  • 'interp' — Interpolate the transparency across each edge. Use a bilinear interpolation of the AlphaData values for each vertex. You must specify AlphaData as a matrix equal in size to ZData. You cannot use this value when the EdgeColor property is set to 'flat'.

EdgeLightingEffect of light objects on edges'none' (default) | 'flat' | 'gouraud'

Effect of light objects on edges, specified as one of these values:

  • 'flat' — Apply light uniformly across the each edges.

  • 'none' — Do not apply lights from light objects to the edges.

  • 'gouraud' — Calculate the light at the vertices, and then linearly interpolate across the edges.

    Note:   The 'phong' value has been removed. Use 'gouraud' instead.

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. If the line has markers, then the line width also affects the marker edges.

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.

MeshStyleEdges to display'both' (default) | 'row' | 'column'

Edges to display, specified as 'both', 'row', or 'column'.

Markers

expand all

MarkerMarker symbol'none' (default) | marker string

Marker symbol, specified as one of the marker strings listed in this table. By default, the primitive surface object does not display markers. Specifying a marker symbol adds markers at each data point or vertex.

StringMarker Symbol
'o'Circle
'+'Plus sign
'*'Asterisk
'.'Point
'x'Cross
'square' or 's'Square
'diamond' or 'd'Diamond
'^'Upward-pointing triangle
'v'Downward-pointing triangle
'>'Right-pointing triangle
'<'Left-pointing triangle
'pentagram' or 'p'Five-pointed star (pentagram)
'hexagram' or 'h'Six-pointed star (hexagram)
'none'No markers

Example: '+'

Example: 'diamond'

MarkerSizeMarker size6 (default) | positive value

Marker size, specified as a positive value in point units.

Example: 10

MarkerEdgeColorMarker outline color 'auto' (default) | 'none' | 'flat' | RGB triplet or color string

Marker outline color, specified as specified as one of these values:

  • 'auto' — Use the same color as the EdgeColor property.

  • 'none' — Use no color, which makes unfilled markers invisible.

  • 'flat' — Use the CData value at the vertex to set the color.

  • RGB triplet or color string — Use the specified color.

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: [0.5 0.5 0.5]

Example: 'blue'

MarkerFaceColorMarker fill color'none' (default) | 'auto' | 'flat' | RGB triplet or color string

Marker fill color, specified as one of these values:

  • 'none' — Use no color, which allows the background to show through.

  • 'auto' — Use the same color as the Color property for the axes.

  • 'flat' — Use the CData value of the vertex to set the color.

  • RGB triplet or color string — Use the specified color.

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]

This property affects only the circle, square, diamond, pentagram, hexagram, and the four triangle marker types.

Example: [0.3 0.2 0.1]

Example: 'green'

Example:

Face and Vertex Normals

expand all

FaceNormalsNormal vectors for each surface face[] (default) | (m-1)-by-(n-1)-by-3 array

Normal vectors for each surface face, specified as a (m-1)-by-(n-1)-by-3 array, where [m,n] = size(ZData). Specify one normal vector per face.

Specifying values for this property sets the associated mode to manual. If you do not specify normal vectors, then the surface generates this data for lighting calculations.

Data Types: single | double

FaceNormalsModeSelection mode for FaceNormals 'auto' (default) | 'manual'

Selection mode for FaceNormals, specified as one of these values:

  • 'auto' — Calculate the normal vectors based on the coordinate data.

  • 'manual' — Use manually specified values. To specify the values, set the FaceNormals property.

VertexNormalsNormal vectors for each surface vertex[] (default) | m-by-n-by-3 array

Normal vectors for each surface vertex, specified as a m-by-n-by-3 array, where [m,n] = size(ZData). Specify one normal vector per vertex.

Specifying values for this property sets the associated mode to manual. If you do not specify normal vectors, then the surface generates this data for lighting calculations.

Data Types: single | double

VertexNormalsModeSelection mode for VertexNormals'auto' (default) | 'manual'

Selection mode for VertexNormals, specified as one of these values:

  • 'auto' — Calculate the normal vectors based on the coordinate data.

  • 'manual' — Use manually specified values. To specify the values, set the VertexNormals property.

Color and Transparency Mapping

expand all

AlphaDataTransparency data1 (default) | scalar | m-by-n array

Transparency data for each face or each vertex, specified in one of these forms:

  • Scalar — Use the same transparency value.

  • m-by-n array — Use different transparency values for each face or vertex. Specify an m-by-n array of numeric values where [m,n] = size(ZData).

The AlphaDataMapping property determines the mapping of transparency data values into the alphamap. The Alphamap property for the figure contains the alphamap.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

AlphaDataMappingTransparency data mapping method'scaled' (default) | 'direct' | 'none'

Transparency data mapping method, specified as 'scaled', 'none', or 'direct'. Use this property to control the mapping of transparency values contained in AlphaData into the figure alphamap.

The methods have these effects:

  • 'scaled' — Transform the values to range between the alpha limits and then linearly map the data values to the alpha values. The ALim property for the axes contains the alpha limits.

  • 'none' — Clamp the values between 0 and 1. A value of 1 or greater is completely opaque and 0 or less is transparent.

  • 'direct' — Interpret the values as indices directly into the figure alphamap. When not scaled, the values are usually integer values ranging from 1 to length(alphamap). MATLAB® maps values less than 1 to the first value in the alphamap and values greater than length(alphamap) to the last value in the alphamap. Values with a decimal portion are fixed to the nearest lower integer. If AlphaData is an array of uint8 integers, then the indexing begins at 0 (that is, MATLAB maps a value of 0 to the first alpha value in the alphamap).

CDataVertex colors2-D or 3-D array

Vertex colors, specified in one of these forms:

  • 2-D array — Use colormap colors. Specify a color for each vertex by setting CData to an array the same size as ZData. The CDataMapping property determines how these values map into the current colormap. If the FaceColor property is set to 'texturemap', then CData does not need to be the same size as ZData. However, it must be of type double or uint8. The CData values map to conform to the surface defined by ZData.

  • 3-D array — Use true colors. Specify an RGB triplet color for each vertex by setting CData to an m-by-n-by-3 array where [m,n] = size(ZData). An RGB triplet is a three-element vector that specifies the intensities of the red, green, and blue components of a color. The first page of the array contains the red components, the second the green components, and the third the blue components of the colors. Since the surface uses true colors instead of colormap colors, the CDataMapping property has no effect.

    • If CData is of type double or single, then an RGB triplet value of [0 0 0] corresponds to black and [1 1 1] corresponds to white.

    • If CData is an integer type, then the surface uses the full range of data to determine the color. For example, if CData is of type uint8, then [0 0 0] corresponds to black and [255 255 255] corresponds to white. If CData is of type int8, then [-255 -255 -255] corresponds to black and [255 255 255] corresponds to white.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

CDataMappingDirect or scaled colormapping'scaled' (default) | 'direct'

Direct or scaled colormapping, specified as one of these values:

  • scaled — Transform the color data to span the portion of the colormap indicated by the axes CLim property, linearly mapping data values to colors. See the caxis reference page for more information on this mapping.

  • direct — Use the color data as indices directly into the colormap. The color data should then be integer values ranging from 1 to length(colormap). MATLAB maps values less than 1 to the first color in the colormap, and values greater than length(colormap) to the last color in the colormap. Values with a decimal portion are fixed to the nearest lower integer.

CDataModeSelection mode for CData'auto' (default) | 'manual'

Selection mode for CData, specified as one of these values:

  • 'auto' — Use the ZData values to set the colors.

  • 'manual' — Use manually specified values. To specify the values, set the CData property.

Lighting

expand all

AmbientStrengthStrength of ambient light0.3 (default) | scalar in range [0,1]

Strength of ambient light, specified as a scalar value in the range [0,1]. Ambient light is a nondirectional light that illuminates the entire scene. There must be at least one visible light object in the axes for the ambient light to be visible.

The AmbientLightColor property for the axes sets the color of the ambient light. The color is the same for all objects in the axes.

Example: 0.5

Data Types: double

DiffuseStrengthStrength of diffuse light0.6 (default) | scalar in range [0,1]

Strength of diffuse light, specified as a scalar value in the range [0,1]. Diffuse light is the nonspecular reflectance from light objects in the axes.

Example: 0.3

Data Types: double

SpecularColorReflectanceColor of specular reflections1 (default) | scalar in range [0,1]

Color of specular reflections, specified as a scalar value in the range [0,1]. A value of 1 sets the color using only the color of the light source. A value of 0 sets the color using both the color of the object from which it reflects and the color of the light source. The Color property of the light contains the color of the light source. The proportions vary linearly for values in between.

Example: 0.5

Data Types: double

SpecularExponentSize of specular spot10 (default) | scalar greater than or equal to 1

Size of specular spot, specified as a scalar value greater than or equal to 1. Most materials have exponents in the range [5 20].

Example: 7

Data Types: double

SpecularStrengthStrength of specular reflection0.9 (default) | scalar in range [0,1]

Strength of specular reflection, specified as a scalar value in the range [0,1]. Specular reflections are the bright spots on the surface from light objects in the axes.

Example: 0.3

Data Types: double

Data

expand all

XDatax-coordinate data[3x3 double] (default) | vector or matrix

x-coordinate data specified as a matrix that is the same size as ZData or a vector of length(n), where [m,n] = size(ZData).

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

YDatay-coordinate data[3x3 double] (default) | vector or matrix

y-coordinate data specified as a matrix that is the same size as ZData or a vector of length(m), where [m,n] = size(ZData).

Example:

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

ZDataz-coordinate data[3x3 double] (default) | 2–D array

z-coordinate data specified as a 2-D array of numeric values.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

XDataModeSelection mode for XData'auto' | 'manual'

Selection mode for XData, specified as one of these values:

  • 'auto' — Use the column indices of ZData.

  • 'manual' — Use manually specified value. To specify the value, pass an input argument to the plotting function or directly set the XData property.

YDataModeSelection mode for YData'auto' | 'manual'

Selection mode for YData, specified as one of these values:

  • 'auto' — Use the row indices of ZData.

  • 'manual' — Use manually specified value. To specify the value, pass an input argument to the plotting function or directly set the YData property.

Visibility

expand all

VisibleVisibility of primitive surface'on' (default) | 'off'

Visibility of primitive surface, specified as one of these values:

  • 'on' — Display the primitive surface.

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

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

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

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

  • 'off' — Display the entire primitive surface, even if parts of it appear outside the axes limits. Parts of the primitive surface might appear outside the axes limits if you create a plot, set hold on, freeze the axis scaling, and then create the primitive surface 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.

Parent/Child

expand all

ParentParent of primitive surfaceaxes object | group object | transform object

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

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 primitive surface object.

  • 'off' — Do not list the primitive surface 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 primitive surface 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 primitive surface 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.

ChildrenChildren of primitive surfaceempty GraphicsPlaceholder array

The primitive surface has no children. You cannot set this property.

Identifiers

expand all

TagUser-specified tag'' (default) | any string

Tag to associate with the primitive surface, 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'

TypeType of graphics object'surface'

This property is read only.

Type of graphics object, returned as the string 'surface'

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

Data to associate with the primitive surface 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

DisplayNameText used by legend'' (default) | string

Text used by the legend, specified as a string. The text appears next to an icon of the primitive surface.

  • If you specify text for the primitive surface object as an input argument to the legend function, then the legend uses the specified text and updates the DisplayName.

  • If you do not specify text for the primitive surface object as an input argument to the legend function, then the legend uses the text in the DisplayName property. If the DisplayName property does not contain any text, then the legend generates a string. The string has the form 'dataN', where N is the number assigned to the primitive surface object based on its location in the list of legend entries.

If you edit interactively the string in an existing legend, then MATLAB updates the DisplayName to the edited string.

Example: 'Text Description'

AnnotationLegend icon display styleAnnotation object

This property is read only.

Legend icon display style, returned as an Annotation object. Use this object to include or exclude the primitive surface from a legend.

  1. Query the Annotation property to get the Annotation object.

  2. Query the LegendInformation property of the Annotation object to get the LegendEntry object.

  3. Specify the IconDisplayStyle property of the LegendEntry object to one of these values:

    • 'on' — Include the primitive surface object in the legend as one entry (default).

    • 'off' — Do not include the primitive surface object in the legend.

    • 'children' — Include only children of the primitive surface object as separate entries in the legend.

If a legend already exists and you change the IconDisplayStyle setting, then you must call legend to update the display.

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

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

  • '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 primitive surface that has a defined color. You cannot click a part that has an associated color property set to 'none'. If the plot contains markers, then the entire marker is clickable if either the edge or the fill has a defined color. The HitTest property determines if the primitive surface 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 primitive surface that has no color. The HitTest property determines if the primitive surface responds to the click or if an ancestor does.

  • 'none' — Cannot capture mouse clicks. Clicking the primitive surface 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 primitive surface. If you have defined the UIContextMenu property, then invoke the context menu.

  • 'off' — Trigger the callbacks for the nearest ancestor of the primitive surface 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 primitive surface object can capture mouse clicks. If it cannot, then the HitTest property has no effect.

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

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

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 primitive surface. Setting the CreateFcn property on an existing primitive surface has no effect. You must define a default value for this property, or define this property using a Name,Value pair during primitive surface creation. MATLAB executes the callback after creating the primitive surface 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 primitive surface object — You can access properties of the primitive surface object from within the callback function. You also can access the primitive surface 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 primitive surface. MATLAB executes the callback before destroying the primitive surface 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 primitive surface object — You can access properties of the primitive surface object from within the callback function. You also can access the primitive surface 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 primitive surface'off' (default) | 'on'

This property is read only.

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

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

Was this topic helpful?