Embed Size (px)
Citation preview
CONTENTS
Control patch appearance and behavior
•
•
•
•
•
collapse all
Patch Properties
Patch properties control the appearance and behavior of patch objects. By changing property values, you can modifycertain aspects of the patch.
Starting in R2014b, you can use dot notation to query and set properties.
h = patch;c = h.CData;h.CDataMapping = 'scaled';
If you are using an earlier release, use the get and set functions instead.
Faces
FaceColor — Face color[0 0 0] (default) | 'none' | 'flat' | 'interp' | RGB triplet or color string
Face color, specified as one of these values:
'none' — Do not draw the faces.
'flat' — Uniform face colors. Use the CData values. The color data at the first vertex determines the color forthe entire face. You must first specify CData or FaceVertexCData as an array containing one value per face.
'interp' — Vary the color across each face. Use a bilinear interpolation of the CData values at each vertex.You must first specify CData or FaceVertexCData as an array containing one value per vertex.
RGB triplet or color string — Same color for all of the faces.
An RGB triplet is a threeelement row vector whose elements specify the intensities of the red, green, and bluecomponents of the color. The intensities must be in the range [0,1], for example, [0.4 0.6 0.7]. This table listsRGB triplet values that have equivalent color strings.
Long Name Short Name RGB 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]
FaceAlpha — Face 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 0is completely transparent.
•
•
•
•
•
•
•
•
•
•
•
•
collapse all
'flat' — Use uniform transparency across each face. The alpha data at the first vertex determines thetransparency for the entire face. You must first specify the FaceVertexAlphaData property as an arraycontaining one alpha value per face.
'interp' — Vary the transparency across each face. Bilinear interpolation of the AlphaData values at eachvertex determines the transparency values. You must first specify the FaceVertexAlphaData property as anarray containing one alpha value per vertex.
FaceLighting — Effect 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 thelight 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.
BackFaceLighting — Face 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 BackFace Lighting.
Edges
EdgeColor — Edge color of the patch faces[0 0 0] (default) | 'none' | 'flat' | 'interp' | RGB triplet or color string
Color of the edges of the patch faces, specified as one of these values:
'none' — Do not draw edges.
'flat' — Use the color of each vertex to set the color of the edge that follows it. This means that the edgecoloring is dependent on the order in which you specify the vertices:
'interp' — Linearly interpolate the CData or FaceVertexCData values at the vertices determines the edgecolor.
RGB triplet or a color string — Use the same color for all edges.
An RGB triplet is a threeelement row vector whose elements specify the intensities of the red, green, and bluecomponents 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 Name Short Name RGB 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: 'flat'
LineStyle — Line style'‐' (default) | '‐‐' | ':' | '‐.' | 'none'
Line style, specified as one of the line style strings listed in this table.
String Line Style Resulting Line
'‐' Solid line
'‐‐' Dashed line
':' Dotted line
'‐.' Dashdotted line
'none' No line No line
LineWidth — Line 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 themarker edges.
Example: 0.75
EdgeAlpha — Transparency of patch face edges1 (default) | scalar value in range [0,1] | 'flat' | 'interp'
Transparency of patch face edges, specified as one of these values:
Scalar value in range [0,1] — Use the same transparency value for all of the edges.. A value of 1 is fullyopaque and 0 is completely transparent.
'flat' — Uniform transparency along each edge. Before you set EdgeAlpha to 'flat', you must first defineFaceVertexAlphaData as an array containing one alpha value per face. The alpha data of each vertex controlsthe transparency of the edge that follows it.
'interp' — Very the transparency along edge segment. Before you set EdgeAlpha to 'interp', you must firstdefine FaceVertexAlphaData as an array containing one alpha value per vertex. Linear interpolation of thealpha data at each vertex determines the transparency of the edge connecting those vertices.
•
•
•
•
•
collapse all
EdgeLighting — Effect 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.
AlignVertexCenters — Sharp 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 verticaland horizontal lines to appear uneven in thickness or color. Use the AlignVertexCenters property to eliminate theuneven 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 openglinfo. If it is supported, then the returned fields contain the line SupportsAlignVertexCenters: 1.
Markers
Marker — Marker symbol'none' (default) | marker string
Marker symbol, specified as one of the marker strings listed in this table. By default, the patch object does notdisplay markers. Specifying a marker symbol adds markers at each data point or vertex.
String Marker Symbol
'o' Circle
'+' Plus sign
'*' Asterisk
'.' Point
'x' Cross
'square' or 's' Square
'diamond' or 'd' Diamond
'^' Upwardpointing triangle
'v' Downwardpointing triangle
'>' Rightpointing triangle
'<' Leftpointing triangle
'pentagram' or 'p' Fivepointed star (pentagram)
'hexagram' or 'h' Sixpointed star (hexagram)
'none' No markers
•
•
•
•
•
•
•
•
Example: '+'
Example: 'diamond'
MarkerEdgeColor — Marker 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 threeelement row vector whose elements specify the intensities of the red, green, and bluecomponents of the color. The intensities must be in the range [0,1], for example, [0.4 0.6 0.7]. This table listsRGB triplet values that have equivalent color strings.
Long Name Short Name RGB 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'
MarkerFaceColor — Marker 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 threeelement row vector whose elements specify the intensities of the red, green, and bluecomponents of the color. The intensities must be in the range [0,1], for example, [0.4 0.6 0.7]. This table listsRGB triplet values that have equivalent color strings.
Long Name Short Name RGB Triplet
'yellow' 'y' [1 1 0]
'magenta' 'm' [1 0 1]
'cyan' 'c' [0 1 1]
'red' 'r' [1 0 0]
•
•
collapse all
'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:
MarkerSize — Marker size6 (default) | positive value
Marker size, specified as a positive value in point units.
Example: 10
Face and Vertex Normals
FaceNormals — Face normal vectorsmbynby3 array (default) | array of normal vectors
Face normal vectors, specified as an array of normal vectors with one normal vector one per patch face. Define onenormal per patch face, as determined by the size of the Faces property value. Face normals determine theorientation of each patch face. This data is used for lighting calculations.
Specifying values for this property sets the associated mode to manual. If you do not specify normal vectors, thenthe patch generates this data when the axes contains light objects. The patch computes face normals usingNewell's method.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
VertextNormals — Vertex normal vectorsmbynby3 array (default) | array of normal vectors
Vertex normal vectors, specified as an array of normal vectors with one normal vector one per patch vertex. Defineone normal per patch vertex, as determined by the size of the Vertices property value. Vertex normals determinethe shape and orientation of the patch. This data is used for lighting calculations.
Specifying values for this property sets the associated mode to manual. If you do not specify normal vectors, thenthe patch generates this data when the axes contains light objects.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
FaceNormalsMode — Selection mode for FaceNormals'auto' (default) | 'manual'
Selection mode for FaceNormals, specified as one of these values:
'auto' — The patch function calculates face normals when you add a light to the scene.
'manual' — Use the face normal data specified by the FaceNormals property. Assigning values to theFaceNormals property sets FaceNormalsMode to 'manual'.
•
•
•
•
collapse all
VertexNormalsMode — Selection mode for VertexNormals'auto' (default) | 'manual'
Selection mode for VertexNormals, specified as one of these values:
'auto' — The patch function calculates vertex normals when you add a light to the scene.
'manual' — Use the vertex normal data specified by the VertexNormals property. Assigning values to theVertexNormals property sets VertexNormalsMode to 'manual'.
Ambient Lighting
AmbientStrength — Strength 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 thatilluminates the entire scene. There must be at least one visible light object in the axes for the ambient light to bevisible.
The AmbientLightColor property for the axes sets the color of the ambient light. The color is the same for allobjects in the axes.
Example: 0.5
Data Types: double
DiffuseStrength — Strength 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 reflectancefrom light objects in the axes.
Example: 0.3
Data Types: double
SpecularStrength — Strength 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 brightspots on the surface from light objects in the axes.
Example: 0.3
Data Types: double
SpecularColorReflectance — Color of specular reflections1 (default) | scalar between 0 and 1 inclusive
Color of specular reflections, specified as a scalar between 0 and 1 inclusive.
0 — The color of the specular reflection depends on both the color of the object from which it reflects and thecolor of the light source.
1 — The color of the specular reflection depends only on the color or the light source (that is, the light objectColor property).
The contributions from the light source color and the patch color to the specular reflection color vary linearly forvalues between 0 and 1.
•
•
•
•
•
•
•
collapse all
Example: 0.5
Data Types: single | double
SpecularExponent — Expansiveness of specular reflection10 (default) | scalar value greater than 0
Expansiveness of specular reflection, specified as a scalar value greater than 0. SpecularExponent controls thesize of the specular reflection spot. Greater values produce less specular reflection.
Most materials have exponents in the range of 5 to 20.
Example: 17
Data Types: double
Color and Transparency Mapping
FaceVertexAlphaData — Face and vertex transparency data[] (default) | single transparency value | column vector of transparency values
Face and vertex transparency data, specified in one of these forms:
A single transparency value, which applies the same transparency to the entire patch. The FaceAlpha propertymust be set to 'flat'.
An mby1 array (where m is the number of rows in the Faces property), which specifies one transparency valueper face. The FaceAlpha property must be set to 'flat'.
An mby1 array (where m is the number of rows in the Vertices property), which specifies one transparencyvalue per vertex. The FaceAlpha property must be set to 'interp'.
The AlphaDataMapping property determines how MATLAB interprets the FaceVertexAlphaData property values.
AlphaDataMapping — Transparency mapping method'scaled' (default) | 'direct' | 'none'
Transparency mapping method, specified as one of these values:
'none' — Clamps the elements of FaceVertexAlphaData to the region between 0 and 1. A value of 1 orgreater means completely opaque, a value of 0 or less means completely transparent, and a value between 0and 1 means semitransparent.
'scaled' — Transforms the FaceVertexAlphaData to span the portion of the figure alphamap indicated by theaxes ALim property, linearly mapping data values to alpha values.
'direct' — Uses the FaceVertexAlphaData as indices directly into the figure alphamap, which is determinedby the figure Alphamap property. Values with a decimal portion are fixed to the nearest lower integer. MATLABmaps values less than 1 to the first value in the alphamap and values greater than length(alphamap) to thelast value in the alphamap. If FaceVertexAlphaData 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).
FaceVertexCData — Face and vertex colors[] (default) | single color for entire patch | one color per face | one color per vertex
Face and vertex colors, specified as a single color for the entire patch, one color per face, or one color per vertex forinterpolated face color.
If you want to use indexed colors, then specify FaceVertexCData in one of these forms:
For one color for the entire patch, use a single value.
®
•
•
•
•
•
•
•
•
For one color per face, use an mby1 column vector, where m is the number of rows in the Faces property.
For interpolated face color, use an mby–1 column vector where m is the number of rows in the Verticesproperty.
If you want to use true colors, then specify FaceVertexCData in one of these forms:
For one color for the entire patch, use a threeelement row vector defining an RGB triplet.
For one color per face, use an mby3 array of RBG triplets, where m is the number of rows in the Facesproperty.
For interpolated face color, use an mby3 array, where m is the number of rows in the Vertices property.
The following diagram illustrates the various forms of the FaceVertexCData property for a patch having eight facesand nine vertices. The CDataMapping property determines how MATLAB interprets the FaceVertexCData propertywhen you specify indexed colors.
CData — Patch color datasingle color for entire patch | one color per face | one color per vertex
Patch color data, specified as a single color for the entire patch, one color per face, or one color per vertex.
The way the patch function interprets CData depends on the type of data supplied. Specify CData in one of theseforms:
Numeric values that are scaled to map linearly into the current colormap.
Integer values that are used directly as indices into the current colormap.
Arrays of RGB triplets. RGB triplets are not mapped into the current colormap, but interpreted as the colorsdefined.
The following diagrams illustrate the dimensions of CData with respect to the arrays in the XData, YData, and ZDataproperties.
These diagrams illustrates the use of indexed color.
•
These diagrams illustrates the use of true color. True color requires either a single RGB triplet or an array of RGBtriplets.
If CData contains NaNs, then patch does not color the faces.
An alternative method for defining patches uses the Faces, Vertices, and FaceVertexCData properties.
Example: [1,0,0]
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
CDataMapping — Direct or scaled color data mapping'scaled' (default) | 'direct'
Direct or scaled color data mapping, specified as 'scaled' (the default) or 'direct'. The CData andFaceVertexCData properties contains color data. If you use true color specification for CData or FaceVertexCData,then this property has no effect.
'direct' — Interpret the values as indices into the current colormap. Values with a decimal portion are fixed tothe nearest lower integer.
˗
˗
˗
•
collapse all
If the values are of type double or single, then values of 1 or less map to the first color in the colormap.Values equal to or greater than the length of the colormap map to the last color in the colormap.
If the values are of type uint8, uint16, uint32, uint64 , int8, int16, int32, or int64, then values of 0 orless map to the first color in the colormap. Values equal to or greater than the length of the colormap map tothe last color in the colormap (or up to the range limits of the type).
If the values are of type logical, then values of 0 map to the first color in the colormap and values of 1 mapto the second color in the colormap.
'scaled' — Scale the values to range between the minimum and maximum color limits. The CLim property ofthe axes contains the color limits.
Data
XData — xcoordinates of the patch verticesvector | matrix
The xcoordinates of the patch vertices, specified as a vector or a matrix. If XData is a matrix, then each columnrepresents the xcoordinates of a single face of the patch. In this case, XData, YData, and ZData must have thesame dimensions.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
YData — ycoordinates of the patch verticesvector | matrix
The ycoordinates defining the patch, specified as a vector or a matrix. If YData is a matrix, then each columnrepresents the ycoordinates of a single face of the patch. In this case, XData, YData, and ZData must have thesame dimensions.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
ZData — zcoordinates of the patch verticesvector | matrix
The zcoordinates of the patch vertices, specified as a vector or a matrix. If ZData is a matrix, then each columnrepresents the zcoordinates of a single face of the patch. In this case, XData, YData, and ZData must have thesame dimensions.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Faces — Vertex connection defining each facevector | matrix
Vertex connection defining each face, specified as a vector or a matrix defining the vertices in the Verticesproperty that are to be connected to form each face. The Faces and Vertices properties provide an alternative wayto specify a patch that can be more efficient than using XData, YData, and ZData coordinates in most cases.
Each row in the faces array designates the connections for a single face, and the number of elements in that rowthat are not NaN defines the number of vertices for that face. Therefore, an mbyn Faces array defines m faces withup to n vertices each.
For example, consider the following patch. It is composed of eight triangular faces defined by nine vertices. Thecorresponding Faces and Vertices properties are shown to the right of the patch. Note how some faces sharevertices with other faces. For example, the fifth vertex (V5) is used six times, once each by faces one, two, three, six,seven, and eight. Without sharing vertices, this same patch requires 24 vertex definitions.
•
•
•
•
collapse all
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Vertices — Vertex coordinatesvector | matrix
Vertex coordinates, specified as a vector or a matrix defining the (x,y,z) coordinates of each vertex. The Faces andVertices properties provide an alternative way to specify a patch that can be more efficient than using XData,YData, and ZData coordinates in most cases. See the Faces property for a description of how the vertex data isused.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Visibility
Visible — Visibility of patch'on' (default) | 'off'
Visibility of patch, specified as one of these values:
'on' — Display the patch.
'off' — Hide the patch without deleting it. You still can access the properties of an invisible patch object.
Clipping — Clipping of patch to axes limits'on' (default) | 'off'
Clipping of patch to the axes limits, specified as one of these values:
'on' — Do not display parts of the patch that are outside the axes limits.
'off' — Display the entire patch, even if parts of it appear outside the axes limits. Parts of the patch mightappear outside the axes limits if you create a plot, set hold on, freeze the axis scaling, and then create thepatch 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 minimalimpact. 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:
•
•
•
•
collapse all
'normal' — Redraw the affected region of the display, performing the threedimensional analysis necessary tocorrectly render all objects. This mode produces the most accurate picture, but is the slowest. The other modesare 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 withEraseMode,'none', it is still visible on the screen. However, you cannot print the object because MATLAB doesnot 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 beneathit. This mode does not damage the color of the objects beneath it. However, the object color depends on thecolor of whatever is beneath it on the display.
'background' — Erase the object by redrawing it in the axes background color, or the figure background colorif the axes Color property is 'none'. This damages objects that are behind the erased object, but properlycolors the erased object.
MATLAB always prints figures as if the EraseMode property of all objects is set to 'normal'. This means graphicsobjects 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 threedimensional sorting to obtaingreater rendering speed. However, MATLAB does not apply these techniques to the printed output. Use thegetframe command or other screen capture applications to create an image of a figure containing nonnormalmode objects.
Identifiers
Type — Type of graphics object'patch'
This property is read only.
Type of graphics object, returned as 'patch'. Use this property to find all objects of a given type within a plottinghierarchy, for example, searching for the type using findobj.
Tag — Userspecified tag'' (default) | string
Tag to associate with the patch, specified as a string. Tags provide a way to identify graphics objects. Use thisproperty to find all objects with a specific tag within a plotting hierarchy, for example, searching for the tag usingfindobj.
Example: 'January Data'
UserData — Data to associate with patch[] (default) | scalar, vector, or matrix | cell array | character array | table | structure
Data to associate with the patch object, specified as a scalar, vector, matrix, cell array, character array, table, orstructure. 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 setappdatafunctions.
Example: 1:100
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char |struct | table | cell
DisplayName — Text used by legend'' (default) | string
•
•
•
•
•
•
collapse all
Text used by the legend, specified as a string. The text appears next to an icon of the patch.
Example: 'Text Description'
For multiline text, create the string using sprintf with the new line character \n.
Example: sprintf('line one\nline two')
Alternatively, you can specify the legend text using the legend function.
If you specify the text as an input argument to the legend function, then the legend uses the specified text andsets the DisplayName property to the same value.
If you do not specify the text as an input argument to the legend function, then the legend uses the text in theDisplayName property. If the DisplayName property does not contain any text, then the legend generates astring. The string has the form 'dataN', where N is the number assigned to the patch object based on itslocation in the list of legend entries.
If you edit interactively the string in an existing legend, then MATLAB updates the DisplayName property to theedited string.
Annotation — Legend 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 patch from alegend.
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 patch object in the legend as one entry (default).
'off' — Do not include the patch object in the legend.
'children' — Include only children of the patch 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 thedisplay.
Parent/Child
Parent — Parent of patchaxes object | group object | transform object
Parent of patch, specified as an axes, group, or transform object.
Children — Children of patchempty GraphicsPlaceholder array
The patch has no children. You cannot set this property.
HandleVisibility — Visibility of object handle'on' (default) | 'off' | 'callback'
Visibility of patch object handle in the Children property of the parent, specified as one of these values:
'on' — The patch object handle is always visible.
•
•
•
•
•
•
•
collapse all
'off' — The patch object handle is invisible at all times. This option is useful for preventing unintendedchanges to the UI by another function. Set the HandleVisibility to 'off' to temporarily hide the handleduring the execution of that function.
'callback' — The patch object handle is visible from within callbacks or functions invoked by callbacks, butnot from within functions invoked from the command line. This option blocks access to the patch at thecommandline, but allows callback functions to access it.
If the patch object is not listed in the Children property of the parent, then functions that obtain object handles bysearching 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 handlesregardless of their HandleVisibility property setting.
Interactive Control
ButtonDownFcn — Mouseclick callback'' (default) | function handle | cell array | string
Mouseclick 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 (notrecommended)
Use this property to execute code when you click the patch. If you specify this property using a function handle, thenMATLAB passes two arguments to the callback function when executing the callback:
The patch object — You can access properties of the patch object from within the callback function.
Event data — This argument is empty for this property. Replace it with the tilde character (~) in the functiondefinition 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 callbackdoes not execute.
Example: @myCallback
Example: {@myCallback,arg3}
UIContextMenu — Context menuuicontextmenu object
Context menu, specified as a uicontextmenu object. Use this property to display a context menu when you rightclick the patch. 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 contextmenu does not appear.
Selected — Selection state'off' (default) | 'on'
Selection state, specified as one of these values:
•
•
•
•
•
•
•
•
•
˗
˗
collapse all
'on' — Selected. If you click the patch 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 aroundthe patch.
'off' — Not selected.
SelectionHighlight — Display 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
PickableParts — Ability 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 mustclick a part of the patch that has a defined color. You cannot click a part that has an associated color propertyset to 'none'. If the plot contains markers, then the entire marker is clickable if either the edge or the fill has adefined color. The HitTest property determines if the patch 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 patch that has no color. The HitTest property determines if the patch respondsto the click or if an ancestor does.
'none' — Cannot capture mouse clicks. Clicking the patch passes the click through it to the object below it inthe current view of the figure window. The HitTest property has no effect.
HitTest — Response 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 patch. If you have defined the UIContextMenu property, theninvoke the context menu.
'off' — Trigger the callbacks for the nearest ancestor of the patch that has a HitTest property set to 'on' anda PickableParts property value that enables the ancestor to capture mouse clicks.
Note: The PickableParts property determines if the patch object can capture mouse clicks. If it cannot, then theHitTest property has no effect.
Interruptible — Callback interruption'on' (default) | 'off'
Callback interruption, specified as 'on' or 'off'. The Interruptible property determines if a running callbackcan 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.
˗
˗
•
•
˗
˗
•
•
•
•
•
collapse all
Whenever MATLAB invokes a callback, that callback attempts to interrupt a running callback. TheInterruptible property of the object owning the running callback determines if interruption is allowed. Ifinterruption is not allowed, then the BusyAction property of the object owning the interrupting callbackdetermines if it is discarded or put in the queue.
If the ButtonDownFcn callback of the patch is the running callback, then the Interruptible property determines if itanother callback can interrupt it:
'on' — Interruptible. Interruption occurs at the next point where MATLAB processes the queue, such as whenthere 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 callbackat this point and executes the interrupting callback. MATLAB resumes executing the running callback whenthe 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 thecallback without interruption.
'off' — Not interruptible. MATLAB finishes executing the running callback without any interruptions.
BusyAction — Callback queuing'queue' (default) | 'cancel'
Callback queuing specified as 'queue' or 'cancel'. The BusyAction property determines how MATLAB handlesthe 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. TheInterruptible property of the object owning the running callback determines if interruption is allowed. Ifinterruption is not allowed, then the BusyAction property of the object owning the interrupting callbackdetermines if it is discarded or put in the queue.
If the ButtonDownFcn callback of the patch tries to interrupt a running callback that cannot be interrupted, then theBusyAction property determines if it is discarded or put in the queue. Specify the BusyAction property as one ofthese values:
'queue' — Put the interrupting callback in a queue to be processed after the running callback finishesexecution. This is the default behavior.
'cancel' — Discard the interrupting callback.
Creation and Deletion Control
CreateFcn — Creation 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 (notrecommended)
Use this property to execute code when you create the patch. Setting the CreateFcn property on an existing patchhas no effect. You must define a default value for this property, or define this property using a Name,Value pairduring patch creation. MATLAB executes the callback after creating the patch and setting all of its properties.
•
•
•
•
•
•
•
If you specify this callback using a function handle, then MATLAB passes two arguments to the callback functionwhen executing the callback:
The patch object — You can access properties of the patch object from within the callback function. You alsocan access the patch object through the CallbackObject property of the root, which can be queried using thegcbo function.
Event data — This argument is empty for this property. Replace it with the tilde character (~) in the functiondefinition 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}
DeleteFcn — Deletion 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 (notrecommended)
Use this property to execute code when you delete the patch. MATLAB executes the callback before destroying thepatch 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 functionwhen executing the callback:
The patch object — You can access properties of the patch object from within the callback function. You alsocan access the patch object through the CallbackObject property of the root, which can be queried using thegcbo function.
Event data — This argument is empty for this property. Replace it with the tilde character (~) in the functiondefinition 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}
BeingDeleted — Deletion status of patch'off' (default) | 'on'
This property is read only.
Deletion status of patch, returned as 'on' or 'off'. MATLAB sets the BeingDeleted property to 'on' when thedelete function of the patch begins execution (see the DeleteFcn property). The BeingDeleted property remainsset to 'on' until the patch no longer exists.
Check the value of the BeingDeleted property to verify that the patch is not about to be deleted before querying ormodifying it.
See Alsopatch
•
•
More AboutAccess Property Values
Graphics Object Properties
