Click or drag to resize
OSIsoft, LLC

AFDataPlotValues Method

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

Namespace:  OSIsoft.AF.Data
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version:
public AFValues PlotValues(
	AFTimeRange timeRange,
	int intervals,
	UOM desiredUOM


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 DefaultUOM property.

Return Value

Type: AFValues
Returns an AFValues collection with values that will produce the most accurate plot over the time range while minimizing the amount of data returned.
ArgumentOutOfRangeException The intervals must be greater than zero.
NotSupportedException The data reference does not support this method.

For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).

Note Note
For the PI Point Data Reference: The PI Data Archive imposes a limit on the maximum number of events that can be returned with a single call. As of PI 3.4.380, the default is set at 1.5M. This behavior can be changed on the server by editing the server's PITimeout table and adding or editing the value associated with the parameter ArcMaxCollect.

Note Notes to Callers
This method, property, or class is only available in the .NET 4 version of the SDK.

Security note Security Note
You must have ReadData security rights to read a data value.

Version Information


Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also
Enabling Operational Intelligence