Click or drag to resize
Grid Solutions Framework

GrafanaFunctionBaseT Class

Represents the base functionality for any Grafana function.
Inheritance Hierarchy
SystemObject
  GrafanaAdapters.FunctionsGrafanaFunctionBaseT
    More

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

Type Parameters

T

The GrafanaFunctionBaseT type exposes the following members.

Constructors
 NameDescription
Protected methodGrafanaFunctionBaseTInitializes a new instance of the GrafanaFunctionBaseT class
Top
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 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 methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodExecuteFunction Executes specified function against data source values enumeration using provided parameters.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFormatTargetName Gets a formatted target name for the Grafana function.
Protected methodGetDataSourceValues Gets data source values enumeration found in the provided parameters.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParseParameters Executes custom parameter parsing for the Grafana function.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also
Inheritance Hierarchy
SystemObject
  GrafanaAdapters.FunctionsGrafanaFunctionBaseT
    GrafanaAdapters.Functions.BuiltInAbsoluteValueT
    GrafanaAdapters.Functions.BuiltInAverageT
    GrafanaAdapters.Functions.BuiltInBottomT
    GrafanaAdapters.Functions.BuiltInCeilingT
    GrafanaAdapters.Functions.BuiltInClampT
    GrafanaAdapters.Functions.BuiltInCountT
    GrafanaAdapters.Functions.BuiltInDerivativeT
    GrafanaAdapters.Functions.BuiltInDifferenceT
    GrafanaAdapters.Functions.BuiltInDistinctT
    GrafanaAdapters.Functions.BuiltInEvaluateT
    GrafanaAdapters.Functions.BuiltInExcludeRangeT
    GrafanaAdapters.Functions.BuiltInFilterNaNT
    GrafanaAdapters.Functions.BuiltInFirstT
    GrafanaAdapters.Functions.BuiltInFloorT
    GrafanaAdapters.Functions.BuiltInIncludeRangeT
    GrafanaAdapters.Functions.BuiltInIntervalT
    GrafanaAdapters.Functions.BuiltInLabelT
    GrafanaAdapters.Functions.BuiltInLastT
    GrafanaAdapters.Functions.BuiltInMaximumT
    GrafanaAdapters.Functions.BuiltInMedianT
    GrafanaAdapters.Functions.BuiltInMinimumT
    GrafanaAdapters.Functions.BuiltInModeT
    GrafanaAdapters.Functions.BuiltInModuloT
    GrafanaAdapters.Functions.BuiltInMovingAverageT
    GrafanaAdapters.Functions.BuiltInPercentileT
    GrafanaAdapters.Functions.BuiltInPowT
    GrafanaAdapters.Functions.BuiltInRandomT
    GrafanaAdapters.Functions.BuiltInRangeT
    GrafanaAdapters.Functions.BuiltInReferenceT
    GrafanaAdapters.Functions.BuiltInRollingAverageT
    GrafanaAdapters.Functions.BuiltInRoundT
    GrafanaAdapters.Functions.BuiltInScaleT
    GrafanaAdapters.Functions.BuiltInShiftT
    GrafanaAdapters.Functions.BuiltInSqrtT
    GrafanaAdapters.Functions.BuiltInStandardDeviationT
    GrafanaAdapters.Functions.BuiltInSwitchT
    GrafanaAdapters.Functions.BuiltInTimeDifferenceT
    GrafanaAdapters.Functions.BuiltInTimeIntegrationT
    GrafanaAdapters.Functions.BuiltInTopT
    GrafanaAdapters.Functions.BuiltInTotalT
    GrafanaAdapters.Functions.BuiltInTruncateT
    GrafanaAdapters.Functions.BuiltInUnwrapAngleT
    GrafanaAdapters.Functions.BuiltInWrapAngleT