Skip to content

es5-getting-started.md

Latest commit

 

History

History
237 lines (169 loc) · 8.02 KB

es5-getting-started.md

File metadata and controls

237 lines (169 loc) · 8.02 KB
layout post
title Es5 getting started with
description Checkout and learn about Es5 getting started with
platform ej2-javascript
control Es5 getting started
publishingplatform
documentation ug
domainurl

Es5 getting started in ##Platform_Name## Bullet chart control

This section explains you the steps required to create a simple Bullet Chart and demonstrate the basic usage of the Bullet Chart control.

Dependencies

Below is the list of minimum dependencies required to use the Bullet Chart.

|-- @syncfusion/ej2-charts
    |-- @syncfusion/ej2-base
    |-- @syncfusion/ej2-data
    |-- @syncfusion/ej2-pdf-export
    |-- @syncfusion/ej2-file-utils
    |-- @syncfusion/ej2-compression
    |-- @syncfusion/ej2-svg-base

Setup for local environment

Refer the following steps for setup your local environment.

Step 1: Create a root folder myapp for your application.

Step 2: Create myapp/resources folder to store local scripts and styles files.

Step 3: Create myapp/index.js and myapp/index.html files for initializing Essential JS 2 Bullet Chart control.

Adding Syncfusion resources

The Essential JS 2 Bullet Chart control can be initialized by using either of the following ways.

  • Using local script.
  • Using CDN link for script.

Using local script

You can get the global scripts and styles from the Essential Studio JavaScript (Essential JS 2) build installed location.

After installing the Essential JS 2 product build, you can copy the Bullet Chart and its dependencies scripts and style file into the resources/scripts and resources/styles folder.

Refer the below code to find location bullet chart's script and style file.

Syntax:

Dependency script: **(installed location)**/Syncfusion/Essential Studio/{RELEASE_VERSION}/Essential JS 2/{DEPENDENCY_PACKAGE_NAME}/dist/global/{DEPENDENCY_PACKAGE_NAME}.min.js

Script: **(installed location)**/Syncfusion/Essential Studio/{RELEASE_VERSION}/Essential JS 2/{PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

Example:

Dependency script: C:/Program Files (x86)/Syncfusion/Essential Studio/15.4.30/Essential JS 2/ej2-base/dist/global/ej2-base.min.js

Script: C:/Program Files (x86)/Syncfusion/Essential Studio/15.4.30/Essential JS 2/ej2-charts/dist/global/ej2-charts.min.js

After copying the files, then you can refer the Bullet Chart's scripts into the index.html file. The below html code example shows the minimal dependency of Bullet Chart.


<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
       <head>
            <title>Essential JS 2 Bullet Chart</title>

            <!-- Essential JS 2 Bullet Chart's dependent scripts -->
            <script src="resources/scripts/ej2-base.min.js" type="text/javascript"></script>
            <script src="resources/scripts/ej2-svg-base.min.js" type="text/javascript"></script>

            <!-- Essential JS 2 Bullet Chart's global script -->
            <script src="resources/scripts/ej2-charts.min.js" type="text/javascript"></script>
       </head>
       <body>
       </body>
  </html>

Using CDN link for script

Using CDN link, you can directly refer the bullet chart control's script into the index.html.

Refer the Bullet Chart's CDN links as below

Syntax:

Script: http://cdn.syncfusion.com/ej2/{PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

Example:

Script: http://cdn.syncfusion.com/ej2/ej2-charts/dist/global/ej2-charts.min.js

The below html code example shows the minimal dependency of Bullet Chart.

<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
       <head>
            <title>Essential JS 2 Bullet Chart</title>
            <!-- Essential JS 2 Bullet Chart's global script -->
            <script src="http://cdn.syncfusion.com/ej2/ej2-charts/dist/global/ej2-charts.min.js" type="text/javascript"></script>
       </head>
       <body>
       </body>
  </html>

Adding Bullet Chart control

Now, you can start adding Bullet Chart control in the application. For getting started, add a div element for Bullet Chart control in index.html. Then refer the index.js file into the index.html file.

In this document context we are going to use ej2.min.js which includes all the Essential JS 2 components and its dependent scripts.

<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
       <head>
            <title>Essential JS 2 Bullet Chart</title>
            <!-- Essential JS 2 all script -->
            <script src="http://cdn.syncfusion.com/ej2/dist/ej2.min.js" type="text/javascript"></script>
       </head>
       <body>
           <!-- Add the HTML <div> element for bullet chart  -->
             <div id="element"></div>
             <script src="index.js" type="text/javascript"></script>
       </body>
  </html>

Place the following Bullet Chart code in the index.js.

var bulletChart = new ej.charts.BulletChart();
bulletChart.appendTo('#element');

The below example shows a basic Bullet Chart.

{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/bullet-chart/getting-started-cs1/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/bullet-chart/getting-started-cs1/index.html %} {% endhighlight %} {% endtabs %}

{% previewsample "page.domainurl/code-snippet/bullet-chart/getting-started-cs1" %}

BulletChart With Data

This section explains how to plot local data to the Bullet Chart.

var data = [
       { value: 100, target: 80 },
       { value: 200, target: 180 },
       { value: 300, target: 280 },
       { value: 400, target: 380 },
       { value: 500, target: 480 },
];

Now assign the local data to dataSource property. value and target values should be mapped with valueField and targetField respectively.

{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/bullet-chart/getting-started-cs2/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/bullet-chart/getting-started-cs2/index.html %} {% endhighlight %} {% endtabs %}

{% previewsample "page.domainurl/code-snippet/bullet-chart/getting-started-cs2" %}

Add Bullet Chart Title

You can add a title using title property to the Bullet Chart to provide quick information to the user about the data plotted in the Bullet Chart.

{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/bullet-chart/getting-started-cs3/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/bullet-chart/getting-started-cs3/index.html %} {% endhighlight %} {% endtabs %}

{% previewsample "page.domainurl/code-snippet/bullet-chart/getting-started-cs3" %}

Ranges

You can add a range using ranges property to the Bullet Chart.

{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/bullet-chart/getting-started-cs4/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/bullet-chart/getting-started-cs4/index.html %} {% endhighlight %} {% endtabs %}

{% previewsample "page.domainurl/code-snippet/bullet-chart/getting-started-cs4" %}

Tooltip

You can use tooltip for the Bullet Chart by setting the enable property to true in tooltip object and by injecting the BulletTooltip module using BulletChart.Inject(BulletTooltip) method.

{% tabs %} {% highlight js tabtitle="index.js" %} {% include code-snippet/bullet-chart/getting-started-cs5/index.js %} {% endhighlight %} {% highlight html tabtitle="index.html" %} {% include code-snippet/bullet-chart/getting-started-cs5/index.html %} {% endhighlight %} {% endtabs %}

{% previewsample "page.domainurl/code-snippet/bullet-chart/getting-started-cs5" %}