RockerSwitch
Rocker switch UI component
Description
A rocker switch UI component indicates a logical state and updates its state when
an app user interacts with it. Use the RockerSwitch
object to modify the
appearance and behavior of a rocker switch after you create it.
Creation
Create a rocker switch in an app using the uiswitch
function, specifying the switch style as
"rocker"
.
Properties
Switch
Value, specified as an element of the Items
or
ItemsData
arrays. By default, Value
is the
first element in Items
.
Specifying Value
as an element of Items
moves the switch to the position that matches that element. If
ItemsData
is not empty, then Value
must be
set to an element of ItemsData
, and the switch will move to the
associated position.
Switch options, specified as a cell array of character vectors, string array, or
1
-by-2
categorical array. If you specify an
array, it must have two elements. Duplicate elements are allowed. If you specify this
property as a categorical array, MATLAB® uses the values in the array, not the full set of categories.
Data associated with each element of the Items
property
value, specified as a 1-by-2 numeric array or a 1-by-2 cell array.
Duplicate elements are allowed.
For example, if you set the Items
value
to {'Freezing','Boiling'}
, then you might set the ItemsData
value
to corresponding temperatures in degrees Celsius, [0,100]
.
The ItemsData
value is not visible to the app
user.
Example: {'One' 'Two'}
Example: [10 20]
Index of the component value in the list of items or item data, specified as a positive integer.
In most cases, you can use the Value
property to query and
update the component value. However, the ValueIndex
property can
be useful when both the Items
and ItemsData
properties are nonempty. In this case, you can use the ValueIndex
property to query the element of Items
that corresponds to the
current value.
fig = uifigure; rs = uiswitch(fig,"rocker", ... "Items",["Freezing","Boiling"], ... "ItemsData",[0 100]); idx = rs.ValueIndex; disp(rs.Items(idx) + ": " + rs.Value)
Freezing: 0
Orientation of the switch, specified as 'vertical'
or
'horizontal'
.
Font
Font name, specified as a system supported font name. The default font depends on the specific operating system and locale.
If the specified font is not available, then MATLAB uses the best match among the fonts available on the system where the app is running.
Example: 'Arial'
Font size, specified as a positive number. The units of measurement are pixels. The default font size depends on the specific operating system and locale.
Example: 14
Font weight, specified as one of these values:
'normal'
— Default weight as defined by the particular font'bold'
— Thicker character outlines than'normal'
Not all fonts have a bold font weight. For fonts that do not, specifying
'bold'
results in the normal font weight.
Font angle, specified as 'normal'
or 'italic'
.
Not all fonts have an italic font angle. For fonts that do not, specifying
'italic'
results in the normal font angle.
Font color, specified as an RGB triplet, a hexadecimal color code, or one of the options listed in the table.
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" |
This table lists the default color palettes for plots in the light and dark themes.
Palette | Palette Colors |
---|---|
Before R2025a: Most plots use these colors by default. |
|
|
|
You can get the RGB triplets and hexadecimal color codes for these palettes using the orderedcolors
and rgb2hex
functions. For example, get the RGB triplets for the "gem"
palette and convert them to hexadecimal color codes.
RGB = orderedcolors("gem");
H = rgb2hex(RGB);
Before R2023b: Get the RGB triplets using RGB =
get(groot,"FactoryAxesColorOrder")
.
Before R2024a: Get the hexadecimal color codes using H =
compose("#%02X%02X%02X",round(RGB*255))
.
Interactivity
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 UI component.
To make your app start faster, set the Visible
property to
'off'
for all UI components that do not need to appear at
startup.
Operational 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
.
If you set this property to
'on'
, the app user can interact with the component.If you set this property to
'off'
, the component appears dimmed, indicating that the app user cannot interact with it, and that it will not trigger a callback.
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.
Context menu, specified as a ContextMenu
object created using the uicontextmenu
function. Use this property to display a context menu when
you right-click on a component.
Position
Location and size of the switch, excluding state marks and labels, 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 the switch |
bottom | Distance from the inner bottom edge of the parent container to the outer bottom edge of the switch |
width | Distance between the right and left outer edges of the switch, excluding labels |
height | Distance between the top and bottom outer edges of the switch, excluding labels |
All measurements are in pixel units.
The switch has a fixed width-to-height aspect ratio of 1 to 2.25 with a vertical
orientation and 2.25 to 1 with a horizontal orientation. Therefore, you cannot change
the switch width and height independently of one another. To change the switch size,
specify a desired size for the switch by using s.Position(3:4) = [width
height]
. MATLAB automatically sizes the switch to fit within the box defined by the
desired size while maintaining its aspect ratio.
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.
Example: [100 100 40 90]
Inner location and size of the switch, excluding state marks and state labels,
specified as the vector, [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.
This property is read-only.
Outer location and size of the switch, including state marks and state labels,
returned as the vector, [left bottom width height]
. Position values
are relative to the parent container. All measurements are in pixel units.
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.
For example, this code places a rocker switch in the third row and second column of its parent grid.
g = uigridlayout([4 3]);
rs = uiswitch(g,'rocker');
rs.Layout.Row = 3;
rs.Layout.Column = 2;
To make the switch span multiple rows or columns, specify the
Row
or Column
property as a two-element
vector. For example, this switch spans columns 2
through
3
:
rs.Layout.Column = [2 3];
Callbacks
Value changed 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.
This callback executes when the state of the switch changes in the app. The switch changes state when the user does either of the following:
Clicking and releasing the mouse button anywhere on the switch (including the state labels)
Clicking on the switch, dragging, and then releasing the mouse button while still on the switch.
The callback does not execute if the Value
property
changes programmatically.
This callback function can access specific information about the user’s interaction
with the switch. MATLAB passes this information in a ValueChangedData
object as the second argument to your callback function.
In App Designer, the argument is called event
. You can query the
object properties using dot notation. For example,
event.PreviousValue
returns the previous value of the switch. The
ValueChangedData
object is not available to
callback functions specified as character vectors.
The following table lists the properties of the ValueChangedData
object.
Property | Value |
---|---|
Value | Value of switch after the app user’s most recent interaction |
PreviousValue | Value of switch before the app user’s most recent interaction |
ValueIndex | Index of switch value in items after the app user’s most recent interaction |
PreviousValueIndex | Index of switch value in items before the app user’s most recent interaction |
Source | Component that executes the callback |
EventName | 'ValueChanged' |
For more information about writing callbacks, see Callbacks in App Designer.
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.
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
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.
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.
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 container, specified as a Figure
object 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.
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
This property is read-only.
Type of graphics object, returned as 'uirockerswitch'
.
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.
Examples
Create an app that changes the color of a lamp when a user toggles the value of a rocker switch.
In a file named updateLampColor.m
, write a function that implements the app:
Create a UI figure and grid layout manager to lay out the app.
Create a lamp and a rocker switch in the grid layout manager.
Write a callback function named
updateLamp
that changes the lamp color based on the value of the switch, and assign the function to theValueChangedFcn
callback property of the switch. For more information about callbacks, see Create Callbacks for Apps Created Programmatically.
function updateLampColor fig = uifigure("Position",[100 100 150 300]); g = uigridlayout(fig); g.RowHeight = {'1x','fit'}; g.ColumnWidth = {'1x'}; lmp = uilamp(g); s = uiswitch(g,"rocker"); s.Items = ["Go","Stop"]; s.ValueChangedFcn = @(src,event) updateLamp(src,event,lmp); end function updateLamp(src,event,lmp) val = src.Value; switch val case "Go" lmp.Color = "green"; case "Stop" lmp.Color = "red"; end end
Run the updateLampColor
function. Interact with the switch to change the color of the lamp.
updateLampColor
Version History
Introduced in R2016aThe default FontColor
property value in the light theme has changed slightly. Starting in R2025a, the default value is [0.1294 0.1294 0.1294]
. Previously, the default value was [0 0 0]
.
Access the index of the component value in the list of items by using the
ValueIndex
property.
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: United States.
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)