IndicatorFactory.Register<T>(String) Method

Add a custom indicator type to the indicator types in the Trend Indicators dialog.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v23.2.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public static void Register<T>(
    string displayName
)
    where T : ChartIndicatorBase, new()

VB.NET

Public Shared Sub Register(Of T As {ChartIndicatorBase, New})(
    displayName As String
)

Parameters

Name	Type	Description
displayName	String	The name of the custom indicator type that is displayed in the Trend Indicators dialog.

Type Parameters

Name	Description
T	A custom indicator type that is the ChartCustomIndicator descendant.

Remarks

The following example shows how to add the MovingIndicator type in IndicatorFactory to make this type available as an indicator type in the Trend Indicators editor. Call the Register method in your application before you save and load a dashboard to serialize and deserialize the indicator within the dashboard XML.

C#

using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using System.Windows.Forms;
using DevExpress.DashboardCommon;
using DevExpress.DashboardCommon.ViewerData;

namespace WinForm {
    public partial class FormDesigner : Form {
        public FormDesigner() {
            try {
                IndicatorFactory.Register<MovingIndicator>("Moving average");
            } catch(Exception e) {
                MessageBox.Show(e.Message);
            }
            InitializeComponent();
            var dashboard = new Dashboard1();
            ChartDashboardItem chartItem = dashboard.Items.First(x => x.ComponentName == "chartDashboardItem1") as ChartDashboardItem;
            MovingIndicator trendLine = new MovingIndicator() {
                Name = "MovingLine1",
                Value = "DataItem1",
                ValueLevel = DevExpress.XtraCharts.ValueLevel.Value,
                Color = Color.Orange,
                LegendText = "Moving Average"
            };
            chartItem.Indicators.Add(trendLine);
            dashboardDesigner.Dashboard = dashboard;
            dashboardDesigner.CreateRibbon();
            dashboardDesigner.CreateCustomItemBars();
        }
    }

    public class MovingIndicator : ChartCustomIndicator {
        protected override Dictionary<AxisPoint, object> Calculate(Dictionary<AxisPoint, decimal?> values) {
            var items = new Dictionary<AxisPoint, object>(values.Count);

            var sum = decimal.Zero;
            var count = 0;
            foreach(KeyValuePair<AxisPoint, decimal?> point in values) {
                if(count == 0) {
                    items.Add(point.Key, null);
                } else {
                    items.Add(point.Key, sum / count);
                }
                sum += point.Value ?? 0;
                count++;
            }

            return items;
        }
    }
}

VB.NET

Imports System
Imports System.Collections.Generic
Imports System.Drawing
Imports System.Linq
Imports System.Windows.Forms
Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardCommon.ViewerData

Namespace WinForm
    Partial Public Class FormDesigner
        Inherits Form

        Public Sub New()
            Try
                IndicatorFactory.Register(Of MovingIndicator)("Moving average")
            Catch e As Exception
                MessageBox.Show(e.Message)
            End Try
            InitializeComponent()
            Dim dashboard = New Dashboard1()
            Dim chartItem As ChartDashboardItem = TryCast(dashboard.Items.First(Function(x) x.ComponentName = "chartDashboardItem1"), ChartDashboardItem)
            Dim trendLine As New MovingIndicator() With {
                .Name = "MovingLine1",
                .Value = "DataItem1",
                .ValueLevel = DevExpress.XtraCharts.ValueLevel.Value,
                .Color = Color.Orange,
                .LegendText = "Moving Average"
            }
            chartItem.Indicators.Add(trendLine)
            dashboardDesigner.Dashboard = dashboard
            dashboardDesigner.CreateRibbon()
            dashboardDesigner.CreateCustomItemBars()
        End Sub
    End Class

    Public Class MovingIndicator
        Inherits ChartCustomIndicator

        Protected Overrides Function Calculate(ByVal values As Dictionary(Of AxisPoint, Decimal?)) As Dictionary(Of AxisPoint, Object)
            Dim items = New Dictionary(Of AxisPoint, Object)(values.Count)

            Dim sum = Decimal.Zero
            Dim count = 0
            For Each point As KeyValuePair(Of AxisPoint, Decimal?) In values
                If count = 0 Then
                    items.Add(point.Key, Nothing)
                Else
                    items.Add(point.Key, sum / count)
                End If
                sum += If(point.Value, 0)
                count += 1
            Next point

            Return items
        End Function
    End Class
End Namespace

The following image illustrates the result:

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Register<T>(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-trend-line-indicators/CS/WinformsIndicator/FormDesigner.cs#L13

try {
    IndicatorFactory.Register<MovingIndicator>("Moving average");
} catch(Exception e) {

VB.NET

winforms-dashboard-trend-line-indicators/VB/WinformsIndicator/FormDesigner.vb#L15

Try
    IndicatorFactory.Register(Of MovingIndicator)("Moving average")
Catch e As Exception