JavaScript/jQuery Sparkline Options

See Also

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

To set a color for the bars indicating positive values, specify the barPositiveColor property.

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

To set a color for the bars indicating negative values, specify the barNegativeColor property.

The Sparkline works with collections of objects.

Depending on your data source, bind Sparkline to data as follows. In each case, also specify the argumentField and valueField properties.

• Data Array
  Assign the array to the dataSource option. View Demo

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data.

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  JavaScript

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#sparklineContainer").dxSparkline({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  app.component.ts

  app.component.html

  app.module.ts

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-sparkline ...
      [dataSource]="store">
  </dx-sparkline>

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxSparklineModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxSparklineModule
      ],
      providers: [],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template> 
      <DxSparkline ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxSparkline } from 'devextreme-vue/sparkline';
  
  export default {
      components: {
          DxSparkline
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import Sparkline from 'devextreme-react/sparkline';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <Sparkline ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the Sparkline always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

Make sure that the showFirstLast property is set to true, so that this property takes effect.

To specify a color for the area inside of the point boundary, use the pointColor property.

Data points that have the null value do not produce actual points. Because of this, the sparkline may be drawn with unnecessary gaps where missing points should have been. To remove these gaps, set the ignoreEmptyPoints property to true.

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

To set a color for the bars indicating the values greater than a winloss threshold, specify the winColor property.

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

So that this property takes effect, make sure that the showMinMax property is set to true.

To set a color for the minimum point on a sparkline, specify the minColor property.

To specify a color for the area inside of the point boundary, use the pointColor property.

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

Make sure that the showMinMax property is set to true, so that this property takes effect.

To set a color for the maximum point on a sparkline, specify the maxColor property.

To specify a color for the area inside of the point boundary, use the pointColor property.

See Also

• onExporting
• onFileSaving

See Also

• onExported
• onFileSaving

See Also

• onExporting
• onExported

The UI component notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

• id
  The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
• type
  The incident's type: "error" or "warning".
• args
  The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the property that was not set properly.
• text
  The text passed to the browser's console. Includes the args content, if there is any.
• widget
  The name of the UI component that produced the error or warning.
• version
  The used DevExtreme version.

<dx-sparkline ...
    (onInitialized)="saveInstance($event)">
</dx-sparkline>

import { Component } from "@angular/core";
import Sparkline from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    sparklineInstance: Sparkline;
    saveInstance (e) {
        this.sparklineInstance = e.component;
    }
}

<template>
    <div>
        <DxSparkline ...
            @initialized="saveInstance">
        </DxSparkline>
    </div>
</template>

<script>
import DxSparkline from 'devextreme-vue/sparkline';

export default {
    components: {
        DxSparkline
    },
    data: function() {
        return {
            sparklineInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.sparklineInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxSparkline ...
            @initialized="saveInstance">
        </DxSparkline>
    </div>
</template>

<script setup>
import DxSparkline from 'devextreme-vue/sparkline';

let sparklineInstance = null;

const saveInstance = (e) => {
    sparklineInstance = e.component;
}
</script>

import Sparkline from 'devextreme-react/sparkline';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.sparklineInstance = e.component;
    }

    render() {
        return (
            <div>
                <Sparkline onInitialized={this.saveInstance} />
            </div>
        );
    }
}

See Also

The following example shows how to subscribe to component property changes:

$(function() {
    $("#sparklineContainer").dxSparkline({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-sparkline ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-sparkline>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxSparklineModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxSparklineModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxSparkline ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxSparkline from 'devextreme-vue/sparkline'; 

export default { 
    components: { 
        DxSparkline
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Sparkline from 'devextreme-react/sparkline'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Sparkline ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

If you place the UI component on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the UI component elements may get mixed up or disappear. To solve this problem, set the pathModified property to true.

See Also

• DevExpress.viz.refreshPaths()

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

When this property is set to true, the first and last values are highlighted and painted in the color specified by the firstLastColor property.

When this property is set to true, the minimum and maximum values are highlighted and painted in the colors specified by the minColor and maxColor properties correspondingly.

You can specify a custom width and height for the component:

$(function() {
    $("#sparklineContainer").dxSparkline({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});

<dx-sparkline ... >
    <dxo-size
        [height]="300"
        [width]="600">
    </dxo-size>
</dx-sparkline>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxSparklineModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxSparklineModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxSparkline ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxSparkline>
</template>

<script>

import DxSparkline, {
    DxSize
} from 'devextreme-vue/sparkline';

export default {
    components: {
        DxSparkline,
        DxSize
    },
    // ...
}
</script>

import React from 'react';

import Sparkline, {
    Size
} from 'devextreme-react/sparkline';

class App extends React.Component {
    render() {
        return (
            <Sparkline ... >
                <Size
                    height={300}
                    width={600}
                />
            </Sparkline>
        );
    }
}
export default App;

Alternatively, you can use CSS to style the UI component's container:

$(function() {
    $("#sparkline").dxSparkline({
        // ...
    });
});

#sparkline {
    width: 85%;
    height: 70%;
}

<dx-sparkline ...
    id="sparkline">
</dx-sparkline>

#sparkline {
    width: 85%;
    height: 70%;
}

<template>
    <DxSparkline ...
        id="sparkline">
    </DxSparkline>
</template>

<script>
import DxSparkline from 'devextreme-vue/sparkline';

export default {
    components: {
        DxSparkline
    },
    // ...
}
</script>

<style>
#sparkline {
    width: 85%;
    height: 70%;
}
</style>

import React from 'react';

import Sparkline from 'devextreme-react/sparkline';

class App extends React.Component {
    render() {
        return (
            <Sparkline ...
                id="sparkline">
            </Sparkline>
        );
    }
}
export default App;

#sparkline {
    width: 85%;
    height: 70%;
}

A theme is a UI component configuration that gives the UI component a distinctive appearance. You can use one of the predefined themes or create a custom one. Changing the property values in the UI component's configuration object overrides the theme's corresponding values.

A tooltip is a miniature rectangle displaying UI component data. The tooltip appears when the end-user hovers the cursor over the UI component. You can enable/disable the tooltip, change its appearance and format its text using fields of the tooltip configuration object.

The sparkline type determines how data is visualized. The following list shows properties that are available for different types of Sparklines:

• All types:

  • argumentField
  • dataSource
  • firstLastColor
  • minColor
  • maxColor
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField

• The line, spline, stepline, area, splinearea, and steparea types:

  • lineColor
  • lineWidth
  • pointColor
  • pointSize
  • pointSymbol

• The bar type:

  • barNegativeColor
  • barPositiveColor

• The winloss type:

  • lossColor
  • winColor
  • winlossThreshold

View Demo

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

To set a color for the bars indicating the values that are less than the winloss threshold, specify the lossColor property.

In the winloss sparkline, values are represented by bars that either grow up or go down from an invisible line. This line is determined by a threshold value. If a data source value is greater than this threshold value, the bar grows up. Otherwise, it goes down.

You can paint the 'win' and 'loss' bars differently. For this purpose, specify the required colors using the winColor and lossColor properties respectively.