Main Content

Scatter Properties

Scatter chart appearance and behavior

Scatter properties control the appearance and behavior of Scatter object. By changing property values, you can modify certain aspects of the scatter chart. Use dot notation to query and set properties.

s = scatter(1:10,1:10);
m = s.Marker;
s.Marker = '*';

Markers

expand all

Marker symbol, specified as one of the options listed in this table:

MarkerDescriptionResulting Marker
'o'Circle

Sample of circle marker

'+'Plus sign

Sample of plus sign marker

'*'Asterisk

Sample of asterisk marker

'.'Point

Sample of point marker

'x'Cross

Sample of cross marker

'_'Horizontal line

Sample of horizontal line marker

'|'Vertical line

Sample of vertical line marker

's'Square

Sample of square marker

'd'Diamond

Sample of diamond line marker

'^'Upward-pointing triangle

Sample of upward-pointing triangle marker

'v'Downward-pointing triangle

Sample of downward-pointing triangle marker

'>'Right-pointing triangle

Sample of right-pointing triangle marker

'<'Left-pointing triangle

Sample of left-pointing triangle marker

'p'Pentagram

Sample of pentagram marker

'h'Hexagram

Sample of hexagram marker

'none'No markersNot applicable

Width of marker edge, specified as a positive value in point units.

Example: 0.75

Marker outline color, specified 'flat', an RGB triplet, a hexadecimal color code, a color name, or a short name. The default value of 'flat' uses colors from the CData property.

For a custom color, specify an RGB triplet or a hexadecimal color code.

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

  • A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Thus, the color codes '#FF8800', '#ff8800', '#F80', and '#f80' are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
'red''r'[1 0 0]'#FF0000'

Sample of the color red

'green''g'[0 1 0]'#00FF00'

Sample of the color green

'blue''b'[0 0 1]'#0000FF'

Sample of the color blue

'cyan' 'c'[0 1 1]'#00FFFF'

Sample of the color cyan

'magenta''m'[1 0 1]'#FF00FF'

Sample of the color magenta

'yellow''y'[1 1 0]'#FFFF00'

Sample of the color yellow

'black''k'[0 0 0]'#000000'

Sample of the color black

'white''w'[1 1 1]'#FFFFFF'

Sample of the color white

'none'Not applicableNot applicableNot applicableNo color

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB® uses in many types of plots.

RGB TripletHexadecimal Color CodeAppearance
[0 0.4470 0.7410]'#0072BD'

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]'#D95319'

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]'#EDB120'

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]'#7E2F8E'

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]'#77AC30'

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]'#4DBEEE'

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]'#A2142F'

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

Example: [0.5 0.5 0.5]

Example: 'blue'

Example: '#D2F9A7'

Marker fill color, specified as 'flat', 'auto', an RGB triplet, a hexadecimal color code, a color name, or a short name. The 'flat' option uses the CData values. The 'auto' option uses the same color as the Color property for the axes.

For a custom color, specify an RGB triplet or a hexadecimal color code.

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

  • A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Thus, the color codes '#FF8800', '#ff8800', '#F80', and '#f80' are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
'red''r'[1 0 0]'#FF0000'

Sample of the color red

'green''g'[0 1 0]'#00FF00'

Sample of the color green

'blue''b'[0 0 1]'#0000FF'

Sample of the color blue

'cyan' 'c'[0 1 1]'#00FFFF'

Sample of the color cyan

'magenta''m'[1 0 1]'#FF00FF'

Sample of the color magenta

'yellow''y'[1 1 0]'#FFFF00'

Sample of the color yellow

'black''k'[0 0 0]'#000000'

Sample of the color black

'white''w'[1 1 1]'#FFFFFF'

Sample of the color white

'none'Not applicableNot applicableNot applicableNo color

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

RGB TripletHexadecimal Color CodeAppearance
[0 0.4470 0.7410]'#0072BD'

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]'#D95319'

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]'#EDB120'

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]'#7E2F8E'

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]'#77AC30'

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]'#4DBEEE'

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]'#A2142F'

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

Example: [0.3 0.2 0.1]

Example: 'green'

Example: '#D2F9A7'

Marker edge transparency, specified as a scalar in the range [0,1] or 'flat'. A value of 1 is opaque and 0 is completely transparent. Values between 0 and 1 are semitransparent.

