ClampTComputeMeasurementValue Class

Returns a series of values that represent each of the values in the source series clamped to the inclusive range of min and max. min is lower bound of the result and max is the upper bound of the result.

Inheritance Hierarchy

SystemObject
  GrafanaAdapters.FunctionsGrafanaFunctionBaseMeasurementValue
    GrafanaAdapters.Functions.BuiltInClampMeasurementValue
      GrafanaAdapters.Functions.BuiltInClampTComputeMeasurementValue

Namespace: GrafanaAdapters.Functions.BuiltIn
Assembly: GrafanaAdapters (in GrafanaAdapters.dll) Version: 2.4.207-beta

Syntax

C++

JavaScript

Copy

public class ComputeMeasurementValue : Clamp<MeasurementValue>

Public Class ComputeMeasurementValue
	Inherits Clamp(Of MeasurementValue)

public ref class ComputeMeasurementValue : public Clamp<MeasurementValue>

type ComputeMeasurementValue = 
    class
        inherit Clamp<MeasurementValue>
    end

GrafanaAdapters.Functions.BuiltIn.ComputeMeasurementValue = function();

Type.createClass(
	'GrafanaAdapters.Functions.BuiltIn.ComputeMeasurementValue',
	GrafanaAdapters.Functions.BuiltIn.Clamp`1);

View Source

The ClampTComputeMeasurementValue type exposes the following members.

Constructors

	Name	Description
	ClampTComputeMeasurementValue	Initializes a new instance of the ClampTComputeMeasurementValue class

Top

Properties

	Name	Description
	Aliases	Gets any defined aliases for the Grafana function. (Inherited from ClampT)
	AllowedGroupOperations	Gets set of group operations that the Grafana function allows. (Inherited from GrafanaFunctionBaseT)
	Category	Gets the category of the Grafana function, i.e., built-in or custom. (Inherited from GrafanaFunctionBaseT)
	DataTypeIndex	Gets the data source value type index associated with the Grafana function. (Inherited from GrafanaFunctionBaseT)
	Description	Gets the description of the Grafana function. (Inherited from ClampT)
	InternalParameterCount	Gets the number of internal parameters of the Grafana function. (Inherited from GrafanaFunctionBaseT)
	IsSliceSeriesEquivalent	Gets or sets a flag indicating whether the function behaves equivalently when processed as a series or as a slice. Value defaults to true for functions that return a series of values, i.e., the return type is Series, and the AllowedGroupOperations includes the flag for Slice operations; otherwise, value defaults to false when the return type is a scalar value, i.e., Scalar, or the AllowedGroupOperations does not include the flag for Slice operations. (Inherited from GrafanaFunctionBaseT)
	Name	Gets the name of the Grafana function. (Inherited from ClampT)
	OptionalParameterCount	Gets the number of optional parameters of the Grafana function. (Inherited from GrafanaFunctionBaseT)
	ParameterDefinitions	Gets the list of defined parameter definitions for the Grafana function. (Inherited from ClampT)
	PublishedGroupOperations	Gets set of group operations that the Grafana function exposes publicly. (Inherited from GrafanaFunctionBaseT)
	RequiredParameterCount	Gets the number of required parameters, not including data source values expression, of the Grafana function. (Inherited from GrafanaFunctionBaseT)
	ResultIsSetTargetSeries	Gets flag that determines if function result is target series for set-based group operations. (Inherited from GrafanaFunctionBaseT)
	ReturnType	Gets the return type of the Grafana function, i.e., scalar or series. (Inherited from ClampT)

Top

Methods

	Name	Description
	CheckAllowedGroupOperation	Checks if function allows requested group operation against AllowedGroupOperations property. (Inherited from GrafanaFunctionBaseT)
	ComputeAsync	Executes the computation for the Grafana function. (Inherited from ClampT)
	ComputeSetAsync	Executes a custom set computation for the Grafana function. (Inherited from GrafanaFunctionBaseT)
	ComputeSliceAsync	Executes a custom slice computation for the Grafana function. (Inherited from GrafanaFunctionBaseT)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExecuteFunction	Executes specified function against data source values enumeration using provided parameters. (Inherited from GrafanaFunctionBaseT)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	FormatTargetName	Gets a formatted target name for the Grafana function. (Inherited from GrafanaFunctionBaseT)
	GetDataSourceValues	Gets data source values enumeration found in the provided parameters. (Inherited from GrafanaFunctionBaseT)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParseParameters	Executes custom parameter parsing for the Grafana function. (Inherited from GrafanaFunctionBaseT)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

Signature: Clap(min, max, expression)
Returns: Series of values.
Example: Clamp(49.95, 50.05, FILTER ActiveMeasurements WHERE SignalType='FREQ')
Variants: Clamp, Limit
Execution: Deferred enumeration.

Reference

GrafanaAdapters.Functions.BuiltIn Namespace