Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).
OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 22.214.171.1240
public Task<AFValues> PlotValuesAsync(
CancellationToken cancellationToken = null
Public Function PlotValuesAsync (
timeRange As AFTimeRange,
intervals As Integer,
desiredUOM As UOM,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of AFValues)
Dim instance As AFData
Dim timeRange As AFTimeRange
Dim intervals As Integer
Dim desiredUOM As UOM
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValues)
returnValue = instance.PlotValuesAsync(timeRange,
intervals, desiredUOM, cancellationToken)
CancellationToken cancellationToken = nullptr
member PlotValuesAsync :
timeRange : AFTimeRange *
intervals : int *
desiredUOM : UOM *
?cancellationToken : CancellationToken
let _cancellationToken = defaultArg cancellationToken null
- Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range for the plot values request.
- Type: SystemInt32
The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend.
- Type: OSIsoft.AF.UnitsOfMeasureUOM
The desired unit of measure for the returned value. If , then
the value is returned in the unit of measure specified by the associated attribute's
- cancellationToken (Optional)
- 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.
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.
Asynchronous methods throw AggregateException on failure which will contain one or
more exceptions containing the failure.
| Notes to Callers|
This method, property, or class is only available in the .NET 4 version of the SDK.
| Security Note|
You must have ReadData security rights to
read a data value.
| Notes to Callers|
This call might use a background task to complete some of its work. See the
for some matters to consider when execution transitions to another thread.
Asynchronous data calls in AF SDK attempt to do as much work as possible asynchronously. If no work can be done
asynchronously, then the SupportedDataMethods will report that asynchronous calls are not supported.
If an attribute uses a Formula or other calculated data reference has any input that supports asynchronous calls, then the attribute
will support asynchronous calls. When making an asynchronous data call, input data will be acquired asynchronously when possible
or synchronously otherwise. Data calls that require partitioning across versions will always fall back to synchronous calls.
Impersonation of AF SDK asynchronous calls relies on the .NET framework's built-in support for flowing execution context across
asynchronous points. When making these calls while impersonating, the thread or runtime must be configured to propagate the
impersonation across these asynchronous points (see the SecurityContext documentation for details).
AFSDKSupported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8