A newer version of this page is available. Switch to the current version.

ChartControlSettings.RegisterSummaryFunction(String, String, Nullable<ScaleType>, Int32, SummaryFunctionArgumentDescription[], SummaryFunction) Method

Registers the custom summary function with the specified settings.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v18.2.dll

Declaration

public void RegisterSummaryFunction(
    string name,
    string displayName,
    ScaleType? resultScaleType,
    int resultDimension,
    SummaryFunctionArgumentDescription[] argumentDescriptions,
    SummaryFunction function
)
Public Sub RegisterSummaryFunction(
    name As String,
    displayName As String,
    resultScaleType As ScaleType?,
    resultDimension As Integer,
    argumentDescriptions As SummaryFunctionArgumentDescription(),
    function As SummaryFunction
)

Parameters

Name Type Description
name String

A String value containing the function's name.

displayName String

A String value containing the function's display name, which is used for localization purposes.

resultScaleType Nullable<ScaleType>

A ScaleType enumeration value representing the type of the function's result.

resultDimension Int32

An integer value representing the dimension of the resulting series point's values.

argumentDescriptions SummaryFunctionArgumentDescription[]

An array of SummaryFunctionArgumentDescription objects containing argument descriptions.

function SummaryFunction

A SummaryFunction delegate to be registered.

Remarks

The RegisterSummaryFunction method is intended to register custom summary functions within a chart control. To unregister a specific summary function, the ChartControl.UnregisterSummaryFunction method should be called. Also, you may remove all custom summary functions from the chart, and add all default functions to it by calling the ChartControl.ResetSummaryFunctions method.

See Also