Skip to main content

ZOS-API interface 2025 R2 SP02

ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb Interface Reference

Last update: 19.09.2025

Public Member Functions

IAR_ScatterPointRgb GetPoint (int idx)
 Gets the specified point.
 
void FillPointValues (uint fullSize, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In][Out]double[] xData, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In][Out]double[] yData, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In][Out]float[] rData, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In][Out]float[] gData, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)][In][Out]float[] bData)
 Retries all scatter data at once, into the specified buffers.
 

Properties

String Description [get]
 
uint NumPoints [get]
 
IAR_ScatterPointRgb[] Points [get]
 
String XLabel [get]
 
String YLabel [get]
 
String ValueLabel [get]
 

Member Function Documentation

◆ FillPointValues()

void ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb.FillPointValues ( uint  fullSize,
[Out] double[]  xData,
[Out] double[]  yData,
[Out] float[]  rData,
[Out] float[]  gData,
[Out] float[]  bData 
)

Retries all scatter data at once, into the specified buffers.

Parameters
fullSizeThe full size (same as NumPoints).
xDataThe x data.
yDataThe y data.
rDataThe r data.
gDataThe g data.
bDataThe b data.

◆ GetPoint()

IAR_ScatterPointRgb ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb.GetPoint ( int  idx)

Gets the specified point.

Parameters
idxThe index (0 to NumPoints-1).
Returns

Property Documentation

◆ Description

String ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb.Description
get

◆ NumPoints

uint ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb.NumPoints
get

◆ Points

IAR_ScatterPointRgb [] ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb.Points
get

◆ ValueLabel

String ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb.ValueLabel
get

◆ XLabel

String ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb.XLabel
get

◆ YLabel

String ZOSAPI.Analysis.Data.IAR_DataScatterPointsRgb.YLabel
get

Connect with Ansys