Skip to main content

ZOS-API interface 2025 R2

ZOSAPI.Analysis.IUserGridData Interface Reference

Last update: 16.07.2025

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

Public Member Functions

void SetXDataDimensions (double xDataMin, double xDataMax)
 
void SetYDataDimensions (double yDataMin, double yDataMax)
 
void SetData (uint totalSize, uint numXValues, uint numYValues, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] Data)
 
void SetDataSafe (double[,] Data)
 

Properties

string PlotDescription [get]
 
string XLabel [get, set]
 
string YLabel [get, set]
 
string ValueLabel [get, set]
 
GridPlotType ShowAsType [get, set]
 
uint NumberOfXDataValues [get]
 
double XDataMin [get]
 
double XDataMax [get]
 
double DataDX [get]
 
uint NumberOfYDataValues [get]
 
double YDataMin [get]
 
double YDataMax [get]
 
double DataDY [get]
 
double XAxisMin [get, set]
 
bool XAxisMinAuto [get, set]
 
double XAxisMax [get, set]
 
bool XAxisMaxAuto [get, set]
 
bool XAxisSymmetric [get, set]
 
double YAxisMin [get, set]
 
bool YAxisMinAuto [get, set]
 
double YAxisMax [get, set]
 
bool YAxisMaxAuto [get, set]
 
bool YAxisSymmetric [get, set]
 
double ZAxisMin [get, set]
 
bool ZAxisMinAuto [get, set]
 
double ZAxisMax [get, set]
 
bool ZAxisMaxAuto [get, set]
 
bool ZAxisLog [get, set]
 
bool LogColorMap [get, set]
 
bool InterpolateLowResolutionContours [get, set]
 
double XYAspectRatio [get, set]
 

Detailed Description

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

Member Function Documentation

◆ SetData()

void ZOSAPI.Analysis.IUserGridData.SetData ( uint  totalSize,
uint  numXValues,
uint  numYValues,
[In] double[]  Data 
)

◆ SetDataSafe()

void ZOSAPI.Analysis.IUserGridData.SetDataSafe ( double  Data[,])

◆ SetXDataDimensions()

void ZOSAPI.Analysis.IUserGridData.SetXDataDimensions ( double  xDataMin,
double  xDataMax 
)

◆ SetYDataDimensions()

void ZOSAPI.Analysis.IUserGridData.SetYDataDimensions ( double  yDataMin,
double  yDataMax 
)

Property Documentation

◆ DataDX

double ZOSAPI.Analysis.IUserGridData.DataDX
get

◆ DataDY

double ZOSAPI.Analysis.IUserGridData.DataDY
get

◆ InterpolateLowResolutionContours

bool ZOSAPI.Analysis.IUserGridData.InterpolateLowResolutionContours
getset

◆ LogColorMap

bool ZOSAPI.Analysis.IUserGridData.LogColorMap
getset

◆ NumberOfXDataValues

uint ZOSAPI.Analysis.IUserGridData.NumberOfXDataValues
get

◆ NumberOfYDataValues

uint ZOSAPI.Analysis.IUserGridData.NumberOfYDataValues
get

◆ PlotDescription

string ZOSAPI.Analysis.IUserGridData.PlotDescription
get

◆ ShowAsType

GridPlotType ZOSAPI.Analysis.IUserGridData.ShowAsType
getset

◆ ValueLabel

string ZOSAPI.Analysis.IUserGridData.ValueLabel
getset

◆ XAxisMax

double ZOSAPI.Analysis.IUserGridData.XAxisMax
getset

◆ XAxisMaxAuto

bool ZOSAPI.Analysis.IUserGridData.XAxisMaxAuto
getset

◆ XAxisMin

double ZOSAPI.Analysis.IUserGridData.XAxisMin
getset

◆ XAxisMinAuto

bool ZOSAPI.Analysis.IUserGridData.XAxisMinAuto
getset

◆ XAxisSymmetric

bool ZOSAPI.Analysis.IUserGridData.XAxisSymmetric
getset

◆ XDataMax

double ZOSAPI.Analysis.IUserGridData.XDataMax
get

◆ XDataMin

double ZOSAPI.Analysis.IUserGridData.XDataMin
get

◆ XLabel

string ZOSAPI.Analysis.IUserGridData.XLabel
getset

◆ XYAspectRatio

double ZOSAPI.Analysis.IUserGridData.XYAspectRatio
getset

◆ YAxisMax

double ZOSAPI.Analysis.IUserGridData.YAxisMax
getset

◆ YAxisMaxAuto

bool ZOSAPI.Analysis.IUserGridData.YAxisMaxAuto
getset

◆ YAxisMin

double ZOSAPI.Analysis.IUserGridData.YAxisMin
getset

◆ YAxisMinAuto

bool ZOSAPI.Analysis.IUserGridData.YAxisMinAuto
getset

◆ YAxisSymmetric

bool ZOSAPI.Analysis.IUserGridData.YAxisSymmetric
getset

◆ YDataMax

double ZOSAPI.Analysis.IUserGridData.YDataMax
get

◆ YDataMin

double ZOSAPI.Analysis.IUserGridData.YDataMin
get

◆ YLabel

string ZOSAPI.Analysis.IUserGridData.YLabel
getset

◆ ZAxisLog

bool ZOSAPI.Analysis.IUserGridData.ZAxisLog
getset

◆ ZAxisMax

double ZOSAPI.Analysis.IUserGridData.ZAxisMax
getset

◆ ZAxisMaxAuto

bool ZOSAPI.Analysis.IUserGridData.ZAxisMaxAuto
getset

◆ ZAxisMin

double ZOSAPI.Analysis.IUserGridData.ZAxisMin
getset

◆ ZAxisMinAuto

bool ZOSAPI.Analysis.IUserGridData.ZAxisMinAuto
getset

Connect with Ansys