ZOSAPI.Analysis.IUserGridRGBData Interface Reference
Last update: 17.07.2025Properties 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
|
get |
◆ DataDY
|
get |
◆ NumberOfXDataValues
|
get |
◆ NumberOfYDataValues
|
get |
◆ PlotDescription
|
get |
◆ ValueLabel
|
getset |
◆ XAxisMax
|
getset |
◆ XAxisMaxAuto
|
getset |
◆ XAxisMin
|
getset |
◆ XAxisMinAuto
|
getset |
◆ XAxisSymmetric
|
getset |
◆ XDataMax
|
get |
◆ XDataMin
|
get |
◆ XLabel
|
getset |
◆ XYAspectRatio
|
getset |
◆ YAxisMax
|
getset |
◆ YAxisMaxAuto
|
getset |
◆ YAxisMin
|
getset |
◆ YAxisMinAuto
|
getset |
◆ YAxisSymmetric
|
getset |
◆ YDataMax
|
get |
◆ YDataMin
|
get |
◆ YLabel
|
getset |