Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Interface ZOSAPI::Analysis::Data::IAR_DataScatterPoints

Last update: 13.03.2026

Definition:

Members

Properties

Property Description

Definition:

String ZOSAPI.Analysis.Data.IAR_DataScatterPoints.Description

Return type: String

Property NumPoints

Definition:

uint ZOSAPI.Analysis.Data.IAR_DataScatterPoints.NumPoints

Return type: uint

Property Points

Definition:

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

Return type: IAR_ScatterPoint[]

Property XLabel

Definition:

String ZOSAPI.Analysis.Data.IAR_DataScatterPoints.XLabel

Return type: String

Property YLabel

Definition:

String ZOSAPI.Analysis.Data.IAR_DataScatterPoints.YLabel

Return type: String

Property ValueLabel

Definition:

String ZOSAPI.Analysis.Data.IAR_DataScatterPoints.ValueLabel

Return type: String

Public functions

Function GetPoint

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

Gets the specified point.

Parameters:

  • idx: The index (0 to NumPoints-1).

Returns:

Parameters:

  • int idx

Return type: IAR_ScatterPoint

Function FillPointValues

void ZOSAPI.Analysis.Data.IAR_DataScatterPoints.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.

Parameters:

  • fullSize: The full size (same as NumPoints).
  • xData: The x data.
  • yData: The y data.
  • valueData: The value data.

Parameters:

  • uint fullSize
  • [Out] double[] xData
  • [Out] double[] yData
  • [Out] double[] valueData

Return type: void

Function ConvertToRGB

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

Parameters:

Return type: IAR_DataScatterPointsRgb

Connect with Ansys