AF SDK Reference

AFDataReference.PlotValuesAsync Method

Save PDF

AFDataReference.PlotValuesAsync Method

Save PDF

Last UpdatedNov 18, 2025
4 minute read

Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).

Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public virtual Task<AFValues> PlotValuesAsync(
	AFTimeRange timeRange,
	int intervals,
	AFAttributeList inputAttributes,
	AFValues[] inputValues,
	List<AFTime> inputTimes,
	CancellationToken cancellationToken
)

Public Overridable Function PlotValuesAsync ( 
	timeRange As AFTimeRange,
	intervals As Integer,
	inputAttributes As AFAttributeList,
	inputValues As AFValues(),
	inputTimes As List(Of AFTime),
	cancellationToken As CancellationToken
) As Task(Of AFValues)

Dim instance As AFDataReference
Dim timeRange As AFTimeRange
Dim intervals As Integer
Dim inputAttributes As AFAttributeList
Dim inputValues As AFValues()
Dim inputTimes As List(Of AFTime)
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValues)

returnValue = instance.PlotValuesAsync(timeRange, 
	intervals, inputAttributes, inputValues, 
	inputTimes, cancellationToken)

public:
virtual Task<AFValues^>^ PlotValuesAsync(
	AFTimeRange timeRange, 
	int intervals, 
	AFAttributeList^ inputAttributes, 
	array<AFValues^>^ inputValues, 
	List<AFTime>^ inputTimes, 
	CancellationToken cancellationToken
)

abstract PlotValuesAsync : 
        timeRange : AFTimeRange * 
        intervals : int * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues[] * 
        inputTimes : List<AFTime> * 
        cancellationToken : CancellationToken -> Task<AFValues> 
override PlotValuesAsync : 
        timeRange : AFTimeRange * 
        intervals : int * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues[] * 
        inputTimes : List<AFTime> * 
        cancellationToken : CancellationToken -> Task<AFValues>

Parameters

timeRange: Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for the plot values request.
intervals: Type: SystemInt32
The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend.
inputAttributes: Type: OSIsoft.AF.AssetAFAttributeList
The input attributes as previously specified by the data reference in the GetInputs(Object) call. The index of the values will match the index of the corresponding attribute previously returned. These values must be converted to the appropriate UOM required by this data reference.
inputValues: Type: OSIsoft.AF.AssetAFValues
The input values are supplied to the data reference based on the attributes returned in the GetInputs(Object) call. The index of the values will match the index of the corresponding attribute previously returned. These values must be converted to the appropriate UOM required by this data reference.
inputTimes: Type: System.Collections.GenericListAFTime
The list of AFTime timestamps at which each input attribute was evaluated.
cancellationToken: Type: System.ThreadingCancellationToken
A cancellation token used to abort processing before completion. Passing the default CancellationToken.None will run to completion or until the PIConnectionInfo.OperationTimeOut period elapses.

Return Value

Type: TaskAFValues
Returns a task whose result is an AFValues collection with values that will produce the most accurate plot over the time range while minimizing the amount of data returned.

Exceptions

Exception	Condition
AggregateException	Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure.

Remarks

Notes to Callers
This call might use a background task to complete some of its work. See the Threading Overview for some matters to consider when execution transitions to another thread.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8

AF SDK Reference