ZOS-API interface 2025 R2

ZOSAPI.Analysis.IUser2DLineData Interface Reference

Last update: 16.07.2025

Properties and methods for configuring a 2D line User Analysis plot. This interface can be accessed via the IUserAnalysisData interface. More...

Public Member Functions

void AddSeries (string seriesName, ZemaxColor seriesColor, uint numberOfYValues, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=2)][In]double[] yValues)
 
void AddSeriesSafe (string seriesName, ZemaxColor seriesColor, double[] yValues)
 

Properties

string PlotDescription [get]
 
string XLabel [get, set]
 
string YLabel [get, set]
 
uint NumberOfXValues [get]
 
uint NumberOfYValues [get]
 
uint NumberOfSeries [get]
 
double XAxisMin [get, set]
 
bool XAxisMinAuto [get, set]
 
double XAxisMax [get, set]
 
bool XAxisMaxAuto [get, set]
 
bool XAxisLog [get, set]
 
bool XAxisReversed [get, set]
 
bool XAxisSymmetric [get, set]
 
double YAxisMin [get, set]
 
bool YAxisMinAuto [get, set]
 
double YAxisMax [get, set]
 
bool YAxisMaxAuto [get, set]
 
bool YAxisLog [get, set]
 
bool YAxisReversed [get, set]
 
bool YAxisSymmetric [get, set]
 

Detailed Description

Properties and methods for configuring a 2D line User Analysis plot. This interface can be accessed via the IUserAnalysisData interface.

Member Function Documentation

◆ AddSeries()

void ZOSAPI.Analysis.IUser2DLineData.AddSeries ( string  seriesName,
ZemaxColor  seriesColor,
uint  numberOfYValues,
[In] double[]  yValues 
)

◆ AddSeriesSafe()

void ZOSAPI.Analysis.IUser2DLineData.AddSeriesSafe ( string  seriesName,
ZemaxColor  seriesColor,
double[]  yValues 
)

Property Documentation

◆ NumberOfSeries

uint ZOSAPI.Analysis.IUser2DLineData.NumberOfSeries
get

◆ NumberOfXValues

uint ZOSAPI.Analysis.IUser2DLineData.NumberOfXValues
get

◆ NumberOfYValues

uint ZOSAPI.Analysis.IUser2DLineData.NumberOfYValues
get

◆ PlotDescription

string ZOSAPI.Analysis.IUser2DLineData.PlotDescription
get

◆ XAxisLog

bool ZOSAPI.Analysis.IUser2DLineData.XAxisLog
getset

◆ XAxisMax

double ZOSAPI.Analysis.IUser2DLineData.XAxisMax
getset

◆ XAxisMaxAuto

bool ZOSAPI.Analysis.IUser2DLineData.XAxisMaxAuto
getset

◆ XAxisMin

double ZOSAPI.Analysis.IUser2DLineData.XAxisMin
getset

◆ XAxisMinAuto

bool ZOSAPI.Analysis.IUser2DLineData.XAxisMinAuto
getset

◆ XAxisReversed

bool ZOSAPI.Analysis.IUser2DLineData.XAxisReversed
getset

◆ XAxisSymmetric

bool ZOSAPI.Analysis.IUser2DLineData.XAxisSymmetric
getset

◆ XLabel

string ZOSAPI.Analysis.IUser2DLineData.XLabel
getset

◆ YAxisLog

bool ZOSAPI.Analysis.IUser2DLineData.YAxisLog
getset

◆ YAxisMax

double ZOSAPI.Analysis.IUser2DLineData.YAxisMax
getset

◆ YAxisMaxAuto

bool ZOSAPI.Analysis.IUser2DLineData.YAxisMaxAuto
getset

◆ YAxisMin

double ZOSAPI.Analysis.IUser2DLineData.YAxisMin
getset

◆ YAxisMinAuto

bool ZOSAPI.Analysis.IUser2DLineData.YAxisMinAuto
getset

◆ YAxisReversed

bool ZOSAPI.Analysis.IUser2DLineData.YAxisReversed
getset

◆ YAxisSymmetric

bool ZOSAPI.Analysis.IUser2DLineData.YAxisSymmetric
getset

◆ YLabel

string ZOSAPI.Analysis.IUser2DLineData.YLabel
getset

Connect with Ansys