ZOSAPI.Analysis.IUserAnalysisData Interface Reference
Last update: 17.07.2025Properties and methods used to generate a User Analysis. This interface can be accessed via the IZOSAPI_Application interface. Note that this interface is only available when creating a User Analysis plugin application. More...
Public Member Functions | |
| IUser2DLineData | Make2DLinePlot (String PlotDescription, uint numValues, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In]double[] xValues) |
| Gets an interface used to configure a 2D line plot. | |
| IUser2DLineData | Make2DLinePlotSafe (String PlotDescription, [In]double[] xValues) |
| Gets an interface used to configure a 2D line plot. | |
| IUserGridData | MakeGridPlot (String PlotDescription) |
| Gets an interface used to configure a 2D grid plot. | |
| IUserGridRGBData | MakeGridRGBPlot (String PlotDescription) |
| Gets an interface used to configure a 2D RGB grid plot. | |
| IUserTextData | MakeText () |
| Gets an interface used to configure a simple text window. | |
Properties | |
| int | AnalysisNumber [get] |
| Gets the position of this user analysis in the primary IOpticalSystem. Note that this number may change when other analyses are opened or closed. | |
| UserAnalysisDataType | PlotType [get] |
| Gets the type of this plot window. | |
| string | WindowTitle [get, set] |
| string | FeatureDescription [get, set] |
| string[] | HeaderData [get, set] |
| bool | ShowLegend [get, set] |
| ISettingsData | UserSettings [get] |
| bool | RunAnalysisOnSettingsClosed [get, set] |
Detailed Description
Properties and methods used to generate a User Analysis. This interface can be accessed via the IZOSAPI_Application interface. Note that this interface is only available when creating a User Analysis plugin application.
Member Function Documentation
◆ Make2DLinePlot()
| IUser2DLineData ZOSAPI.Analysis.IUserAnalysisData.Make2DLinePlot | ( | String | PlotDescription, |
| uint | numValues, | ||
| [In] double[] | xValues | ||
| ) |
Gets an interface used to configure a 2D line plot.
- Parameters
-
PlotDescription The plot description. numValues The number of x-values. Note that multiple series are supported, but they all must share the same x data. xValues The x values.
- Returns
◆ Make2DLinePlotSafe()
| IUser2DLineData ZOSAPI.Analysis.IUserAnalysisData.Make2DLinePlotSafe | ( | String | PlotDescription, |
| [In] double[] | xValues | ||
| ) |
Gets an interface used to configure a 2D line plot.
- Parameters
-
PlotDescription The plot description. xValues The x values.
- Returns
◆ MakeGridPlot()
| IUserGridData ZOSAPI.Analysis.IUserAnalysisData.MakeGridPlot | ( | String | PlotDescription | ) |
Gets an interface used to configure a 2D grid plot.
- Parameters
-
PlotDescription The plot description.
- Returns
◆ MakeGridRGBPlot()
| IUserGridRGBData ZOSAPI.Analysis.IUserAnalysisData.MakeGridRGBPlot | ( | String | PlotDescription | ) |
Gets an interface used to configure a 2D RGB grid plot.
- Parameters
-
PlotDescription The plot description.
- Returns
◆ MakeText()
| IUserTextData ZOSAPI.Analysis.IUserAnalysisData.MakeText | ( | ) |
Gets an interface used to configure a simple text window.
- Returns
Property Documentation
◆ AnalysisNumber
|
get |
Gets the position of this user analysis in the primary IOpticalSystem. Note that this number may change when other analyses are opened or closed.
The analysis number.
◆ FeatureDescription
|
getset |
◆ HeaderData
|
getset |
◆ PlotType
|
get |
Gets the type of this plot window.
The type of the plot.
◆ RunAnalysisOnSettingsClosed
|
getset |
◆ ShowLegend
|
getset |
◆ UserSettings
|
get |
◆ WindowTitle
|
getset |
