Main Content

Gauge Properties

Control gauge appearance and behavior

Gauges are app components that represent measurement instruments. Properties control the appearance and behavior of a gauge. Use dot notation to refer to a particular object and property:

fig = uifigure; g = uigauge(fig); g.Value = 45;

Gauge

expand all

Location of the gauge needle, specified as any numeric value.

  • If the value is less than the minimumLimitsproperty value, then the needle points to a location immediately before the beginning of the scale.

  • If the value is more than the maximumLimitsproperty value, then the needle points to a location immediately after the end of the scale.

Changing theLimitsproperty value has no effect on theValueproperty setting.

Example:60

Minimum and maximum gauge scale values, specified as a two-element numeric array. The first value in the array must be less than the second value.

If you changeLimitssuch that theValueproperty is less than the new lower limit, or more than the new upper limit, then the gauge needle points to a location off the scale.

For example, supposeLimitsis[0 100]and theValueproperty is 20. If theLimits查nges to[50 100], then the needle points to a location off the scale, slightly less than 50.

Direction of the gauge scale, specified as one of the following:

  • 'clockwise'— The scale appears such that the scale tick values increase in a clockwise manner.

  • 'counterclockwise'— The scale appears such that the scale tick values increase in a counterclockwise manner.

Scale colors, specified as one of the following arrays:

  • A 1-by-nstring array of color options, such as["blue" "green" "red"].

  • Ann-by-3 array of RGB triplets, such as[0 0 1;1 1 0].

  • A 1-by-ncell array containing RGB triplets, hexadecimal color codes, or named color options. For example,{'#EDB120','#7E2F8E','#77AC30'}.

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

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

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'

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'

样本的RGB值(0.6350 0.0780 0.1840)范围h appears as dark red

Each color of theScaleColorsarray corresponds to a colored section of the gauge. Set theScaleColorLimitsproperty to map the colors to specific sections of the gauge.

If you do not set theScaleColorLimitsproperty, MATLAB distributes the colors equally over the range of the gauge.

Scale color limits, specified as a n-by-2 array of numeric values. For every row in the array, the first element must be less than the second element.

When applying colors to the gauge, MATLAB applies the colors starting with the first color in theScaleColorsarray. Therefore, if two rows inScaleColorLimitsarray overlap, then the color applied later takes precedence.

The gauge does not display any portion of theScaleColorLimitsthat fall outside of theLimitsproperty.

If theScaleColorsandScaleColorLimitsproperty values are different sizes, then the gauge shows only the colors that have matching limits. For example, if theScaleColorsarray has three colors, but theScaleColorLimitshas only two rows, then the gauge displays the first two color/limit pairs only.

Ticks

expand all

Major tick mark locations, specified as a vector of numeric values or an empty vector. If you do not want to show major tick marks, specify this property as an empty vector.

Tick locations that are outside the range of theLimitsproperty do not display.

MATLAB removes duplicate tick values. However, if a major tick falls on the same value as a minor tick, only the major tick displays.

Setting theMajorTicksproperty sets theMajorTicksModeproperty to'manual'.

Major tick creation mode, specified as one of the following:

  • 'auto'— MATLAB determines the placement of major ticks.

  • 'manual'— You specify theMajorTicksvalue array.

Major tick labels, specified as a cell array of character vectors, string array, or 1-D categorical array. If you do not want to show tick labels, specify this property as an empty cell array. If you want to remove a label from a specific tick mark, specify an empty character vector or empty string scalar for the corresponding element in theMajorTickLabelsarray. If you specify this property as a categorical array, MATLAB uses the values in the array, not the full set of categories.

If the length of theMajorTickLabels数组的长度不同MajorTicksvector, MATLAB ignores the extra entries of the longer array. If there are extra labels, they are ignored. If there are extra tick marks, they display without labels.

SettingMajorTickLabels查nges theMajorTickLabelsModevalue to'manual'.

Note

SettingMajorTickLabelswhenMajorTicksModeis'auto'might lead to unexpected results. To avoid this behavior, setMajorTicksModeto'manual'and manually specify the value ofMajorTicksbefore settingMajorTickLabels.

Major tick labels mode, specified as one of the following:

  • 'auto'— MATLAB specifies the major tick labels.

  • 'manual'— You specify the major tick labels using theMajorTickLabelsproperty.

Minor tick mark locations, specified as a vector of numeric values or an empty vector. If you do not want to show minor tick marks, specify this property as an empty vector.

Tick locations that are outside the range of theLimitsproperty do not display.

MATLAB removes duplicate tick values. However, if a minor tick falls on the same value as a major tick, only the major tick displays.

Setting theMinorTicksproperty value sets theMinorTicksModeproperty value to'manual'.

Minor tick creation mode, specified as one of the following:

  • 'auto'— MATLAB determines the placement of minor ticks. MATLAB does not generate minor ticks for major ticks that are beyond scale limits. If theLimitsproperty value changes, then MATLAB updates minor ticks to populate the full scale range (theMinorTicksproperty is updated accordingly).

  • 'manual'— You specify theMinorTicksproperty numeric array. TheMinorTicksproperty value does not change size or content on its own.

