Main Content

Simulink.ID.hilite

(Not recommended) Highlight object associated with Simulink Identifier

Simulink.ID.hilite is not recommended. Use hilite_system instead. For more information, see Compatibility Considerations.

Description

example

Simulink.ID.hilite(SID) highlights the object associated with the Simulink® Identifier SID.

example

Simulink.ID.hilite(SID,style) uses the specified highlighting style.

Examples

collapse all

Open the model vdp.

openExample('simulink_general/VanDerPolOscillatorExample')

Get the Simulink Identifier of the Mu block.

muSID = Simulink.ID.getSID('vdp/Mu')

Highlight the Mu block.

Simulink.ID.hilite(muSID)

Open the model vdp.

openExample('simulink_general/VanDerPolOscillatorExample')

Get the Simulink Identifier of the Mu block.

muSID = Simulink.ID.getSID('vdp/Mu')

Highlight the Mu block using the style 'fade'.

Simulink.ID.hilite(muSID,'fade')

Input Arguments

collapse all

Simulink Identifier, specified as a character vector or string scalar.

To get the SID for an object, use the Simulink.ID.getSID function.

Example: 'vdp:4'

Highlighting style, specified as one of these values.

  • 'default' — Default color scheme: red outline, yellow fill.

  • 'none' — Clears the highlight.

    To clear all highlighting, on the Debug tab, in the Trace Signal button group, click the Remove trace button.

  • 'debug' — Uses default color scheme.

  • 'different' — Applies red outline, white fill.

  • 'error' — Uses default color scheme.

  • 'fade' — Applies gray outline, white fill.

  • 'find' — Applies dark blue outline, blue fill.

  • 'lineTrace' — Applies red outline, blue fill.

  • 'unique' — Dark blue outline, white fill.

  • 'user1', 'user2', 'user3', 'user4', 'user5' — Applies custom highlight: black outline, white fill by default (that is, no highlight).

In addition, you can use these color schemes. The first word is the outline and the second is the fill color.

  • 'orangeWhite'

  • 'blackWhite'

  • 'redWhite'

  • 'blueWhite'

  • 'greenWhite'

You can customize the appearance of any of the styles. See Customize Highlighting Style.

Version History

Introduced in R2009b

collapse all

R2020a: Not recommended

Simulink.ID.hilite is not recommended. Use hilite_system instead.

This table shows a typical usage of Simulink.ID.hilite and how to update your code.

Not RecommendedRecommended
SID = Simulink.ID.getSID('vdp/Mu');
Simulink.ID.hilite(SID)
hilite_system('vdp/Mu')