Skip to main content

ZOS-API interface 2024 R2

ZOSAPI.Analysis.Data.IAR_DataScatterPoints Interface Reference

Last update: 17.07.2025

Public Member Functions

IAR_ScatterPoint 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]double[] valueData)
 Retries all scatter data at once, into the specified buffers.
 
IAR_DataScatterPointsRgb ConvertToRGB (IColorTranslator translator)
 

Properties

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

Member Function Documentation

◆ ConvertToRGB()

IAR_DataScatterPointsRgb ZOSAPI.Analysis.Data.IAR_DataScatterPoints.ConvertToRGB ( IColorTranslator  translator)

◆ FillPointValues()

void ZOSAPI.Analysis.Data.IAR_DataScatterPoints.FillPointValues ( uint  fullSize,
[Out] double[]  xData,
[Out] double[]  yData,
[Out] double[]  valueData 
)

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

Parameters
fullSizeThe full size (same as NumPoints).
xDataThe x data.
yDataThe y data.
valueDataThe value data.

◆ GetPoint()

IAR_ScatterPoint ZOSAPI.Analysis.Data.IAR_DataScatterPoints.GetPoint ( int  idx)

Gets the specified point.

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

Property Documentation

◆ Description

String ZOSAPI.Analysis.Data.IAR_DataScatterPoints.Description
get

◆ NumPoints

uint ZOSAPI.Analysis.Data.IAR_DataScatterPoints.NumPoints
get

◆ Points

IAR_ScatterPoint [] ZOSAPI.Analysis.Data.IAR_DataScatterPoints.Points
get

◆ ValueLabel

String ZOSAPI.Analysis.Data.IAR_DataScatterPoints.ValueLabel
get

◆ XLabel

String ZOSAPI.Analysis.Data.IAR_DataScatterPoints.XLabel
get

◆ YLabel

String ZOSAPI.Analysis.Data.IAR_DataScatterPoints.YLabel
get

Connect with Ansys