AggregationMethod Class

TIBCO Spotfire 7.6 API Reference

This class is used as the base class for aggregation methods.

Inheritance Hierarchy

System. Object
  Spotfire.Dxp.Data.Computations.DataMethod
    Spotfire.Dxp.Data.Computations.AggregationMethod
      Spotfire.Dxp.Application.Extension.CustomAggregationMethod

Namespace: Spotfire.Dxp.Data.Computations
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 25.11.10401.3615 (25.11.10401.3615)

Syntax

public abstract class AggregationMethod : DataMethod, 
	IPublicMethod, IAggregationMethod, IMetadataUsageProvider, IAbstraction

The AggregationMethod type exposes the following members.

Methods

	Name	Description
	CreateAccumulatorCore	Create an accumulator. A unique instance of the IAccumulator class should be returned for each call.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (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.)

Properties

	Name	Description
	Abstraction	Only applicable for aggregation methods. Returns true if the returned value from the method exists in the data; otherwise false. E.g., Sum is an abstraction but Max is not.
	Description	Description of what the method does. This is shown in the user interface to describe to the user how to use the method.
	DisplayName	Display name for method name. This is not the name used in expressions but the name shown in the UI.
	MethodCategory	The category is AggregationMethod. (Overrides DataMethod.MethodCategory.)
	MethodNamespace	Gets the namespace of the method. All method has to have a namespace. (Inherited from DataMethod.)
	Name	Gets the name of the method as used in expressions. (Inherited from DataMethod.)
	RequiredLicense	Gets the license that is needed for use of this data method. By default all methods have an AlwaysEnabled license. (Inherited from DataMethod.)
	Section	Which section should the method be part of, see the Sections class for predefined sections.

Remarks

This class cannot be inherited from, see the CustomAggregationMethod class for creating custom aggregation methods.

Version Information