Click or drag to resize
Grid Solutions Framework

IGrafanaFunctionT Interface

Defines a common interface for Grafana functions for a specific data source value type.

Namespace: GrafanaAdapters.Functions
Assembly: GrafanaAdapters (in GrafanaAdapters.dll) Version: 2.4.181-beta
Syntax
public interface IGrafanaFunction<out T> : IGrafanaFunction
where T : struct, new(), IDataSourceValueType<T>
View Source

Type Parameters

T

The IGrafanaFunctionT type exposes the following members.

Properties
 NameDescription
Public propertyAliases Gets any defined aliases for the Grafana function.
(Inherited from IGrafanaFunction)
Public propertyAllowedGroupOperations Gets set of group operations that the Grafana function allows.
(Inherited from IGrafanaFunction)
Public propertyCategory Gets the category of the Grafana function, i.e., built-in or custom.
(Inherited from IGrafanaFunction)
Public propertyDataTypeIndex Gets the data source value type index associated with the Grafana function.
(Inherited from IGrafanaFunction)
Public propertyDescription Gets the description of the Grafana function.
(Inherited from IGrafanaFunction)
Public propertyInternalParameterCount Gets the number of internal parameters of the Grafana function.
(Inherited from IGrafanaFunction)
Public propertyIsSliceSeriesEquivalent 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 IGrafanaFunction)
Public propertyName Gets the name of the Grafana function.
(Inherited from IGrafanaFunction)
Public propertyOptionalParameterCount Gets the number of optional parameters of the Grafana function.
(Inherited from IGrafanaFunction)
Public propertyParameterDefinitions Gets the list of defined parameter definitions for the Grafana function.
(Inherited from IGrafanaFunction)
Public propertyPublishedGroupOperations Gets set of group operations that the Grafana function exposes publicly.
(Inherited from IGrafanaFunction)
Public propertyRequiredParameterCount Gets the number of required parameters, not including data source values expression, of the Grafana function.
(Inherited from IGrafanaFunction)
Public propertyResultIsSetTargetSeries Gets flag that determines if function result is target series for set-based group operations.
(Inherited from IGrafanaFunction)
Public propertyReturnType Gets the return type of the Grafana function, i.e., scalar or series.
(Inherited from IGrafanaFunction)
Top
Methods
 NameDescription
Public methodCheckAllowedGroupOperation Checks if function allows requested group operation against AllowedGroupOperations property.
(Inherited from IGrafanaFunction)
Public methodComputeAsync Executes the computation for the Grafana function.
Public methodComputeSetAsync Executes a custom set computation for the Grafana function.
Public methodComputeSliceAsync Executes a custom slice computation for the Grafana function.
Public methodFormatTargetName Gets a formatted target name for the Grafana function.
(Inherited from IGrafanaFunction)
Public methodParseParameters Executes custom parameter parsing for the Grafana function.
(Inherited from IGrafanaFunction)
Top
See Also