Class SparkLine

Represents a lightweight chart control that displays trends or variations in data over time or categories.

Inheritance

System.Object

SparkLine

Implements

ISparkLine

Namespace: Syncfusion.Windows.Forms.Chart

Assembly: Syncfusion.Chart.Windows.dll

Syntax

public class SparkLine : Control, ISparkLine

Constructors

SparkLine()

Initializes a new instance of the SparkLine class.

Declaration

public SparkLine()

Fields

List

Holds the list of objects.

Declaration

public List<object> List

Field Value

Type
System.Collections.Generic.List<System.Object>

m_sparkLineType

Gets or sets the series type of the sparkline control.

Declaration

public SparkLineType m_sparkLineType

Field Value

Type
SparkLineType

Properties

AllowDrop

Hides the base Allow Drop property from the designer property grid and IntelliSense. This property is explicitly hidden because it is not used at designer time.

Declaration

public override bool AllowDrop { get; set; }

Property Value

Type
System.Boolean

BackColor

Gets or sets BackColor property. This member overrides System.Windows.Forms.Control.BackColor This property is explicitly hidden, which is managed internally for Saprkline chart controls.

Declaration

public override Color BackColor { get; set; }

Property Value

Type
System.Drawing.Color

BackInterior

Customizes the background color of the control. By default, it is set to White color. This property is explicitly hidden from designer, as this is managed internally for sparkline chart controls.

Declaration

public BrushInfo BackInterior { get; set; }

Property Value

Type
BrushInfo

ColumnStyle

Customizes the styles of Column and WinLoss sparklines. This property is explicitly hidden from designer because it is a Get property

Declaration

public Column ColumnStyle { get; }

Property Value

Type
Column

ControlHeight

Used to change Height of Sparkline control. This property is explicitly hidden from designer because it is a Get property

Declaration

public int ControlHeight { get; }

Property Value

Type
System.Int32

ControlWidth

Used to change Width of Sparkline control. This property is explicitly hidden from designer because it is a Get property

Declaration

public int ControlWidth { get; }

Property Value

Type
System.Int32

EndPoint

Gets or sets the EndPoint of Sparkline control. This property is explicitly hidden from designer. Used internally by Sparkline chart control.

Declaration

public double EndPoint { get; set; }

Property Value

Type
System.Double

Font

Gets or sets the System.Drawing.Font value for the control. This property is explicitly hidden from designer, as this is managed internally for sparkline chart controls.

Declaration

public Font Font { get; set; }

Property Value

Type
System.Drawing.Font

ForeColor

Gets or sets ForeColor. This member overrides System.Windows.Forms.Control.ForeColor This property is explicitly hidden from designer, as this is managed internally for sparkline chart controls.

Declaration

public override Color ForeColor { get; set; }

Property Value

Type
System.Drawing.Color

HighPoint

Gets or sets the HighPoint of Sparkline control. This property is explicitly hidden from designer. Used internally by Sparkline chart control.

Declaration

public double HighPoint { get; set; }

Property Value

Type
System.Double

LineStyle

Customizes the styles of Line sparkline. This property is explicitly hidden from designer because it is a Get property

Declaration

public Line LineStyle { get; }

Property Value

Type
Line

LowPoint

Gets or sets the LowPoint of Sparkline control. This property is explicitly hidden from designer. Used internally by Sparkline chart control.

Declaration

public double LowPoint { get; set; }

Property Value

Type
System.Double

Markers

Enables the markers support to sparkline. This property is explicitly hidden from designer because it is a Get property

Declaration

public Markers Markers { get; }

Property Value

Type
Markers

NegativeItem

Gets or sets the NegativeItem of Sparkline control. This property is explicitly hidden from designer. Used internally by Sparkline chart control.

Declaration

public double[] NegativeItem { get; set; }

Property Value

Type
System.Double[]

Source

Gets or sets the data source of the Sparkline control. Source is handled programmatically for better control and flexibility.

Declaration

public object Source { get; set; }

Property Value

Type
System.Object

StartPoint

Gets or sets the StartPoint of Sparkline control. This property is explicitly hidden from designer. Used internally by Sparkline chart control.

Declaration

public double StartPoint { get; set; }

Property Value

Type
System.Double

Text

Gets or sets Text. This member overrides System.Windows.Forms.Control.Text This property is explicitly hidden from designer, as this is managed internally for sparkline chart controls.

Declaration

public override string Text { get; set; }

Property Value

Type
System.String

Type

Gets or sets the series type of Sparkline control.

Declaration

public SparkLineType Type { get; set; }

Property Value

Type
SparkLineType

Methods

Dispose(Boolean)

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true if managed resources should be disposed; otherwise, false.

GetEndPoint()

Retrieves the EndPoint of the Sparkline control.

Declaration

public double GetEndPoint()

Returns

Type
System.Double

GetHighPoint()

Retrieves the HighPoint of the Sparkline control.

Declaration

public double GetHighPoint()

Returns

Type
System.Double

GetLowPoint()

Retrieves the LowPoint of the Sparkline control.

Declaration

public double GetLowPoint()

Returns

Type
System.Double

GetNegativePoint()

Retrieves the NegativeItem of the Sparkline control.

Declaration

public double[] GetNegativePoint()

Returns

Type
System.Double[]

GetStartPoint()

Retrieves the StartPoint of the Sparkline control.

Declaration

public double GetStartPoint()

Returns

Type
System.Double

OnListChanged(Object, ListChangedEventArgs)

Event that is raised when the source list changed.

Declaration

public void OnListChanged(object sender, ListChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.ComponentModel.ListChangedEventArgs	e	The System.Windows.Forms.PaintEventArgs instance containing the event data.

OnPaint(PaintEventArgs)

Overrides the System.Windows.Forms.Control.Paint event.

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	A System.Windows.Forms.PaintEventArgs that contains the event data.

ResetPoints()

Used to refresh the SparkLine points.

Declaration

public void ResetPoints()

Implements

ISparkLine