Click or drag to resize
Grid Solutions Framework

IGrafanaFunction Interface
Defines a common interface for Grafana functions.

Namespace: GrafanaAdapters.Functions
Assembly: GrafanaAdapters (in GrafanaAdapters.dll) Version: 2.4.218-beta
Syntax
Copy
public interface IGrafanaFunction
View Source

The IGrafanaFunction type exposes the following members.

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