Back to Devexpress

SparklineViewType Enum

corelibraries-devexpress-dot-sparkline-c5b1dbb9.md

latest5.3 KB
Original Source

SparklineViewType Enum

Lists the values used to specify the available view types of a sparkline.

Namespace : DevExpress.Sparkline

Assembly : DevExpress.Sparkline.v25.2.Core.dll

NuGet Package : DevExpress.Sparkline.Core

Declaration

csharp
[ResourceFinder(typeof(ResFinder), "PropertyNamesRes")]
public enum SparklineViewType
vb
<ResourceFinder(GetType(ResFinder), "PropertyNamesRes")>
Public Enum SparklineViewType

Members

NameDescription
Line

Sparkline data points are represented as a line.

| | Area |

Sparkline data points are represented as area.

| | Bar |

Sparkline data points are represented as bars.

| | WinLoss |

Sparkline data points are represented as win and loss squares.

|

The following properties accept/return SparklineViewType values:

Remarks

The values listed by the SparklineViewType enumeration are used as a parameter of the SparklineViewBase.CreateView method.

Example

This example demonstrates how to create a sparkline control, fill it with data, choose the way to represent this data, and customize the sparkline appearance.

To do this, you should create a SparklineEdit object and assign the datasource object to its BaseEdit.EditValue property. Then, you need to set the appropriate view instance to the SparklineEdit.Properties.View property and customize view properties to meet your requirements.

Note that in this sample, the AreaSparklineView class is used to display area sparklines. To display other sparklines types, use the BarSparklineView, LineSparklineView or WinLossSparklineView classes instead.

csharp
using System;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.Sparkline;
using DevExpress.XtraEditors;
        private SparklineEdit CreateSparkline() {
            // Create a Sparkline editor and set its dock style.
            SparklineEdit sparkline = new SparklineEdit();
            sparkline.Dock = DockStyle.Fill;

            sparkline.EditValue = CreateData();

            // Create an Area view and assign it to the sparkline.
            AreaSparklineView view = new AreaSparklineView();
            sparkline.Properties.View = view;

            // Customize area appearance.
            view.Color = Color.Aqua;
            view.AreaOpacity = 50;

            // Show markerks.
            view.HighlightStartPoint = true;
            view.HighlightEndPoint = true;
            view.HighlightMaxPoint = true;
            view.HighlightMinPoint = true;
            view.HighlightNegativePoints = true;
            view.SetSizeForAllMarkers(10);

            return sparkline;
        }

        private double[] CreateData() {
            return new double[] { 2, 4, 5, 1, -1, -2, -1, 2, 4, 5, 6, 3, 5, 4, 8, -1, 6 };
        }
vb
Imports System
Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.Sparkline
Imports DevExpress.XtraEditors
        Private Function CreateSparkline() As SparklineEdit
            ' Create a Sparkline editor and set its dock style.
            Dim sparkline As New SparklineEdit()
            sparkline.Dock = DockStyle.Fill

            sparkline.EditValue = CreateData()

            ' Create an Area view and assign it to the sparkline.
            Dim view As New AreaSparklineView()
            sparkline.Properties.View = view

            ' Customize area appearance.
            view.Color = Color.Aqua
            view.AreaOpacity = 50

            ' Show markerks.
            view.HighlightStartPoint = True
            view.HighlightEndPoint = True
            view.HighlightMaxPoint = True
            view.HighlightMinPoint = True
            view.HighlightNegativePoints = True
            view.SetSizeForAllMarkers(10)

            Return sparkline
        End Function

        Private Function CreateData() As Double()
            Return New Double() { 2, 4, 5, 1, -1, -2, -1, 2, 4, 5, 6, 3, 5, 4, 8, -1, 6 }
        End Function

See Also

DevExpress.Sparkline Namespace