Mask Parameters

About Mask Parameters

This section lists parameters that describe masked blocks. You can use these descriptive parameters with get_param and set_param to obtain and specify the properties of a block mask.

The descriptive mask parameters listed in this section apply to all masks, and provide access to all mask properties. Be careful not to confuse these descriptive mask parameters with the mask-specific parameters defined for an individual mask in the Mask Editor Parameters pane.

See What Are Masks? and Masking for information about block masks and the Mask Editor.

Mask Parameters

Parameter

Description/Prompt

Values

Mask

Turns mask on or off.

{'on'} | 'off'

MaskCallbackString

Mask parameter callbacks that are executed when the respective parameter is changed on the dialog. Set by the Dialog callback field on the Parameters pane of the Mask Editor dialog box.

pipe-delimited string {''}

MaskCallbacks

Cell array version of MaskCallbackString.

cell array {'[]'}

MaskDescription

Block description. Set by the Mask description field on the Documentation pane of the Mask Editor dialog box.

string {''}

MaskDisplay

Drawing commands for the block icon. Set by the Icon Drawing commands field on the Icon & Ports pane of the Mask Editor dialog box.

string {''}

MaskEditorHandle

For internal use only.

 

MaskEnableString

Option that determines whether a parameter is greyed out in the dialog. Set by the Enable parameter check box on the Parameters pane of the Mask Editor dialog box.

pipe-delimited string {''}

MaskEnables

Cell array version of MaskEnableString.

cell array of strings, each either 'on' or ''off' {'[]'}

MaskHelp

Block help. Set by the Mask help field on the Documentation pane of the Mask Editor dialog box.

string {''}

MaskIconFrame

Set the visibility of the icon frame (Visible is on, Invisible is off). Set by the Block Frame option on the Icon & Ports pane of the Mask Editor dialog box.

{'on'} | 'off'

MaskIconOpaque

Set the transparency of the icon (Opaque is on, Transparent is off). Set by the Icon Transparency option on the Icon & Ports pane of the Mask Editor dialog box.

{'on'} | 'off'

MaskIconRotate

Set the rotation of the icon (Rotates is on, Fixed is off). Set by the Icon Rotation option on the Icon & Ports pane of the Mask Editor dialog box.

'on' | {'off'}

MaskIconUnits

Set the units for the drawing commands. Set by the Icon Units option on the Icon & Ports pane of the Mask Editor dialog box.

'pixel' | {'autoscale'} | 'normalized'

MaskInitialization

Initialization commands. Set by the Initialization commands field on the Initialization pane of the Mask Editor dialog box.

MATLAB® command {''}

MaskNames

Cell array of mask dialog parameter names. Set inside the Variable column in the Parameters pane of the Mask Editor dialog box.

matrix {'[]'}

MaskPortRotate

Specify the port rotation policy for the masked block. Set in the Port Rotation area on the Icon & Ports pane of the Mask Editor dialog box.

For more information, see Change the Appearance of a Block in the Simulink® documentation.

{'default} | 'physical'

MaskPrompts

List of dialog parameter prompts (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask Editor dialog box.

cell array of strings {'[]'}

MaskPromptString

List of dialog parameter prompts (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask Editor dialog box.

string {''}

MaskPropertyName
String

Pipe-delimited version of MaskNames.

string {''}

MaskRunInitForIconRedraw

For internal use only.

 

MaskSelfModifiable

Indicates that the block can modify itself. Set by the Allow library block to modify its contents check box on the Initialization pane of the Mask Editor dialog box.

'on' | {'off'}

MaskStyles

Determines whether the dialog parameter is a check box, edit field, or pop-up list. Set by the Type column in the Parameters pane of the Mask Editor dialog box.

cell array {'[]'}

MaskStyleString

Comma-separated version of MaskStyles.

string {''}

MaskTabNameString

For internal use only.

 

MaskTabNames

For internal use only.

 

MaskToolTipsDisplay

Determines which mask dialog parameters to display in the data tip for this masked block (see "Block Data Tips" in the Simulink documentation). Specify as a cell array of 'on' or 'off' values, each of which indicates whether to display the parameter named at the corresponding position in the cell array returned by MaskNames.

cell array of 'on' and 'off' {''}

MaskToolTipString

Comma-delimited version of MaskToolTipsDisplay.

string {''}

MaskTunableValues

Allows the changing of mask dialog values during simulation. Set by the Tunable column in the Parameters pane of the Mask Editor dialog box.

cell array of strings {'[]'}

MaskTunableValueString

Comma-delimited string version of MaskTunableValues.

delimited string {''}

MaskType

Mask type. Set by the Mask type field on the Documentation pane of the Mask Editor dialog box.

string {'Stateflow'}

MaskValues

Dialog parameter values.

cell array {'[]'}

MaskValueString

Delimited string version of MaskValues.

delimited string {''}

MaskVarAliases

Specify aliases for a block's mask parameters. The aliases must appear in the same order as the parameters appear in the block's MaskValues parameter.

cell array {'[]'}

MaskVarAliasString

For internal use only.

 

MaskVariables

List of the dialog parameters' variables (see below). Set inside the Dialog parameters area on the Parameters pane of the Mask Editor dialog box.

string {''}

MaskVisibilities

Specifies visibility of parameters. Set with the Show parameter check box in the Options for selected parameter area on the Parameters pane of the Mask Editor dialog box.

matrix {'[]'}

MaskVisibilityString

Delimited string version of MaskVisibilities.

string {''}

MaskWSVariables

List of the variables defined in the mask workspace (read only).

matrix {'[]'}

See Control Masks Programmatically, for more information on setting the mask parameters from the MATLAB command line.

Was this topic helpful?