Font and Color

expand all

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'违约重量所定义的特定的字体

  • 'bold'— Thicker character outlines than'normal'

Not all fonts have a bold font weight. For fonts that do not, specifying'bold'结果在正常字体的重量。

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

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

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'

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'

样本的RGB值(0.6350 0.0780 0.1840)范围h appears as dark red

Background color, specified as an RGB triplet, a hexadecimal color code, or one of the color 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 from0toF. 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'

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

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'

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'

样本的RGB值(0.6350 0.0780 0.1840)范围h appears as dark red

Interactivity

expand all

State of visibility, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'is equivalent totrue, and'off'is equivalent tofalse. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of typematlab.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 theVisibleproperty to'off'for all UI components that do not need to appear at startup.

Operational state of gauge, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'is equivalent totrue, and'off'is equivalent tofalse. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of typematlab.lang.OnOffSwitchState.

  • If you set this property to'on', then the appearance of the gauge indicates that the gauge is operational.

  • If you set this property to'off', then the appearance of the gauge appears dimmed, indicating that the gauge is not operational.

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 aContextMenuobject created using theuicontextmenufunction. Use this property to display a context menu when you right-click on a component.

Position

expand all

Location and size of the gauge 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 gauge
bottom Distance from the inner bottom edge of the parent container to the outer bottom edge of an imaginary box surrounding the gauge
width Distance between the right and left outer edges of the gauge
height Distance between the top and bottom outer edges of the gauge

All measurements are in pixel units.

ThePositionvalues are relative to thedrawable areaof 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:[200 120 120 120]

Inner location and size of the gauge, specified 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 thePositionproperty.

This property is read-only.

Outer location and size of the gauge 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 thePositionproperty.

Layout options, specified as aGridLayoutOptionsobject. 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 theRowandColumnproperties on theGridLayoutOptionsobject.

For example, this code places a gauge in the third row and second column of its parent grid.

g = uigridlayout([4 3]); gauge = uigauge(g); gauge.Layout.Row = 3; gauge.Layout.Column = 2;

To make the gauge span multiple rows or columns, specify theRoworColumnproperty as a two-element vector. For example, this gauge spans columns2through3:

gauge.Layout.Column = [2 3];

Callbacks

expand all

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, seeCallbacks in App Designer.

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

Setting theCreateFcnproperty 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 thegcbofunction 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, seeCallbacks in App Designer.

This property specifies a callback function to execute when MATLAB deletes the object. MATLAB executes theDeleteFcncallback before destroying the properties of the object. If you do not specify theDeleteFcnproperty, 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 thegcbofunction to access the object.

Callback Execution Control

expand all

Callback interruption, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'is equivalent totrue, and'off'is equivalent tofalse. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of typematlab.lang.OnOffSwitchState.

This property determines if a running callback can be interrupted. There are two callback states to consider:

  • Therunningcallback is the currently executing callback.

  • Theinterruptingcallback 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 includedrawnow,figure,uifigure,getframe,waitfor, andpause.

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 theInterruptibleproperty of the object that owns the running callback determines if the interruption occurs:

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

  • If the value ofInterruptibleis'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 aDeleteFcn,CloseRequestFcn, orSizeChangedFcncallback, then the interruption occurs regardless of theInterruptibleproperty value.

  • If the running callback is currently executing thewaitforfunction, then the interruption occurs regardless of theInterruptibleproperty value.

  • If the interrupting callback is owned by aTimerobject, then the callback executes according to schedule regardless of theInterruptibleproperty value.

Note

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

回调queuing, specified as'queue'or'cancel'. TheBusyActionproperty determines how MATLAB handles the execution of interrupting callbacks. There are two callback states to consider:

  • Therunningcallback is the currently executing callback.

  • Theinterruptingcallback is a callback that tries to interrupt the running callback.

TheBusyActionproperty determines callback queuing behavior only when both of these conditions are met:

  • The running callback contains a command that processes the callback queue, such asdrawnow,figure,uifigure,getframe,waitfor, orpause.

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

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

  • '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 typematlab.lang.OnOffSwitchState.

MATLAB sets theBeingDeletedproperty to'on'when theDeleteFcncallback begins execution. TheBeingDeletedproperty remains set to'on'until the component object no longer exists.

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

Parent/Child

expand all

Parent container, specified as aFigureobject created using theuifigurefunction, or one of its child containers:Tab,Panel,ButtonGroup, orGridLayout. If no container is specified, MATLAB calls theuifigurefunction to create a newFigureobject 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 includeget,findobj,clf, andclose. 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' 对象是无形的。这个选项is useful for preventing unintended changes to the UI by another function. Set theHandleVisibilityto'off'to temporarily hide the object during the execution of that function.

Identifiers

expand all

This property is read-only.

Type of graphics object, returned as'uigauge'.

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

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 theUserDataproperty. For more information, seeShare Data Within App Designer Apps.

Version History

Introduced in R2016a

See Also

Functions