showLegend

Toggle display legends in Filter Analyzer app

Since R2024a

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

Examples

Hide Legend

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

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

Toggle off the legend.

showLegend(fa,false)

Input Arguments

fa — Filter Analyzer app handle

filterAnalyzer object

Filter Analyzer app handle, specified as a filterAnalyzer object.

showit — Show option

false (default) | true

Show option, specified as false or true.

Data Types: logical

dispnums — Display numbers to toggle legends

integer | vector of integers

Display numbers 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