To set the edge transparency to a different value for each point in the plot, set the AlphaData property to a vector the same size as the XData property, and set the MarkerEdgeAlpha property to 'flat'.

Marker face transparency, specified as a scalar in the range [0,1] or 'flat'. A value of 1 is opaque and 0 is completely transparent. Values between 0 and 1 are semitransparent.

To set the marker face transparency to a different value for each point in the plot, set the AlphaData property to a vector the same size as the XData property, and set the MarkerFaceAlpha property to 'flat'.

Transparency data for each plotted point, specified as an array the same size as the XData property. After specifying the values, set the MarkerFaceAlpha and MarkerEdgeAlpha properties to control the type of transparency. If the MarkerFaceAlpha and MarkerEdgeAlpha properties are both set to scalar values, then the Scatter object does not use the AlphaData values.

The AlphaDataMapping property determines how the Scatter object interprets the AlphaData property values.

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

Control how the AlphaData property is set, returned as one of these values:

  • 'auto' — MATLAB controls the value of the AlphaData property. The value can be:

    • The default value of the AlphaData property.

    • The values in a table variable. The SourceTable property specifies the table, and the AlphaVariable property specifies the variable. If either the SourceTable or AlphaVariable properties are empty, the default AlphaData value is used.

  • 'manual' — The AlphaData property is set directly and does not update automatically.

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 maximum value for the integer 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.

Color and Size Data

expand all

Marker colors, specified as one of these values:

  • RGB triplet — Use the same color for all the markers in the plot. 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.5 0.6 0.7].

  • Three-column matrix of RGB triplets — Use a different color for each marker in the plot. Each row of the matrix defines one color. The number of rows must equal the number of markers.

  • Vector — Use a different color for each marker in the plot. Specify CData as a vector the same length as XData. Linearly map the values in the vector to the colors in the current colormap.

Example: [1 0 0; 0 1 0; 0 0 1]

Control how the CData property is set, specified as one of these values:

  • 'auto' — MATLAB controls the value of the CData property. The value can be:

    • One of the colors from the ColorOrder property of the axes. This is the default behavior.

    • The values in a table variable. The SourceTable property specifies the table, and the ColorVariable property specifies the variable. If either of these properties are empty, then the color data comes from the ColorOrder property of the axes.

  • 'manual' — You control the value of the CData property manually, either by specifying a color when you call a plotting function or by setting the CData property on the Scatter object after plotting.

Variable linked to CData, specified as a character vector or string containing a MATLAB workspace variable. 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 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.

Series index, specified as a whole number greater than or equal to 0. This property is useful for reassigning the marker colors of several Scatter objects so that they match each other. By default, the SeriesIndex property of a Scatter object is a number that corresponds to the object's order of creation, starting at 1.

MATLAB uses the number to calculate indices for assigning colors when you call plotting functions. The indices refer to the rows of the arrays stored in the ColorOrder property of the axes.

MATLAB automatically updates the maker color of the Scatter object when you change its SeriesIndex, or when you change ColorOrder property on the axes. However, the following conditions must be true for the changes to have any effect:

  • The CDataMode property on the Scatter object is set to 'auto'.

  • Either the MarkerEdgeColor or MarkerFaceColor property on the Scatter object is set to 'flat'.

  • The SeriesIndex property on the Scatter object is greater than 0.

  • The NextSeriesIndex property on the axes object is greater than 0.

Marker sizes, specified in one of these forms:

  • Scalar — Use the same size for all of the markers.

  • Vector — Use a different size for each marker. Specify SizeData as a vector the same length as XData.

Specify the values in point units, where one point equals 1/72 inch. To specify a marker that has an area of one square inch, use a value of 72^2.

Example: 50

Control how the SizeData property is set, returned as one of these values:

  • 'auto' — MATLAB controls the value of the SizeData property. The value can be:

    • The default value of the SizeData property.

    • The values in a table variable. The SourceTable property specifies the table, and the SizeVariable property specifies the variable. If either the SourceTable or SizeVariable properties are empty, the default SizeData value is used.

  • 'manual' — You set the SizeData property directly; it does not change.

Variable linked to SizeData, specified as a character vector or string containing a MATLAB workspace variable. MATLAB evaluates the variable in the base workspace to generate the SizeData.

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

Cartesian Coordinate Data

expand all

x values, specified as a scalar or a vector. The scatter plot displays an individual marker for each value in XData.

The input argument x to the plotting function sets the x values. XData and YData must have equal lengths.

Example: [1 2 4 2 6]

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

Control how the XData property is set, returned as one of these values:

  • 'auto' — The XData property updates automatically based on the SourceTable and XVariable properties. This is the case when you pass a table to any of the Cartesian scatter plotting functions (such as scatter or scatter3).

  • 'manual' — The XData property is set directly and does not update automatically. This is the case when you pass coordinate values as vectors or matrices to any of the Cartesian scatter plotting functions.

Variable linked to XData, specified as a character vector or string 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'

y values, specified as a scalar or a vector. The scatter plot displays an individual marker for each value in YData.

The input argument y to the plotting function sets the y values. XData and YData must have equal lengths.

Example: [1 3 3 4 6]

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

Control how the YData property is set, returned as one of these values:

  • 'auto' — The YData property updates automatically based on the SourceTable and YVariable properties. This is the case when you pass a table to any of the Cartesian scatter plotting functions (such as scatter or scatter3).

  • 'manual' — The YData property is set directly and does not update automatically. This is the case when you pass coordinate values as vectors or matrices to any of the Cartesian scatter plotting functions.

Variable linked to YData, specified as a character vector or string 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'

z values, specified as a scalar or a vector.

  • For 2-D scatter plots, ZData is empty by default.

  • For 3-D scatter plots, the input argument z to the plotting function sets the z values. XData, YData, and ZData must have equal lengths.

Example: [1 2 2 1 0]

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

Control how the ZData property is set, returned as one of these values:

  • 'auto' — The ZData property updates automatically based on the SourceTable and ZVariable properties. This is the case when you pass a table to any of the Cartesian scatter plotting functions (such as scatter or scatter3).

  • 'manual' — The ZData property is set directly and does not update automatically. This is the case when you pass coordinate values as vectors or matrices to any of the Cartesian scatter plotting functions.

Variable linked to ZData, specified as a character vector or string 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'

Type of jitter (spacing of points) along the x-dimension, specified as one of the following values:

  • 'none' — Do not jitter the points.

  • 'density' — Jitter the points using the kernel density estimate of y for 2-D charts. If you specify this option in two dimensions for a 3-D chart, the points are jittered based on the kernel density estimate in the third dimension. For example, setting XJitter and YJitter to 'density' uses the kernel density estimate of z.

  • 'rand' — Jitter the points randomly with a uniform distribution.

  • 'randn' — Jitter points randomly with a normal distribution.

Maximum amount of jitter (offset between points) along the x-dimension, specified as a nonnegative scalar value in data units.

For example, to set the jitter width to 90% of the shortest distance between adjacent points, take the minimum distance between unique values of x and scale by 0.9.

XJitterWidth = 0.9 * min(diff(unique(x)));

Type of jitter (spacing of points) along the y-dimension, specified as one of the following values:

  • 'none' — Do not jitter the points.

  • 'density' — Jitter the points using the kernel density estimate of x for 2-D charts. If you specify this option in two dimensions for a 3-D chart, the points are jittered based on the kernel density estimate in the third dimension. For example, setting XJitter and YJitter to 'density' uses the kernel density estimate of z.

  • 'rand' — Jitter the points randomly with a uniform distribution.

  • 'randn' — Jitter points randomly with a normal distribution.

Maximum amount of jitter (offset between points) along the y-dimension, specified as a nonnegative scalar value in data units.

For example, to set the jitter width to 90% of the shortest distance between adjacent points, take the minimum distance between unique values of y and scale by 0.9.

YJitterWidth = 0.9 * min(diff(unique(y)));

Type of jitter (spacing of points) along the z-dimension, specified as one of the following values:

  • 'none' — Do not jitter the points.

  • 'density' —Jitter the points using the kernel density estimate of y. Or, if you specify this option in one additional dimension, the points are jittered based on the kernel density estimate in the third dimension. For example, setting YJitter and ZJitter to 'density' uses the kernel density estimate of x.

  • 'rand' — Jitter the points randomly with a uniform distribution.

  • 'randn' — Jitter points randomly with a normal distribution.

Maximum amount of jitter (offset between points) along the z-dimension in data units, specified as a nonnegative scalar value.

