Parameters Class

Represents a collection of mutable parameters.

Inheritance Hierarchy

SystemObject
GrafanaAdapters.FunctionsParameters

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

Syntax

C++

JavaScript

Copy

public class Parameters : IList<IMutableParameter>, 
	ICollection<IMutableParameter>, IEnumerable<IMutableParameter>, IEnumerable

Public Class Parameters
	Implements IList(Of IMutableParameter), ICollection(Of IMutableParameter), 
	IEnumerable(Of IMutableParameter), IEnumerable

public ref class Parameters : IList<IMutableParameter^>, 
	ICollection<IMutableParameter^>, IEnumerable<IMutableParameter^>, IEnumerable

type Parameters = 
    class
        interface IList<IMutableParameter>
        interface ICollection<IMutableParameter>
        interface IEnumerable<IMutableParameter>
        interface IEnumerable
    end

GrafanaAdapters.Functions.Parameters = function();

Type.createClass(
	'GrafanaAdapters.Functions.Parameters',
	null,
	IList`1,
	ICollection`1,
	IEnumerable`1,
	IEnumerable);

View Source

The Parameters type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of elements contained in the ICollectionT.
	IsReadOnly	Gets a value indicating whether the ICollectionT is read-only.
	ItemInt32	Gets or sets the element at the specified index.
	ItemString	Gets or sets the parameter with the specified name.
	ParsedCount	Gets or sets the number of parameters that have been parsed.

Top

Methods

	Name	Description
	Add	Adds an item to the ICollectionT.
	Clear	Removes all items from the ICollectionT.
	Contains	Determines whether the ICollectionT contains a specific value.
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IndexOf	Determines the index of a specific item in the IListT.
	Insert	Inserts an item to the IListT at the specified index.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Remove	Removes the first occurrence of a specific object from the ICollectionT.
	RemoveAt	Removes the IListT item at the specified index.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	Value(Int32)	Gets value of parameter at specified index, if the index is valid.
	Value(String)	Gets value of parameter with specified name, if name is found.
	ValueT(Int32)	Gets typed value of parameter at specified index, if the index is valid and the value can be cast as type.
	ValueT(String)	Gets typed value of parameter with specified name, if name is found and the value can be cast as type.

Top

Remarks

New instances of this class should be created by using the CreateParameters method.

This collection holds a distinct set of parameters generated for each function call, ensuring thread-safe operation when multiple threads execute the same function simultaneously. The ParameterDefinitions class outlines all possible parameters for a function, both required and optional, effectively determining its signature. Parameters in this collection represent the values extracted from the user-provided function expression and, when presented to a function, have already been validated and parsed by type. Additionally, the class provides access to the data source values expression; function implementations can call GetDataSourceValues(Parameters) to get current data source values. The parameters in this collection are mutable, implying ownership by the function, and can be safely modified as needed. To identify which optional parameters have been parsed and are available, refer to the ParsedCount property.

Reference

GrafanaAdapters.Functions Namespace