Main Content

showLegend

Show or hide display legends in Filter Analyzer app

Since R2024a

collapse all in page

Syntax

showLegend(fa,showit)
showLegend(___,DisplayNums=dispnums)

Description

showLegend(fa,showit) shows or hides the legend on the active display in the Filter Analyzer app fa, depending on whether showit is true or false, respectively. By default, Filter Analyzer uses the filter names to specify the legend strings. If you want to add information to the legend strings, use setLegendStrings.

showLegend(___,DisplayNums=dispnums) shows or hides the legend on the displays specified in dispnums.

example

Examples

collapse all

Open Live Script

Design a lowpass filter. Start Filter Analyzer and show the magnitude response.

d1 = designfilt("lowpassfir", ...
    PassbandFrequency=0.45,StopbandFrequency=0.55);
fa = filterAnalyzer(d1);

Hide the legend.

showLegend(fa,false)

Input Arguments

collapse all

Filter Analyzer app handle, specified as a filterAnalyzer object.

Show option, specified as a logical 0 (false) or 1 (true).

Data Types: logical

Displays on which to toggle legends, specified as an integer or a vector of integers. If you do not specify this argument, Filter Analyzer toggles the legend on the active display. Identification numbers appear above the plotting area of the app, on the tabs that correspond to the different displays.

Example: [1 5]

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

Version History

Introduced in R2024a

See Also

Apps

Objects

Functions