Control chart surface appearance and behavior
Chart surface properties control the appearance and behavior of chart surface objects. By changing property values, you can modify certain aspects of the surface.
Starting in R2014b, you can use dot notation to query and set properties.
h = surf(...); c = h.CData; h.CDataMapping = 'direct';
If you are using an earlier release, use the get
and set
functions
instead.
FaceColor
— Face color'flat'
(default) | 'interp'
| 'none'
| 'texturemap'
| RGB triplet | character vector of color nameFace 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 character vector of a color name — 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 the
long and short color name options and the equivalent RGB triplet values.
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 transparency[0,1]
| 'flat'
| 'interp'
| 'texturemap'
Face transparency, specified as one of these values:
Scalar in range [0,1]
—
Use uniform transparency across all of the faces. A value of 1
is
fully opaque and 0
is completely transparent. Values
between 0
and 1
are semitransparent.
This option does not use the transparency values in the AlphaData
property.
'flat'
— Use a different
transparency for each face based on the values in the AlphaData
property.
First you must specify the AlphaData
property
as a matrix the same size as the ZData
property.
The transparency value at the first vertex determines the transparency
for the entire face. The FaceColor
property also
must be set to 'flat'
.
'interp'
— Use interpolated
transparency for each face based on the values in AlphaData
property.
First you must specify the AlphaData
property
as a matrix the same size as the ZData
property.
The transparency varies across each face by interpolating the values
at the vertices. The FaceColor
property also
must be set to 'interp'
.
'texturemap'
— Transform
the data in AlphaData
so that it conforms to
the surface.
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 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 |
BackFaceLighting
— Face lighting when normals point away from camera'reverselit'
(default) | 'unlit'
| 'lit'
Face lighting when the vertex normals point away from camera, specified as one of these values:
'reverselit'
— 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.
MeshStyle
— Edges to display'both'
(default) | 'row'
| 'column'
Edges to display, specified as 'both'
, 'row'
,
or 'column'
.
LineStyle
— Line style'-'
(default) | '--'
| ':'
| '-.'
| 'none'
Line style, specified as one of the line styles listed in this table.
Line Style | Description | Resulting Line |
---|---|---|
'-' | Solid line |
|
'--' | Dashed line |
|
':' | Dotted line |
|
'-.' | Dash-dotted line |
|
'none' | No line | No line |
LineWidth
— Line width0.5
(default) | positive valueLine width, specified as a positive value in points. If the line has markers, then the line width also affects the marker edges.
Example: 0.75
EdgeColor
— Edge line color[0 0 0]
(default) | 'none'
| 'flat'
| 'interp'
| RGB triplet | character vector of color nameEdge 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 character vector of a color name — 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 the
long and short color name options and the equivalent RGB triplet values.
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] |
EdgeAlpha
— Edge transparency[0,1]
| 'flat'
| 'interp'
Edge transparency, specified as one of these values:
Scalar in range [0,1]
—
Use uniform transparency across all of the edges. A value of 1
is
fully opaque and 0
is completely transparent. Values
between 0
and 1
are semitransparent.
This option does not use the transparency values in the AlphaData
property.
'flat'
— Use a different
transparency for each edge based on the values in the AlphaData
property.
First you must specify the AlphaData
property
as a matrix the same size as the ZData
property.
The transparency value at the first vertex determines the transparency
for the entire edge. The EdgeColor
property also
must be set to 'flat'
.
'interp'
— Use interpolated
transparency for each edge based on the values in AlphaData
property.
First you must specify the AlphaData
property
as a matrix the same size as the ZData
property.
The transparency varies across each edge by interpolating the values
at the vertices. The EdgeColor
property also
must be set to 'interp'
.
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 |
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
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 |
Marker
— Marker symbol'none'
(default) | 'o'
| '+'
| '*'
| '.'
| '*'
| ...
Marker symbol, specified as one of the values listed in this table. By default, the chart surface object does not display markers. Specifying a marker symbol adds markers at each data point or vertex.
Value | Description |
---|---|
'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'
MarkerSize
— Marker size6
(default) | positive valueMarker size, specified as a positive value in points.
Example: 10
MarkerEdgeColor
— Marker outline color'auto'
(default) | 'none'
| 'flat'
| RGB triplet | character vector of color nameMarker 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 character vector of a color name — 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 the
long and short color name options and the equivalent RGB triplet values.
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 | character vector of color nameMarker 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 character vector of a color name — 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 the
long and short color name options and the equivalent RGB triplet values.
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] |
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:
FaceNormals
— Normal vectors for each surface face[]
(default) | (m-1)-by-(n-1)-by-3 arrayNormal 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
FaceNormalsMode
— Selection 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.
VertexNormals
— Normal vectors for each surface vertex[]
(default) | m-by-n-by-3 arrayNormal 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
VertexNormalsMode
— Selection 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.
NormalMode
— (removed) Selection mode for VertexNormals
'auto'
(default) | 'manual'
The NormalMode
property will be removed in
a future release. Use VertexNormalsMode
instead.
CData
— Vertex colorsVertex 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 [-128 -128 -128]
corresponds
to black and [127 127 127]
corresponds to white.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
CDataMode
— Selection 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.
CDataSource
— Variable linked to CData
''
| character vector containing MATLAB® workspace variable nameVariable linked to CData
, specified as a
character vector containing a MATLAB workspace variable name. MATLAB evaluates
the variable in the base workspace to generate the CData
.
By default, there is no linked variable, so the value is an
empty character vector, ''
. If you link a variable,
then MATLAB does not update the CData
values
immediately. To force an update of the values, use the refreshdata
function.
Note: If you change one data source property to a variable that contains data of a different dimension, then you might cause the function to generate a warning and not render the graph until you have changed all data source properties to appropriate values. |
CDataMapping
— Color mapping method'scaled'
(default) | 'direct'
Color mapping method, specified as 'scaled'
or 'direct'
.
Use this property to control the mapping of color data values in CData
into
the colormap.
The methods have these effects:
'direct'
— Interpret the
values as indices into the current colormap. Values with a decimal
portion are fixed to the nearest lower integer.
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
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
(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
map to the second color
in the colormap.
'scaled'
— Scale the values
to range between the minimum and maximum color limits. The CLim
property
of the axes contains the color limits.
AlphaData
— Transparency dataZData
Transparency data for each vertex, specified as an array the
same size as the ZData
property. After specifying
the values, set the FaceAlpha
and EdegAlpha
properties
to control the type of transparency. If the FaceAlpha
and EdgeAlpha
properties
are both set to scalar values, then the chart surface does
not use the AlphaData
values.
The AlphaDataMapping
property determines
how the chart surface interprets the AlphaData
property
values.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| logical
AlphaDataMapping
— Interpretation of AlphaData
values'scaled'
(default) | 'direct'
| 'none'
Interpretation of AlphaData
values, specified
as one of these values:
'none'
— Interpret the
values as transparency values. A value of 1 or greater is completely
opaque, a value of 0 or less is completely transparent, and a value
between 0 and 1 is semitransparent.
'scaled'
— Map the values
into the figure's alphamap. The minimum and maximum alpha limits
of the axes determine the AlphaData
values that
map to the first and last elements in the alphamap, respectively.
For example, if the alpha limits are [3 5]
, then
values of 3
or less map to the first element in
the alphamap. Values of 5
or greater map to the
last element in the alphamap. The ALim
property of the axes
contains the alpha limits. The Alphamap
property of
the figure contains the alphamap.
'direct'
— Interpret the
values as indices into the figure's alphamap. Values with a
decimal portion are fixed to the nearest lower integer.
If the values are of type double
or single
,
then values of 1 or less map to the first element in the alphamap.
Values equal to or greater than the length of the alphamap map to
the last element in the alphamap.
If the values are of integer type, then values of
0 or less map to the first element in the alphamap. Values equal to
or greater than the length of the alphamap map to the last element
in the alphamap (or up to the range limits of the type). The integer
types are uint8
, uint16
, uint32
, uint64
, int8
, int16
, int32
,
and int64
.
If the values are of type logical
,
then values of 0 map to the first element in the alphamap and values
of 1 map to the second element in the alphamap.
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 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
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 reflectance
from light objects in the axes.
Example: 0.3
Data Types: double
SpecularColorReflectance
— Color of specular reflections[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
SpecularExponent
— Size of specular spotSize 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
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
bright spots on the surface from light objects in the axes.
Example: 0.3
Data Types: double
XData
— x-coordinate datax-coordinate data specified as a matrix that
is the same size as ZData
or as a vector of length n
,
where [m,n] = size(ZData)
.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| datetime
| duration
YData
— y-coordinate datay-coordinate data, specified as a matrix
that is the same size as ZData
or a vector of
length m
, where [m,n] = size(ZData)
.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| datetime
| duration
ZData
— z-coordinate dataz-coordinate data, specified as a matrix.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| datetime
| duration
XDataSource
— Variable linked to XData
''
(default) | character vector containing MATLAB workspace variable nameVariable linked to XData
, specified as a
character vector containing a MATLAB workspace variable name. MATLAB evaluates
the variable in the base workspace to generate the XData
.
By default, there is no linked variable so the value is an empty
character vector, ''
. If you link a variable, then MATLAB does
not update the XData
values immediately. To force
an update of the data values, use the refreshdata
function.
Note: If you change one data source property to a variable that contains data of a different dimension, you might cause the function to generate a warning and not render the graph until you have changed all data source properties to appropriate values. |
Example: 'x'
YDataSource
— Variable linked to YData
''
(default) | character vector containing MATLAB workspace variable nameVariable linked to YData
, specified as a
character vector containing a MATLAB workspace variable name. MATLAB evaluates
the variable in the base workspace to generate the YData
.
By default, there is no linked variable so the value is an empty
character vector, ''
. If you link a variable, then MATLAB does
not update the YData
values immediately. To force
an update of the data values, use the refreshdata
function.
Note: If you change one data source property to a variable that contains data of a different dimension, you might cause the function to generate a warning and not render the graph until you have changed all data source properties to appropriate values. |
Example: 'y'
ZDataSource
— Variable linked to ZData
''
(default) | character vector containing MATLAB workspace variable nameVariable linked to ZData
, specified as a
character vector containing a MATLAB workspace variable name. MATLAB evaluates
the variable in the base workspace to generate the ZData
.
By default, there is no linked variable so the value is an empty
character vector, ''
. If you link a variable, then MATLAB does
not update the ZData
values immediately. To force
an update of the data values, use the refreshdata
function.
Note: If you change one data source property to a variable that contains data of a different dimension, you might cause the function to generate a warning and not render the graph until you have changed all data source properties to appropriate values. |
Example: 'z'
XDataMode
— Selection 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 values. To specify the values, use an input argument to
the plotting function or directly set the XData
property.
YDataMode
— Selection 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 values. To specify the values, use an input argument to
the plotting function or directly set the YData
property.
Visible
— State of visibility'on'
(default) | 'off'
State of visibility, specified as one of these values:
'on'
— Display the chart surface.
'off'
— Hide the chart surface without deleting it. You still can access the properties
of an invisible chart surface object.
Clipping
— Clipping of chart surface object to axes limits'on'
(default) | 'off'
Clipping of the chart surface object to the axes limits, specified as one of these values:
'on'
— Do not display parts
of the chart surface object that are outside the axes limits.
'off'
— Display the entire chart surface object, even if parts of it appear outside the axes
limits. Parts of the chart surface object might appear
outside the axes limits if you create a plot, set hold on
,
freeze the axis scaling, and then create the chart surface object
so that it is larger than the original plot.
The Clipping
property of the axes that contains
the chart surface object must be set to 'on'
,
otherwise this property has no effect. For more information about
the clipping behavior, see the Clipping
property of the
axes.
EraseMode
— (removed) Technique to draw and erase objects'normal'
(default) | 'none'
| 'xor'
| 'background'
Note:
|
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.
Type
— Type of graphics object'surface'
This property is read only.
Type of graphics object, returned as 'surface'
.
Tag
— User-specified tag''
(default) | character vectorUser-specified tag to associate with the chart surface,
specified as a character vector. 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'
UserData
— Data to associate with chart surface[]
(default) | any MATLAB dataData to associate with the chart surface object, specified as any MATLAB data, for example, a scalar, vector, matrix, cell array, character array, table, or structure. MATLAB does not use this data.
To associate multiple sets of data or to attach a field name
to the data, use the getappdata
and setappdata
functions.
Example: 1:100
DisplayName
— Text used for legend label''
(default) | character vectorText used for the legend label, specified as a character vector.
If you do not specify the text, then the legend uses a label of the
form 'dataN'
. The legend does not display until
you call the legend
command.
Example: 'Label Text'
Annotation
— Control for including or excluding chart surface from legendAnnotation
objectThis property is read only.
Control for including or excluding the chart surface from
a legend, returned as an Annotation
object. Set
the underlying IconDisplayStyle
property to one
of these values:
'on'
— Include the chart surface in the legend (default).
'off'
— Do not include the chart surface in the legend.
For example, exclude a stem chart from the legend.
p = plot(1:10,'DisplayName','Line Chart'); hold on s = stem(1:10,'DisplayName','Stem Chart'); hold off s.Annotation.LegendInformation.IconDisplayStyle = 'off'; legend('show')
Alternatively, you can control the items in a legend using the legend
function. Specify the first input
argument as a vector of the graphics objects to include.
p = plot(1:10,'DisplayName','Line Chart'); hold on s = stem(1:10,'DisplayName','Stem Chart'); hold off legend(p)
Parent
— Parent of chart surfaceParent of chart surface, specified as an axes, group, or transform object.
Children
— Children of chart surfaceGraphicsPlaceholder
arrayThe chart surface has no children. You cannot set this property.
HandleVisibility
— Visibility of object handle'on'
(default) | 'off'
| 'callback'
Visibility of chart surface object handle in the Children
property
of the parent, specified as one of these values:
'on'
— The chart surface object handle is always visible.
'off'
— The chart surface object handle is invisible at all times. This option
is useful for preventing unintended changes to the UI by another function.
Set the HandleVisibility
to 'off'
to
temporarily hide the handle during the execution of that function.
'callback'
— The chart surface object handle is visible from within callbacks or functions
invoked by callbacks, but not from within functions invoked from the
command line. This option blocks access to the chart surface at
the command-line, but allows callback functions to access it.
If the chart 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.
ButtonDownFcn
— Mouse-click callback''
(default) | function handle | cell array | character vectorMouse-click callback, specified as one of these values:
Function handle
Cell array containing a function handle and additional arguments
Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)
Use this property to execute code when you click the chart surface. If you specify this property using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:
The chart surface object — You can access properties of the chart 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 |
Example: @myCallback
Example: {@myCallback,arg3}
UIContextMenu
— Context menuContext menu, specified as a uicontextmenu object. Use this
property to display a context menu when you right-click the chart surface. Create the context menu using the uicontextmenu
function.
Note:
If the |
Selected
— Selection state'off'
(default) | 'on'
Selection state, specified as one of these values:
'on'
— Selected. If you
click the chart 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 chart surface.
'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'
.
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 must click a part of
the chart 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 chart 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 chart surface that has no color.
The HitTest
property determines if the chart surface responds to the click or if an ancestor does.
'none'
— Cannot capture
mouse clicks. Clicking the chart 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.
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 chart surface. If you have defined the UIContextMenu
property,
then invoke the context menu.
'off'
— Trigger the callbacks
for the nearest ancestor of the chart surface that has
a HitTest
property set to 'on'
and
a PickableParts
property value that enables the
ancestor to capture mouse clicks.
Note:
The |
Interruptible
— Callback 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:
Whenever MATLAB invokes a callback, that callback
attempts to interrupt a running callback. The |
If the ButtonDownFcn
callback of the chart 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.
BusyAction
— Callback 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:
Whenever MATLAB invokes a callback, that callback attempts
to interrupt a running callback. The |
If the ButtonDownFcn
callback of the chart 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.
CreateFcn
— Creation callback''
(default) | function handle | cell array | character vectorCreation callback, specified as one of these values:
Function handle
Cell array containing a function handle and additional arguments
Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)
Use this property to execute code when you create the chart surface. Setting the CreateFcn
property
on an existing chart surface has no effect. You must define
a default value for this property, or define this property using a Name,Value
pair
during chart surface creation. MATLAB executes the
callback after creating the chart 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 chart surface object — You can
access properties of the chart surface object from within
the callback function. You also can access the chart 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}
DeleteFcn
— Deletion callback''
(default) | function handle | cell array | character vectorDeletion callback, specified as one of these values:
Function handle
Cell array containing a function handle and additional arguments
Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)
Use this property to execute code when you delete the chart surface. MATLAB executes the callback before destroying the chart 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 chart surface object — You can
access properties of the chart surface object from within
the callback function. You also can access the chart 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}
BeingDeleted
— Deletion status of chart surface'off'
(default) | 'on'
This property is read only.
Deletion status of chart surface, returned as 'off'
or 'on'
. MATLAB sets
the BeingDeleted
property to 'on'
when
the delete function of the chart surface begins execution
(see the DeleteFcn
property). The BeingDeleted
property
remains set to 'on'
until the chart surface no
longer exists.
Check the value of the BeingDeleted
property
to verify that the chart surface is not about to be deleted
before querying or modifying it.