For example, to set the jitter width to 90% of the shortest distance between adjacent points, take the minimum distance between unique values of z and scale by 0.9.

ZJitterWidth = 0.9 * min(diff(unique(z)));

Polar Coordinate Data

expand all

Radius values, specified as a vector. ThetaData and RData must be vectors of equal length.

This property applies only to polar axes.

Control how the RData property is set, returned as one of these values:

  • 'auto' — The RData property updates automatically based on the SourceTable and RVariable properties. This is the case when you pass a table to the polarscatter or scatter functions.

  • 'manual' — The RData property is set directly and does not update automatically. This is the case when you pass coordinate values as vectors or matrices to the polarscatter or scatter functions.

Variable linked to RData, specified as a character vector or string containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate the RData.

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

This property applies only to polar axes.

Angle values, specified as a vector. ThetaData and RData must be vectors of equal length.

This property applies only to polar axes.

Control how the ThetaData property is set, returned as one of these values:

  • 'auto' — The ThetaData property updates automatically based on the SourceTable and ThetaVariable properties. This is the case when you pass a table to the polarscatter or scatter functions.

  • 'manual' — The ThetaData property is set directly and does not update automatically. This is the case when you pass coordinate values as vectors or matrices to the polarscatter or scatter functions.

Variable linked to ThetaData, specified as a character vector or string containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate the RData.

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

This property applies only to polar axes.

Geographic Coordinate Data

expand all

Latitude values, specified as a vector. LatitudeData and LongitudeData must be vectors of equal length.

This property applies only to geographic axes.

Variable linked to LatitudeData, specified as a character vector or string containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate the RData.

By default, there is no linked variable so the value is an empty character vector, ''. If you link a variable, MATLAB does not update the LatitudeData 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.

This property applies only to geographic axes.

Longitude values, specified as a vector. LongitudeData and LatitudeData must be vectors of equal length.

This property applies only to geographic axes.

Variable linked to LongitudeData, specified as a character vector or string containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate the RData.

By default, there is no linked variable so the value is an empty character vector, ''. If you link a variable, MATLAB does not update the LatitudeData 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.

This property applies only to geographic axes.

Table Data (Since R2021b)

expand all

Source table containing the data to plot. Specify this property as a table or a timetable.

Table variable containing the x-coordinates, specified as a table variable index. The table variable you specify can contain numeric, categorical, datetime, or duration values. When you set this property, MATLAB updates the XData property.

This table lists the different indexing schemes you can use to specify the table variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Table variable containing the y-coordinates, specified as a table variable index. The table variable you specify can contain numeric, categorical, datetime, or duration values. When you set this property, MATLAB updates the YData property.

This table lists the different indexing schemes you can use to specify the table variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Table variable containing the z-coordinates, specified as a table variable index. The table variable you specify can contain numeric, categorical, datetime, or duration values. When you set this property, MATLAB updates the ZData property.

This table lists the different indexing schemes you can use to specify the table variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Table variable containing the radius values for polar scatter plots, specified as a table variable index. The table variable you specify can contain any type of numeric values. When you set this property, MATLAB updates the RData property. This property applies only to polar axes.

Here is a list of the different indexing schemes you can use to specify the table variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Table variable containing the angle values for polar scatter plots, specified as a table variable index. The table variable you specify can contain any type of numeric values. When you set this property, MATLAB updates the ThetaData property. This property applies only to polar axes.

Here is a list of the different indexing schemes you can use to specify the table variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Table variable containing the latitude values for geographic scatter plots, specified as a table variable index. The table variable you specify can contain any type of numeric values. When you set this property, MATLAB updates the LatitudeData property. This property applies only to geographic axes.

Here is a list of the different indexing schemes you can use to specify the table variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Table variable containing the longitude values for geographic scatter plots, specified as a table variable index. The table variable you specify can contain any type of numeric values. When you set this property, MATLAB updates the LongitudeData property. This property applies only to geographic axes.

Here is a list of the different indexing schemes you can use to specify the table variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Table variable containing marker size data, specified as a variable index into the source table.

Specifying the Table Index

Use any of the following indexing schemes to specify the desired variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Specifying Size Data

The variable you specify can contain any numeric type. When you set the SizeVariable property, MATLAB updates the SizeData property.

