'Declaration Public Class ModeFunction Inherits StatFunction
'Usage Dim instance As ModeFunction
public class ModeFunction : StatFunction
Xceed Toolkit Plus for WPF v5.1 Documentation
Class that represents the Mode statistical function, which is the value that has the largest number of observations, namely the most frequent value or values. The mode is not necessarily unique, unlike the arithmetic mean.
The Mode function is not supported when using a remote data source.
'Declaration Public Class ModeFunction Inherits StatFunction
'Usage Dim instance As ModeFunction
public class ModeFunction : StatFunction
By default, the result will be unimodal. To enable multimodal results, the AllowMultimodal property must be set to true.
In the case where AllowMultimodal is set to true, a MultimodalResultConverter must be used to display the result, which will always be an array, even if the result is not multimodal. If AllowMultiModal is set to false and a multimodal result occurs, only one of the mode will be returned. Ex. : [1, 2, 2, 6, 6] is bimodal (2 and 6) and the function will return either 2 or 6. a null reference (Nothing in Visual Basic) will be returned if all the items in the set are unique.
null (Nothing in Visual Basic) and DBNull values will be ignored.
System.Object
Xceed.Wpf.Data.Stats.StatFunction
Xceed.Wpf.Data.Stats.ModeFunction
| Name | Description | |
|---|---|---|
 | ModeFunction Constructor | Overloaded. Initializes a new instance of the ModeFunction class. |
| Name | Description | |
|---|---|---|
 | AllowMultimodal | Gets or sets a value indicating whether the result of the statistical function can be multimodal. |
| ResultPropertyName | Gets or sets the unique, case-sensitive property name from which the result of the statistical function can be retrieved. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| SourcePropertyName | Gets or sets the name of the column whose values will be used to calculate the result of the statistical function. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| Name | Description | |
|---|---|---|
 | IsInitialized | Gets a value indicating whether the Initialize method has been called, indicating that the types in which the values will be accumulated have been initialized. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
 | IsSealed | Gets a value indicating whether an instance of a statistical function is in an immutable state. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| PrerequisiteFunctions | Gets a list of the statistical functions whose results are required by the current function in order to calculate its own result. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| RequiresAccumulation | Gets a value indicating whether the statistical function needs to accumulate its own results. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| Name | Description | |
|---|---|---|
 | GetSourcePropertyNames | (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| Name | Description | |
|---|---|---|
 | Accumulate | Overridden. Accumulates the values required to calculate the result of the statistical function. |
 | CheckSealed | Checks whether an instance of a statistical function is in an immutable state. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| GetEquivalenceKey | Overridden. Retrieves a value that represents the statistical function's unique equivalence key. |
| GetResult | Overridden. Retrieves the result of the statistical function. |
| Initialize | Initializes the statistical function specifying the types in which the values will be accumulated. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| InitializeFromInstance | Overridden. Initializes the properties of the current instance of the same-type statistical function when a new instance of the same function needs to be created. |
| InitializePrerequisites | Initializes the prerequisite statistical functions defined by the PrerequisiteFunctions property. (Inherited from Xceed.Wpf.Data.Stats.StatFunction) |
| IsEquivalent | Overridden. Retrieves a value indicating whether a statistical function is the equivalent of the current function such that both will return the same result for the same set of values. |
| Reset | Overridden. Resets the statistical function to its original state. |
| Validate | Overridden. Validates the statistical function to ensure that it is able to calculate its result. |
Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2