Motion Standalone Postprocessor C# library 2026 R1

Interface IOperationsContourViewModel

Last update: 09.03.2026

Namespace: VM.Operations.Post.Interfaces
Assembly: VM.Operations.Post.dll

Interface representing information for the contour view model.

public interface IOperationsContourViewModel

Examples

For an example that includes information about interfaces, see this example. To view the examples, refer to the location of the 'Install_Path\Motion\Document\Postprocessor API for Python.zip' file.

# IOperationsContourViewModel.py
import sys

# Get the current file's path and set the path for external modules.
current_dir = __file__.rsplit('\\', 1)[0]
external_modules_path = current_dir + '\\..\\..\\Modules'
sys.path.append(external_modules_path)

# Import necessary modules
from OperationAPI import *

# Start the headless application interface
applicationHandler = ApplicationHandler()

# Import result file
result_file_path = get_result_file_path()

# Set array about result file
filepaths = List[str]()
filepaths.Add(result_file_path)

# Open about result files
# This will open the result file in the application.
# When the result is first opened, a Page is created and an Animation View is created on that Page.
applicationHandler.AddDocument(filepaths)

# Get all created pages.
# This retrieves all pages created in the application.
pages = applicationHandler.GetPages()

findViews = list()
for page in pages :
    views = page.GetViews()
    animationViews = [view for view in views if view.ViewType == ViewType.Animation]
    for animationView in animationViews :
        if animationView.DocumentFilePath == result_file_path and animationView.AnalysisResultType == AnalysisResultType.Dynamics :
            findViews.append(animationView)

# result_file_path - Get the document from the result file path.
document = applicationHandler.GetDocument(result_file_path)

# This retrieves the analysis result from the document.
# Types of Analysis Results
# - Dynamics
# - Eigenvalue
# - Statics
dynamic_analysis = document.GetAnalysisResultViewModel(AnalysisResultType.Dynamics)
dynamic_analysis.SetAnimationFrame(10)

# It returns the objects available for contouring that correspond to the MappingType.
targetentities = dynamic_analysis.GetContourables(ContourMappingType.FENode)

# Create Contour
# targetentities - Set the entity as the target for export
# Set Contour Mapping Type
# ContourMappingType can be one of the following:
# - ContourMappingType.None - None
# - ContourMappingType.FENode - Node (Averaged across body)
# - ContourMappingType.FEElement - Element (Unaveraged)
# - ContourMappingType.FEElementNode - Node (Unaveraged)
# - ContourMappingType.FEMaterial - Node (Averaged within material)
# - ContourMappingType.BeamGroup - Beam Group
# - ContourMappingType.Contact - Contact
# - ContourMappingType.ChainedSystem - Chained System
# - ContourMappingType.Usersubroutine - Usersubroutine
# characteristic_path - The path to the characteristic for which the contour will be created.
# component_path - The path to the component for which the contour will be created.
contour = dynamic_analysis.CreateContour(targetentities, ContourMappingType.FENode, "Displacement", "X")

# Set properties for the contour
contour.LegendColorScheme = ColorSchemeType.BLACK_TO_WHITE
contour.AutoRange = False
if contour.AutoRange == False:
    contour.Max = 4
    contour.Min = 1

contour.LegendFontColor = Colors.Red
contour.LogScale = True
contour.LegendVisibility = False
contour.Continuous = True
contour.Component = "Z"
contour.FullName = "FEBody_01_Contour_Z"
contour.MinMaxTargetType = ExtremalValueType.Part
contour.IsEnabled = False

# Get all created pages.
# This retrieves all pages created in the application.
pages = applicationHandler.GetPages()
for page in pages :
    page.Close()

# Close Document
applicationHandler.CloseDocument(result_file_path)

Properties

AutoRange

Gets or sets a value indicating whether the maximum and minimum range values are set automatically.

bool AutoRange { get; set; }

Property Value

bool

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve whether the maximum and minimum values of the range are set automatically.

Component

Gets or sets the contour component.

string Component { get; set; }

Property Value

string

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve the contour component. The available components can be referred to in the UI Contour ActionPanel.

ComponentList

Gets the list of available components.

IEnumerable<string> ComponentList { get; }

Property Value

IEnumerable<string>

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to retrieve the list of available components.

Continuous

Gets or sets a value indicating whether to allow gradation between colors.

bool Continuous { get; set; }

Property Value

bool

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve whether color gradation is allowed.

FullName

Gets or sets the full name of the contour.

string FullName { get; set; }

Property Value

string

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve the full name of the contour.

IsEnabled

Gets or sets a value indicating whether the contour is enabled.

bool IsEnabled { get; set; }

Property Value

bool

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve whether the contour is enabled.

LegendColorScheme

Gets or sets the color scheme of the legend.

ColorSchemeType LegendColorScheme { get; set; }

Property Value

ColorSchemeType

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

The LegendColorType property specifies the color scheme used for the Legend. This property allows you to customize the appearance of the Legend by selecting from a variety of predefined color schemes. The supported color schemes provide different visual styles to match the needs of various applications and user preferences. This property is included in the Legend category within the UI and is labeled as "Color" in the user interface. By setting this property, you can ensure that the Legend is displayed with the desired color scheme, enhancing its visual appeal and readability. This property allows you to set the color scheme of the legend. The available color schemes are:

LegendFontColor

Gets or sets the font color of the contour legend.

Color LegendFontColor { get; set; }

Property Value

Color

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve the font color of the contour legend.

LegendVisibility

Gets or sets a value indicating whether the legend is visible.

bool LegendVisibility { get; set; }

Property Value

bool

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve whether the legend is displayed or hidden.

LogScale

Gets or sets a value indicating whether to scale the values using a logarithmic function.

bool LogScale { get; set; }

Property Value

bool

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve whether the values are scaled using a logarithmic function.

Max

Gets or sets the maximum value of the contour.

double Max { get; set; }

Property Value

double

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve the maximum value of the contour when the Auto Range option is disabled.

Min

Gets or sets the minimum value of the contour.

double Min { get; set; }

Property Value

double

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

Use this property to specify or retrieve the minimum value of the contour when the Auto Range option is disabled.

MinMaxTargetType

Gets or sets the type of extremal values to be displayed.

ExtremalValueType MinMaxTargetType { get; set; }

Property Value

ExtremalValueType

Examples

For an example that includes this property, see the Interface IOperationsContourViewModel.

Remarks

This property allows you to change the visible state of extremes by selecting one of the predefined options. In the UI, this is represented as "Visible" in the "Min/Max Value" category. The available options are:

Connect with Ansys