Skip to main content

ZOS-API interface 2024 R1

ZOSAPI.Analysis.IUserGridRGBData Interface Reference

Last update: 17.07.2025

Properties and methods for configuring a 2D rgb 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 SetDataRGB (uint fullSize, uint numXValues, uint numYValues, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] rData, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] gData, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] bData)
 
void SetDataRGBSafe ([In]double[,] rData, [In]double[,] gData, [In]double[,] bData)
 
void SetData (uint fullSize, uint numXValues, uint numYValues, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In]double[] rgbData)
 
void SetDataSafe ([In]double[,,] rgbData)
 

Properties

string PlotDescription [get]
 
string XLabel [get, set]
 
string YLabel [get, set]
 
string ValueLabel [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 XYAspectRatio [get, set]
 

Detailed Description

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

Member Function Documentation

◆ SetData()

void ZOSAPI.Analysis.IUserGridRGBData.SetData ( uint  fullSize,
uint  numXValues,
uint  numYValues,
[In] double[]  rgbData 
)

◆ SetDataRGB()

void ZOSAPI.Analysis.IUserGridRGBData.SetDataRGB ( uint  fullSize,
uint  numXValues,
uint  numYValues,
[In] double[]  rData,
[In] double[]  gData,
[In] double[]  bData 
)

◆ SetDataRGBSafe()

void ZOSAPI.Analysis.IUserGridRGBData.SetDataRGBSafe ( [In] double  rData[,],
[In] double  gData[,],
[In] double  bData[,] 
)

◆ SetDataSafe()

void ZOSAPI.Analysis.IUserGridRGBData.SetDataSafe ( [In] double  rgbData[,,])

◆ SetXDataDimensions()

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

◆ SetYDataDimensions()

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

Property Documentation

◆ DataDX

double ZOSAPI.Analysis.IUserGridRGBData.DataDX
get

◆ DataDY

double ZOSAPI.Analysis.IUserGridRGBData.DataDY
get

◆ NumberOfXDataValues

uint ZOSAPI.Analysis.IUserGridRGBData.NumberOfXDataValues
get

◆ NumberOfYDataValues

uint ZOSAPI.Analysis.IUserGridRGBData.NumberOfYDataValues
get

◆ PlotDescription

string ZOSAPI.Analysis.IUserGridRGBData.PlotDescription
get

◆ ValueLabel

string ZOSAPI.Analysis.IUserGridRGBData.ValueLabel
getset

◆ XAxisMax

double ZOSAPI.Analysis.IUserGridRGBData.XAxisMax
getset

◆ XAxisMaxAuto

bool ZOSAPI.Analysis.IUserGridRGBData.XAxisMaxAuto
getset

◆ XAxisMin

double ZOSAPI.Analysis.IUserGridRGBData.XAxisMin
getset

◆ XAxisMinAuto

bool ZOSAPI.Analysis.IUserGridRGBData.XAxisMinAuto
getset

◆ XAxisSymmetric

bool ZOSAPI.Analysis.IUserGridRGBData.XAxisSymmetric
getset

◆ XDataMax

double ZOSAPI.Analysis.IUserGridRGBData.XDataMax
get

◆ XDataMin

double ZOSAPI.Analysis.IUserGridRGBData.XDataMin
get

◆ XLabel

string ZOSAPI.Analysis.IUserGridRGBData.XLabel
getset

◆ XYAspectRatio

double ZOSAPI.Analysis.IUserGridRGBData.XYAspectRatio
getset

◆ YAxisMax

double ZOSAPI.Analysis.IUserGridRGBData.YAxisMax
getset

◆ YAxisMaxAuto

bool ZOSAPI.Analysis.IUserGridRGBData.YAxisMaxAuto
getset

◆ YAxisMin

double ZOSAPI.Analysis.IUserGridRGBData.YAxisMin
getset

◆ YAxisMinAuto

bool ZOSAPI.Analysis.IUserGridRGBData.YAxisMinAuto
getset

◆ YAxisSymmetric

bool ZOSAPI.Analysis.IUserGridRGBData.YAxisSymmetric
getset

◆ YDataMax

double ZOSAPI.Analysis.IUserGridRGBData.YDataMax
get

◆ YDataMin

double ZOSAPI.Analysis.IUserGridRGBData.YDataMin
get

◆ YLabel

string ZOSAPI.Analysis.IUserGridRGBData.YLabel
getset

Connect with Ansys