ISparkline Interface

Interface that supports creating a sparkline.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
Public Interface ISparkline 
   Inherits IPropertyChangedNotification, FarPoint.Web.Spread.Model.ISerializeSupport

'Usage
 
Dim instance As ISparkline

public interface ISparkline : IPropertyChangedNotification, FarPoint.Web.Spread.Model.ISerializeSupport

Example

This example uses the ISparkline class.

fpSpread1.Sheets[0].RowCount = 10;
fpSpread1.Sheets[0].ColumnCount = 10;
fpSpread1.Sheets[0].SetClip(0, 0, 1, 5, "1\t2\t3\t4\t5");
fpSpread1.Sheets[0].SetClip(1, 0, 1, 5, "5\t4\t3\t2\t1");
fpSpread1.Sheets[0].SetClip(2, 0, 1, 5, "1\t2\t3\t2\t1");

FarPoint.Web.Spread.ExcelSparkline es = new FarPoint.Web.Spread.ExcelSparkline(0, 6, fpSpread1.Sheets[0], new FarPoint.Web.Spread.Model.CellRange(0, 0, 1, 5));
FarPoint.Web.Spread.ExcelSparkline es1 = new FarPoint.Web.Spread.ExcelSparkline(1, 6, fpSpread1.Sheets[0], new FarPoint.Web.Spread.Model.CellRange(1, 0, 1, 5));
FarPoint.Web.Spread.ExcelSparkline es2 = new FarPoint.Web.Spread.ExcelSparkline(2, 6, fpSpread1.Sheets[0], new FarPoint.Web.Spread.Model.CellRange(2, 0, 1, 5));

FarPoint.Web.Spread.ExcelSparklineGroup esg = new FarPoint.Web.Spread.ExcelSparklineGroup(new FarPoint.Web.Spread.ExcelSparklineSetting(), FarPoint.Web.Spread.SparklineType.Column);

esg.Add(es);
esg.Add(es1);
esg.Add(es2);
esg.Clear();
fpSpread1.Sheets[0].SparklineContainer.Add(esg);

FarPoint.Web.Spread.ISparkline[] dest = new FarPoint.Web.Spread.ISparkline[3];
int startIndex = 0;
esg.CopyTo(dest, startIndex);

FarPoint.Web.Spread.ExcelSparkline esl;
FarPoint.Web.Spread.ExcelSparkline esl1;
for (int i = 0; i < 3; i++)
{
    esl = (FarPoint.Web.Spread.ExcelSparkline)esg[i];
    esl1 = (FarPoint.Web.Spread.ExcelSparkline)dest[i];
    listBox1.Items.Add(esl.Row.ToString());
    listBox1.Items.Add(esl1.Row.ToString());
    listBox1.Items.Add(esl.Column.ToString());
    listBox1.Items.Add(esl1.Column.ToString());
    listBox1.Items.Add(esl.Formula.ToString());
    listBox1.Items.Add(esl1.Formula.ToString());
}

Visual Basic

FpSpread1.Sheets(0).RowCount = 10
FpSpread1.Sheets(0).ColumnCount = 10
FpSpread1.Sheets(0).SetClip(0, 0, 1, 5, "1" + Chr(9) + "2" + Chr(9) + "3" + Chr(9) + "4" + Chr(9) + "5")
FpSpread1.Sheets(0).SetClip(1, 0, 1, 5, "5" + Chr(9) + "4" + Chr(9) + "3" + Chr(9) + "2" + Chr(9) + "1")
FpSpread1.Sheets(0).SetClip(2, 0, 1, 5, "1" + Chr(9) + "2" + Chr(9) + "3" + Chr(9) + "2" + Chr(9) + "1")

Dim es As New FarPoint.Web.Spread.ExcelSparkline(0, 6, FpSpread1.Sheets(0), New FarPoint.Web.Spread.Model.CellRange(0, 0, 1, 5))
Dim es1 As New FarPoint.Web.Spread.ExcelSparkline(1, 6, FpSpread1.Sheets(0), New FarPoint.Web.Spread.Model.CellRange(1, 0, 1, 5))
Dim es2 As New FarPoint.Web.Spread.ExcelSparkline(2, 6, FpSpread1.Sheets(0), New FarPoint.Web.Spread.Model.CellRange(2, 0, 1, 5))

Dim esg As New FarPoint.Web.Spread.ExcelSparklineGroup(New FarPoint.Web.Spread.ExcelSparklineSetting(), FarPoint.Web.Spread.SparklineType.Column)

esg.Add(es)
esg.Add(es1)
esg.Add(es2)
esg.Clear()
FpSpread1.Sheets(0).SparklineContainer.Add(esg)

Dim dest As FarPoint.Web.Spread.ISparkline() = New FarPoint.Web.Spread.ISparkline(2) {}
Dim startIndex As Integer = 0
esg.CopyTo(dest, startIndex)

Dim esl As FarPoint.Web.Spread.ExcelSparkline
Dim esl1 As FarPoint.Web.Spread.ExcelSparkline
For i As Integer = 0 To 2
    esl = DirectCast(esg(i), FarPoint.Web.Spread.ExcelSparkline)
    esl1 = DirectCast(dest(i), FarPoint.Web.Spread.ExcelSparkline)
    listBox1.Items.Add(esl.Row.ToString())
    listBox1.Items.Add(esl1.Row.ToString())
    listBox1.Items.Add(esl.Column.ToString())
    listBox1.Items.Add(esl1.Column.ToString())
    listBox1.Items.Add(esl.Formula.ToString())
    listBox1.Items.Add(esl1.Formula.ToString())
Next

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

ISparkline Members
FarPoint.Web.Spread Namespace