Getting Started with the Sparkline

This tutorial explains how to set up a basic Telerik UI for ASP.NET Core Sparkline and highlights the major steps in the configuration of the component.

You will initialize a Sparkline and learn how to change its display type. Then, you can run the sample code in Telerik REPL and continue exploring the component.

Prerequisites

To successfully complete the tutorial, you need a project that is already configured to use the Telerik UI for ASP.NET Core components:

• You can use the Telerik REPL playground and skip installing the components on your system and configuring a project.

• You can prepare a Visual Studio project by following either of these guides:

  • Creating a new pre-configured project for the Telerik UI for ASP.NET Core components from a project template.

  • Manually configuring an existing project as described in the First Steps on Windows or First Steps on Mac articles.

1. Prepare the CSHTML File

The first step is to add the required directives at the top of the .cshtml document:

• To use the Telerik UI for ASP.NET Core HtmlHelpers:

  @using Kendo.Mvc.UI
  

• To use the Telerik UI for ASP.NET Core TagHelpers:

  @addTagHelper *, Kendo.Mvc
  

Optionally, you can structure the document by adding the desired HTML elements like headings, divs, paragraphs, and others.

@using Kendo.Mvc.UI

<h4>Sparkline in column mode</h4>

<p>

</p>

@addTagHelper *, Kendo.Mvc

<h4>Sparkline in column mode</h4>

<p>

</p>

2. Initialize the Sparkline

Use the Sparkline HtmlHelper or TagHelper to add the component to a page:

• The Name() configuration method is mandatory as its value is used for the id attribute of the Sparkline element.
• The Data() option allows you to pass the content.
• The Type() configuration allows changing the display mode.

@using Kendo.Mvc.UI

@{
    var pressureData = new double[] {
                936, 968, 1025, 999, 998, 1014, 1017, 1010, 1010, 1007,
                1004, 988, 990, 988, 1012, 995, 946, 922, 991, 984,
                974, 956, 986, 936, 955, 1021, 1013, 1005, 958, 953,
                952, 940, 937, 980, 966, 965, 928, 916, 910, 980
    };
}

<h4>Sparkline in column mode</h4>

<p>
    @(Html.Kendo().Sparkline()
        .Name("sparkline")
        .Data(pressureData)
    )
</p>

@addTagHelper *, Kendo.Mvc

@{
    var pressureData = new double[] {
                936, 968, 1025, 999, 998, 1014, 1017, 1010, 1010, 1007,
                1004, 988, 990, 988, 1012, 995, 946, 922, 991, 984,
                974, 956, 986, 936, 955, 1021, 1013, 1005, 958, 953,
                952, 940, 937, 980, 966, 965, 928, 916, 910, 980
    };
}

<h4>Sparkline in column mode</h4>

<p>
    <kendo-sparkline name="sparkline" data="pressureData">
    </kendo-sparkline>
</p>

3. Change the display mode to Column

The next step is to configure the Sparkline to change its mode.

@using Kendo.Mvc.UI

@{
    var pressureData = new double[] {
                936, 968, 1025, 999, 998, 1014, 1017, 1010, 1010, 1007,
                1004, 988, 990, 988, 1012, 995, 946, 922, 991, 984,
                974, 956, 986, 936, 955, 1021, 1013, 1005, 958, 953,
                952, 940, 937, 980, 966, 965, 928, 916, 910, 980
    };
}

<h4>Sparkline in column mode</h4>

<p>
    @(Html.Kendo().Sparkline()
        .Name("sparkline")
        .Data(pressureData)
        .Type(SparklineType.Column)
    )
</p>

@addTagHelper *, Kendo.Mvc

@{
    var pressureData = new double[] {
                936, 968, 1025, 999, 998, 1014, 1017, 1010, 1010, 1007,
                1004, 988, 990, 988, 1012, 995, 946, 922, 991, 984,
                974, 956, 986, 936, 955, 1021, 1013, 1005, 958, 953,
                952, 940, 937, 980, 966, 965, 928, 916, 910, 980
    };
}

<h4>Sparkline in column mode</h4>

<p>
    <kendo-sparkline name="sparkline" data="pressureData"
     type="SparklineType.Column">
    </kendo-sparkline>
</p>

4. (Optional) Reference Existing Sparkline Instances

You can reference the Sparkline instances that you have created and build on top of their existing configuration:

1. Use the id attribute of the component instance to establish a reference.

   <script>
       var sparklineReference = $("#sparkline").data("kendoSparkline"); // sparklineReference is a reference to the existing sparkline instance of the helper.
   </script>
   

2. Use the Sparkline client-side API to control the behavior of the widget. In this example, you will use the refresh method to reset the sparkline content.

   <script>
       var sparklineReference = $("#sparkline").data("kendoSparkline"); // sparklineReference is a reference to the existing timeSparkline instance of the helper.
       var view = sparklineReference.refresh(); 
   </script>
   

Explore this Tutorial in REPL

You can continue experimenting with the code sample above by running it in the Telerik REPL server playground:

• Sample code with the Sparkline HtmlHelper
• Sample code with the Sparkline TagHelper

Next Steps

• Configure the Axes

See Also

• Using the API of the Sparkline for ASP.NET Core (Demo)
• Client-Side API of the Sparkline
• Server-Side API of the Sparkline
• Knowledge Base Section