Meter Properties
Audio meters are UI components for displaying audio measurements. You can create
an audio meter with the uiaudiometer
function.
Properties control the behavior and appearance of an audio meter. Use dot notation to refer to a specific object and property.
fig = uifigure; meter = uiaudiometer(fig); meter.Value = -10;
Audio Meter
Value
— Values displayed on meter
[-80 -80]
(default) | 1-D numeric vector
Values that are displayed on the audio meter, specified as a 1-D numeric vector where each element corresponds to an audio channel.
ValueUnits
— Units of meter values
"dBFS"
(default) | string scalar | character array
Units of the meter values, specified as a string scalar or character array. Use this property to display the units of the values on the audio meter.
The units are displayed at the top-left or the bottom-right of the meter in vertical or horizontal orientation, respectively.
Limits
— Value limits
[-80 3]
(default) | [min max]
Value limits that determine the minimum and maximum values displayed on the meter,
specified as a finite numeric vector of the format [min max]
.
LevelColors
— Level bar colors
N-by-3 matrix | 1-D string array | 1-D cell array of character vectors
Level bar colors, specified as an N-by-3 matrix of RGB triplets
or a string array or cell array containing N hexadecimal color codes,
color names, or short names. N defines the number of levels. The
LevelColors
property specifies the colors displayed on the meter
for the value level ranges defined by LevelColorLimits
.
For more information about specifying custom colors, see Specifying Custom Colors.
LevelColorLimits
— Level color limits
[-80 -12; -12 -3; -3 3]
(default) | N-by-2 matrix
Level color limits, specified as an N-by-2 matrix, where
N is the number of level colors specified in the
LevelColors
property. For every row in the matrix, the first
element must be less than the second element.
Orientation
— Orientation of meter
"vertical"
(default) | "horizontal"
Orientation of the meter, specified as "vertical"
or
"horizontal"
. Changing this property automatically changes the
Position
property to maintain the aspect ratio.
MaxHoldDuration
— Duration to hold maximum values
3 (default) | nonnegative scalar
Duration in seconds to hold a maximum value in the meter using a marker, specified
as a nonnegative scalar. Set the MaxHoldDuration
to 0 to not show a
marker for the maximum value.
Color and Styling
MeterColor
— Background color for meter
[1 1 1]
(default) | RGB triplet | hexadecimal color code | color name | short name
Background color for the meter holding the level bars, specified as an RGB triplet, hexadecimal color code, color name, or short name. For more information, see Specifying Custom Colors.
FontColor
— Font color
[0.1294 0.1294 0.1294]
(default) | RGB triplet | hexadecimal color code | color name | short name
Font color for the labels, axes ticks, and border, specified as an RGB triplet, hexadecimal color code, color name, or short name. For more information, see Specifying Custom Colors.
BackgroundColor
— Background color for component
[0.9608 0.9608 0.9608]
(default) | RGB triplet | hexadecimal color code | color name | short name
Background color for the component, specified as an RGB triplet, hexadecimal color code, color name, or short name. For more information, see Specifying Custom Colors.
Interactivity
Visible
— Visibility of audio meter
'on'
(default) | on/off logical value
Visibility of the audio meter, 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
. The
Visible
property determines whether the audio meter is displayed
on the screen. If the Visible
property is set to
'off'
, then the entire audio meter is hidden, but you can still
specify and access its properties.
Enable
— Operational state of audio meter
'on'
(default) | on/off logical value
Operational state of the audio meter, 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
.
If you set this property to
'on'
, then the appearance of the meter indicates that the indicator is operational.If you set this property to
'off'
, then the appearance of the meter appears dimmed, indicating that the meter is not operational.
Tooltip
— Tooltip
''
(default) | character vector | cell array of character vectors | string array | 1-D categorical array
Tooltip, specified as a character vector, cell array of character vectors, string array, or 1-D categorical array. Use this property to display a message when the user hovers the pointer over the component at run time. The tooltip displays even when the component is disabled. To display multiple lines of text, specify a cell array of character vectors or a string array. Each element in the array becomes a separate line of text. If you specify this property as a categorical array, MATLAB® uses the values in the array, not the full set of categories.
Position
Position
— Location and size of audio meter
[10 10 100 400]
(default) | [left bottom width height]
Location and size of the audio meter relative to the parent container, specified as
the vector, [left bottom width height]
. This table describes each
element in the vector.
Element | Description |
---|---|
left | Distance from the inner left edge of the parent container to the outer left edge of an imaginary box surrounding the audio meter |
bottom | Distance from the inner bottom edge of the parent container to the outer bottom edge of an imaginary box surrounding the audio meter |
width | Distance between the right and left outer edges of the audio meter |
height | Distance between the top and bottom outer edges of the audio meter |
All measurements are in pixel units.
The Position
values are relative to the drawable
area of the parent container. The drawable area is the area inside the
borders of the container and does not include the area occupied by decorations such as a
menu bar or title.
InnerPosition
— Inner location and size of audio meter
[10 10 100 400]
(default) | [left bottom width height]
This property is read-only.
Inner location and size of the audio meter, returned as [left bottom width
height]
. Position values are relative to the parent container. All
measurements are in pixel units. This property value is identical to the
Position
property.
OuterPosition
— Outer location and size of audio meter
[10 10 100 400]
(default) | [left bottom width height]
This property is read-only.
Outer location and size of the audio meter returned as [left bottom width
height]
. Position values are relative to the parent container. All
measurements are in pixel units. This property value is identical to the
Position
property.
Layout
— Layout options
empty LayoutOptions
array (default) | GridLayoutOptions
object
Layout options, specified as a
GridLayoutOptions
object. This property specifies options for
components that are children of grid layout containers. If the component is not a child
of a grid layout container (for example, it is a child of a figure or panel), then this
property is empty and has no effect. However, if the component is a child of a grid
layout container, you can place the component in the desired row and column of the grid
by setting the Row
and Column
properties on
the GridLayoutOptions
object.
Callbacks
SizeChangedFcn
— Size change callback
''
(default) | function handle | cell array | character vector
Size change callback, specified as one of these values:
A function handle.
A 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.
A character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.
The SizeChangedFcn
callback executes when:
The component becomes visible for the first time.
The component is visible while its size changes.
The component becomes visible for the first time after its size changes. This situation occurs when the size changes while the component is invisible, and then it becomes visible later.
CreateFcn
— Creation function
''
(default) | function handle | cell array | character vector
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 Callbacks in App Designer.
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.
DeleteFcn
— Deletion function
''
(default) | function handle | cell array | character vector
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 Callbacks in App Designer.
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
Interruptible
— Callback interruption
'on'
(default) | on/off logical value
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, theBusyAction
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
, orSizeChangedFcn
callback, then the interruption occurs regardless of theInterruptible
property value.If the running callback is currently executing the
waitfor
function, then the interruption occurs regardless of theInterruptible
property value.If the interrupting callback is owned by a
Timer
object, then the callback executes according to schedule regardless of theInterruptible
property value.
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. 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:
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.
BeingDeleted
— Deletion status
on/off logical value
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
Parent
— Parent container
Figure
object (default) | Panel
object | Tab
object | ButtonGroup
object | GridLayout
object
Parent container, specified as a Figure
object
created using the uifigure
function, or one of its child
containers: Tab
, Panel
, ButtonGroup
, or GridLayout
. If no container is specified, MATLAB calls the uifigure
function to create a new Figure
object that serves as the parent container.
HandleVisibility
— Visibility of object handle
'on'
(default) | 'callback'
| 'off'
Visibility of the object handle, specified as 'on'
,
'callback'
, or 'off'
.
This property controls the visibility of the object in its parent's list of
children. When an object is not visible in its parent's list of children, it is not
returned by functions that obtain objects by searching the object hierarchy or querying
properties. These functions include get
, findobj
, clf
, and close
. Objects are valid even if they are
not visible. If you can access an object, you can set and get its properties, and pass
it to any function that operates on objects.
HandleVisibility Value | Description |
---|---|
'on' | The object is always visible. |
'callback' | The object 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 allows callback functions to access it. |
'off' | The object 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 object during the execution of that function. |
Identifiers
Tag
— Object identifier
''
(default) | character vector | string scalar
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.
Type
— Type of graphics object
'uiaudiometer'
This property is read-only.
Type of graphics object, returned as 'uiaudiometer'
.
UserData
— User data
[]
(default) | array
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.
More About
Specifying Custom Colors
RGB triplets and hexadecimal color codes are useful for specifying custom colors.
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 from0
toF
. 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 Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" | |
"green" | "g" | [0 1 0] | "#00FF00" | |
"blue" | "b" | [0 0 1] | "#0000FF" | |
"cyan"
| "c" | [0 1 1] | "#00FFFF" | |
"magenta" | "m" | [1 0 1] | "#FF00FF" | |
"yellow" | "y" | [1 1 0] | "#FFFF00" | |
"black" | "k" | [0 0 0] | "#000000" | |
"white" | "w" | [1 1 1] | "#FFFFFF" |
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.
RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|
[0 0.4470 0.7410] | "#0072BD" | |
[0.8500 0.3250 0.0980] | "#D95319" | |
[0.9290 0.6940 0.1250] | "#EDB120" | |
[0.4940 0.1840 0.5560] | "#7E2F8E" | |
[0.4660 0.6740 0.1880] | "#77AC30" | |
[0.3010 0.7450 0.9330] | "#4DBEEE" | |
[0.6350 0.0780 0.1840] | "#A2142F" |
Version History
Introduced in R2023b
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)