Xceed Logo
Shop
Xceed DataGrid for WPF v7.3 Documentation
[Root] / Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid.Stats Namespace / CorrelationCoefficientFunction Class
Example


In This Topic
    CorrelationCoefficientFunction Class
    In This Topic

    Class that represents the Correlation Coefficient statistical function, which represents the quantity that gives the quality of a least squares fitting to the original data. Also known as cross-correlation coefficient.

    Syntax
    'Declaration
 
<StatFunctionExporterAttribute(Xceed.Wpf.DataGrid.Export.ExcelExporter, Xceed.Wpf.DataGrid.Export.ExcelCorrelationCoefficientConverter)>
Public Class CorrelationCoefficientFunction 
   Inherits StatFunction
    'Usage
 
Dim instance As CorrelationCoefficientFunction
    [StatFunctionExporter(Xceed.Wpf.DataGrid.Export.ExcelExporter, Xceed.Wpf.DataGrid.Export.ExcelCorrelationCoefficientConverter)]
public class CorrelationCoefficientFunction : StatFunction
    Example
    <xcdg:CorrelationCoefficientFunction SourcePropertyName="FieldA,FieldB"
                                    ResultPropertyName="MyFunction1" />
    Inheritance Hierarchy

    System.Object
       Xceed.Wpf.DataGrid.Stats.StatFunction
          Xceed.Wpf.DataGrid.Stats.CorrelationCoefficientFunction

    Public Constructors
     NameDescription
    Public ConstructorCorrelationCoefficientFunction ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyResultPropertyNameGets or sets the unique, case-sensitive property name from which the result of the function can be retrieved. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Public PropertySourcePropertyNameGets or sets the name of the column whose values will be used to calculate the result. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Top
    Protected Properties
     NameDescription
    Protected Internal PropertyIsInitializedGets a value indicating whether Initialize method has been called, indicating that the types in which the values will be accumulated have been initialized. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Protected PropertyIsSealedGets a value indicating whether this instance is in an immutable state. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Protected Internal PropertyPrerequisiteFunctionsOverridden. Gets a list of the statistical functions whose results are required by the current statistical function in order to calculate its own result.  
    Protected Internal PropertyRequiresAccumulationGets a value indicating whether the statistical function needs to accumulate its own results. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodAccumulateOverridden. Accumulates the values required to calculate the result of the statistical function.  
    Protected MethodCheckSealedChecks whether this object is read-only and cannot be changed. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Protected Internal MethodGetEquivalenceKeyRetrieves a value that represents the statistical function's unique equivalence key. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Protected Internal MethodGetResultOverridden. Retrieves the result of the statistical function.  
    Protected MethodInitializeOverridden. Initializes the statistical function specifying the types of the columns specified by the SourcePropertyName property.  
    Protected Internal MethodInitializeFromInstanceInitializes the properties of the current instance of the same-type statistical function when a new instance of the same function needs to be created. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Protected Internal MethodInitializePrerequisitesOverridden. Initializes the prerequisite statistical functions defined by the PrerequisiteFunctions property.  
    Protected Internal MethodIsEquivalentRetrieves a value indicating whether a statistical function is the equivalent of the current statistical function such that both statistical functions will return the same result for the same set of values. (Inherited from Xceed.Wpf.DataGrid.Stats.StatFunction)
    Protected Internal MethodResetOverridden. Resets the statistical function to its original state.  
    Protected Internal MethodValidateOverridden. Validates the statistical function to ensure that it is able to calculate its result.  
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    CorrelationCoefficientFunction Members
    Xceed.Wpf.DataGrid.Stats Namespace

    Send Feedback