filter-model-file ("fm")

See this command in the command table.

To access this command:

  • Using the command line, enter "filter-model-file" and press ENTER.

  • Use the quick key combination "fm".

  • Display the Find Command screen, locate filter-model-file and click Run.

Command Overview

Filter all visible block model overlays.

This command makes it possible to display and work with different parts of the block model using a filter expression. The filter is used whenever the block model is used.

Existing filters can be removed by selecting this command but not specifying any filters. Then use the redraw-display command to display all the data.

A block model file must be open before filters may be applied. For more information on filtering data, click here.

Command steps:

  1. Run the command.

    The Expression Builder displays.

  2. Enter or construct a valid filter expression. See Filtering Data.

  3. Click OK.

Command Automation

You can automate by passing this command and parameters into oDmApp.ParseCommand(), using any COM-aware scripting language.

Note: For more information on scripting in Studio NPVS+, please refer to your Scripting Tutorial (Help > Scripting Tutorial).

Example Parameter String (JS):

oDmApp.ParseCommand("filter-model-file 'AU>1.0' '$'";

Where:

  • 'AU>1.0' is the filterExpressionToken(s): one or more argument tokens parsed and concatenated into the filter expression string.

  • '$' is the '$': a terminator token that can be used to end expression parsing explicitly.

Parameters Table

Parameter Description Reqd? Example Syntax
filterExpressionToken(s)

One or more argument tokens parsed and concatenated into the filter expression string.

Y 'AU>1.0'
'$'

A terminator token that can be used to end expression parsing explicitly.

Y '$'

Related topics and activities: