Interface IOperationsLineDataSeriesViewModel
Last update: 16.07.2025Namespace: VM.Operations.Post.Interfaces
Assembly: VM.Operations.Post.dll
Represents a view model for the line data series.
public interface IOperationsLineDataSeriesViewModel : IOperationsLineDataSeriesViewModelBase, ILineDataSeriesViewModelBase, IHasSourceViewModel, IViewModel, IObservableObject, IDisposableObject, IEnabled, IExpanded, ISelected, IVisible, IThicknessProperty, IOperationsBase
Implements
IOperationsLineDataSeriesViewModelBase, ILineDataSeriesViewModelBase, IHasSourceViewModel, IViewModel, IObservableObject, IDisposableObject, IEnabled, IExpanded, ISelected, IVisible, IThicknessProperty, IOperationsBase
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.
# IOperationsLineDataSeriesViewModel.py
import sys
current_dir = __file__.rsplit('\\', 1)[0]
external_modules_path = current_dir + '\\..\\..\\Modules'
sys.path.append(external_modules_path)
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
applicationHandler.AddDocument(filepaths)
# Get Page
page = applicationHandler.GetActivePage()
# Create PlotView
chartView = page.CreateChart("Chart")
# Documentation Example
# Set array about combination of characteristic and component
curvePaths = List[str]()
curvePaths.Add(r'Displacement/Magnitude')
# Set a Curve Parameter
parameters = PlotParameters()
parameters.Paths = curvePaths
parameters.Target = "Crank"
# Add Curves (FilePath, Curve Parameter)
# FilePath - The path of the result to access.
# parameters - The class used as a parameter of the AddCurve function.
# The instance of the curve.
curves = chartView.AddCurves(result_file_path, parameters)
curves[0].SourceX = curves[0].CreateLineDataSeries(result_file_path, r'Crank', r'Displacement',r'Y',r'Inertia')
curves[0].SourceY = curves[0].CreateLineDataSeries(result_file_path, r'Crank', r'Displacement',r'Y',r'Inertia')
# Close the Pages
page.Close()
# Close the Document
applicationHandler.CloseDocument(result_file_path)
Properties
SourceX
Gets or sets the source X instance of the series.
ILineDataSeriesAxisViewModel SourceX { get; set; }
Property Value
ILineDataSeriesAxisViewModel
Examples
For an example that includes this property, see the Interface IOperationsLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the source X instance of the series.
SourceY
Gets or sets the source Y instance of the series.
ILineDataSeriesAxisViewModel SourceY { get; set; }
Property Value
ILineDataSeriesAxisViewModel
Examples
For an example that includes this property, see the Interface IOperationsLineDataSeriesViewModel.
Remarks
Use this property to specify or retrieve the source Y instance of the series.
Methods
CreateLineDataSeries(string, string, string, string, string)
Creates information of Axis for data series. It is used for modifying information of axis for data series.
IOperationsLineDataSeriesAxisViewModel CreateLineDataSeries(string filepath, string fullTarget, string characteristic, string component, string csys)
Parameters
filepath string
The path of the result to access.
fullTarget string
The name of the target entity.
characteristic string
The name of the characteristic.
component string
The name of the component.
csys string
The name of the coordinate system.
Returns
IOperationsLineDataSeriesAxisViewModel
An instance of
Examples
For an example that includes this property, see the Interface IOperationsLineDataSeriesViewModel.
Remarks
This method creates axis information for a data series, allowing for the modification of axis information for the data series.
CreateLineDataSeries(string, string, string, string, string, string, string)
Creates information of Axis for data series. It is used for modifying information of axis for data series.
[Obsolete("This method is considered outdated and its use is discouraged.", true)]
IOperationsLineDataSeriesAxisViewModel CreateLineDataSeries(string filepath, string parent, string fullTarget, string subTarget, string characteristic, string component, string csys)
Parameters
filepath string
The path of the result to access.
parent string
The parent entity. If the entity does not have a parent, it should be
fullTarget string
The name of the target entity.
subTarget string
The name of the child item such as node, element, or marker. If there is no child item, it should be
characteristic string
The name of the characteristic.
component string
The name of the component.
csys string
The name of the coordinate system.
Returns
IOperationsLineDataSeriesAxisViewModel
An instance of
Examples
For an example that includes this property, see the Interface IOperationsLineDataSeriesViewModel.
Remarks
This method creates axis information for a data series, allowing for the modification of axis information for the data series.