Table variable containing the color data, specified as a variable index into the source table.

Specifying the Table Index

Use any of the following indexing schemes to specify the desired variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Specifying Color Data

Specifying the ColorVariable property controls the colors of the markers. The data in the variable controls the marker fill color when the MarkerFaceColor property is set to 'flat'. The data can also control the marker outline color, when the MarkerEdgeColor is set to 'flat'.

The table variable you specify can contain values of any numeric type. The values can be in either of the following forms:

  • A column of numbers that linearly map into the current colormap.

  • A three-column array of RGB triplets. RGB triplets are three-element vectors whose values specify the intensities of the red, green, and blue components of specific colors. The intensities must be in the range [0,1]. For example, [0.5 0.7 1] specifies a shade of light blue.

When you set the ColorVariable property, MATLAB updates the CData property.

Table variable containing transparency data, specified as a variable index into the source table.

Specifying the Table Index

Use any of the following indexing schemes to specify the desired variable.

Indexing SchemeExamples

Variable name:

A character vector or a string scalar.

  • 'A' or "A" — A variable called A

Variable number:

An index number that refers to the location of a variable in the table.

  • 3 — The third variable from the table

Logical vector:

  • An n-element vector logical vector, where logical 1 (true) values indicate the desired variable.

  • Optionally, omit the trailing false values after the true value.

  • [false false true false] — The third variable from an m-by-4 table

  • [false false true] — The third variable from any size table

Variable type:

A vartype command that selects table variables of a specified type.

  • vartype('double') — The variable containing double values

Specifying Transparency Data

The data in the variable you specify controls the transparency of the markers. Smaller values are more transparent, and larger values are more opaque. The values can be any numeric type.

After setting the AlphaVariable property, set the MarkerFaceAlpha and MarkerEdgeAlpha properties to control the type of transparency. If the MarkerFaceAlpha and MarkerEdgeAlpha properties are both set to scalar values, then the scatter object does not use the data from the table.

When you set this property, MATLAB updates the AlphaData property.

Legend

expand all

Legend label, specified as a character vector or string scalar. The legend does not display until you call the legend command. If you do not specify the text, then legend sets the label using the form 'dataN'.

This property is read-only.

Control for including or excluding the object from a legend, returned as an Annotation object. Set the underlying IconDisplayStyle property to one of these values:

  • 'on' — Include the object in the legend (default).

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

For example, to exclude a graphics object, go, from the legend set the IconDisplayStyle property to 'off'.

go.Annotation.LegendInformation.IconDisplayStyle = 'off';

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. If you do not specify an existing graphics object in the first input argument, then it does not appear in the legend. However, graphics objects added to the axes after the legend is created do appear in the legend. Consider creating the legend after creating all the plots to avoid extra items.

Interactivity

expand all

State of visibility, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

  • 'on' — Display the object.

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

Data tip content, specified as a DataTipTemplate object. You can control the content that appears in a data tip by modifying the properties of the underlying DataTipTemplate object. For a list of properties, see DataTipTemplate Properties.

For an example of modifying data tips, see Create Custom Data Tips.

Note

The DataTipTemplate object is not returned by findobj or findall, and it is not copied by copyobj.

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

Note

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

Selection state, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

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

  • 'off' — Not selected.

Display of selection handles when selected, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

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

Clipping of the object to the axes limits, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

  • A value of 'on' clips parts of the object that are outside the axes limits.

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

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

Callbacks

expand all

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

  • Function handle

  • Cell array containing a function handle and additional arguments

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

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

  • Clicked object — Access properties of the clicked object from within the callback function.

  • Event data — Empty argument. 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.

Object creation function, specified as one of these values:

  • Function handle.

  • Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.

  • Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

For more information about specifying a callback as a function handle, cell array, or character vector, see Callback Definition.

This property specifies a callback function to execute when MATLAB creates the object. MATLAB initializes all property values before executing the CreateFcn callback. If you do not specify the CreateFcn property, then MATLAB executes a default creation function.

Setting the CreateFcn property on an existing component has no effect.

If you specify this property as a function handle or cell array, you can access the object that is being created using the first argument of the callback function. Otherwise, use the gcbo function to access the object.

Object deletion function, specified as one of these values:

  • Function handle.

  • Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.

  • Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

For more information about specifying a callback as a function handle, cell array, or character vector, see Callback Definition.

This property specifies a callback function to execute when MATLAB deletes the object. MATLAB executes the DeleteFcn callback before destroying the properties of the object. If you do not specify the DeleteFcn property, then MATLAB executes a default deletion function.

If you specify this property as a function handle or cell array, you can access the object that is being deleted using the first argument of the callback function. Otherwise, use the gcbo function to access the object.

Callback Execution Control

expand all

Callback interruption, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

This property determines if a running callback can be interrupted. 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.

MATLAB determines callback interruption behavior whenever it executes a command that processes the callback queue. These commands include drawnow, figure, uifigure, getframe, waitfor, and pause.

If the running callback does not contain one of these commands, then no interruption occurs. MATLAB first finishes executing the running callback, and later executes the interrupting callback.

If the running callback does contain one of these commands, then the Interruptible property of the object that owns the running callback determines if the interruption occurs:

  • If the value of Interruptible is 'off', then no interruption occurs. Instead, the BusyAction property of the object that owns the interrupting callback determines if the interrupting callback is discarded or added to the callback queue.

  • If the value of Interruptible is 'on', then the interruption occurs. The next time MATLAB processes the callback queue, it stops the execution of the running callback and executes the interrupting callback. After the interrupting callback completes, MATLAB then resumes executing the running callback.

Note

Callback interruption and execution behave differently in these situations:

  • If the interrupting callback is a DeleteFcn, CloseRequestFcn, or SizeChangedFcn callback, then the interruption occurs regardless of the Interruptible property value.

  • If the running callback is currently executing the waitfor function, then the interruption occurs regardless of the Interruptible property value.

  • If the interrupting callback is owned by a Timer object, then the callback executes according to schedule regardless of the Interruptible property value.

Note

When an interruption occurs, MATLAB does not save the state of properties or the display. For example, the object returned by the gca or gcf command might change when another callback executes.

Callback queuing, specified as 'queue' or 'cancel'. The BusyAction property determines how MATLAB handles the execution of interrupting callbacks. There are two callback states to consider:

  • The running callback is the currently executing callback.

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

The BusyAction property determines callback queuing behavior only when both of these conditions are met:

  • The running callback contains a command that processes the callback queue, such as drawnow, figure, uifigure, getframe, waitfor, or pause.

  • The value of the Interruptible property of the object that owns the running callback is 'off'.

Under these conditions, the BusyAction property of the object that owns the interrupting callback determines how MATLAB handles the interrupting callback. These are possible values of the BusyAction property:

  • 'queue' — Puts the interrupting callback in a queue to be processed after the running callback finishes execution.

  • 'cancel' — Does not execute the interrupting callback.

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

  • 'visible' — Capture mouse clicks when visible. The Visible property must be set to 'on' and you must click a part of the Scatter object 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 Scatter object responds to the click or if an ancestor does.

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

Response to captured mouse clicks, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

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

  • 'off' — Trigger the callbacks for the nearest ancestor of the Scatter object that has one of these:

    • HitTest property set to 'on'

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

Note

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

This property is read-only.

Deletion status, returned as an on/off logical value of type matlab.lang.OnOffSwitchState.

MATLAB sets the BeingDeleted property to 'on' when the DeleteFcn callback begins execution. The BeingDeleted property remains set to 'on' until the component object no longer exists.

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

Parent/Child

expand all

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

Children, returned as an empty GraphicsPlaceholder array or a DataTip object array. Use this property to view a list of data tips that are plotted on the chart.

You cannot add or remove children using the Children property. To add a child to this list, set the Parent property of the DataTip object to the chart object.

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

  • 'on' — Object handle is always visible.

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

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

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

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

Identifiers

expand all

This property is read-only.

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

Object identifier, specified as a character vector or string scalar. You can specify a unique Tag value to serve as an identifier for an object. When you need access to the object elsewhere in your code, you can use the findobj function to search for the object based on the Tag value.

User data, specified as any MATLAB array. For example, you can specify a scalar, vector, matrix, cell array, character array, table, or structure. Use this property to store arbitrary data on an object.

If you are working in App Designer, create public or private properties in the app to share data instead of using the UserData property. For more information, see Share Data Within App Designer Apps.

Compatibility Considerations

expand all

Not recommended starting in R2020a

Introduced before R2006a