Configuration

An object that specifies configuration options for the Sparkline widget.

argumentField

Specifies the data source field that provides arguments for a sparkline.

Type: String
Default Value: 'arg'

Show Example:
jQuery

In this example, arguments for the sparkline are provided by the 'month' field of the data source using the argumentField option.


                                    

                                    

barNegativeColor

Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only.

Type: String
Default Value: '#d7d7d7'

This option supports the following colors.

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

Show Example:
jQuery

In this example, the data source contains both negative and positive values. The negative values are painted 'coral' using the barNegativeColor option while the positive values are painted 'powderblue' using the barPositiveColor option.


                                    

                                    

barPositiveColor

Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only.

Type: String
Default Value: '#a9a9a9'

This option supports the following colors.

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

Show Example:
jQuery

In this example, the data source contains both positive and negative values. The positive values are painted 'dodgerblue' using the barPositiveColor option while the negative values are painted 'salmon' using the barNegativeColor option.


                                    

                                    

dataSource

Specifies a data source for the sparkline.

Cannot be used in themes.

This option accepts one of the following.

  • Array of objects
    A simple JavaScript array containing a collection of plain objects.

  • URL
    A URL to JSON data or to a service returning data in JSON format.

  • DataSource or its configuration object
    A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

See Also
Show Example:
jQuery

In this example, the data source is declared as an array of objects, each of which contains the 'month' and '2010' fields. The 'month' field provides arguments for the sparkline, while the '2010' field provides values.


                                    

                                    

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type: Object
Default Value: {}

When you configure this option using a server-side wrapper, pass a dictionary as shown in the following code.

@(Html.DevExtreme()
    // other widget options
    // ...
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" },
        // ...
    })
)

firstLastColor

Sets a color for the boundary of both the first and last points on a sparkline.

Type: String
Default Value: '#666666'

This option supports the following colors.

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

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

Show Example:
jQuery

In this example, the first and last sparkline values are indicated by points colored in 'lightskyblue'.


                                    

                                    

ignoreEmptyPoints

Specifies whether a sparkline ignores null data points or not.

Type: Boolean
Default Value: false

By default, if a data source has data points with a null argument or value, a sparkline may draw series with unnecessary gaps between points. To prevent this behavior from occurring, set the ignoreEmptyPoints option to true.

lineColor

Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types.

Type: String
Default Value: '#666666'

This option supports the following colors.

Show Example:
jQuery

In this example, the line of the steparea sparkline is colored in 'lightgreen' using the lineColor option.


                                    

                                    

lineWidth

Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types.

Type: Number
Default Value: 2

Show Example:
jQuery

In this example, the line of the area sparkline is increased up to a 4-pixel width using the lineWidth option.


                                    

                                    

lossColor

Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only.

Type: String
Default Value: '#d7d7d7'

This option supports the following colors.

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

Show Example:
jQuery

In this example, all the 'loss' bars are drawn in the 'orange' color using the lossColor option.


                                    

                                    

margin

Generates space around the widget.

Type: Object

WidgetMargin DevExtreme ChartJS

maxColor

Sets a color for the boundary of the maximum point on a sparkline.

Type: String
Default Value: '#e55253'

This option supports the following colors.

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

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

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

Show Example:
jQuery

In this example, the maximum value on the sparkline is painted red using the maxColor option.


                                    

                                    

maxValue

Specifies the maximum value of the sparkline's value axis.

Type: Number
Default Value: undefined

Show Example:
jQuery

Move the slider at the bottom to change the sparkline's maxValue value.


                                    

                                    

minColor

Sets a color for the boundary of the minimum point on a sparkline.

Type: String
Default Value: '#e8c267'

This option supports the following colors.

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

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

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

Show Example:
jQuery

In this example, the minimum value on the sparkline is painted blue using the minColor option.


                                    

                                    

minValue

Specifies the minimum value of the sparkline value axis.

Type: Number
Default Value: undefined

Show Example:
jQuery

Move the slider at the bottom to change the sparkline's minValue value.


                                    

                                    

onDisposing

A handler for the disposing event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE
The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onDrawn

A handler for the drawn event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

Assign a callback function to this option if you need to perform specific actions when the widget has finished drawing itself. When implementing this function, you can access the drawn widget using the function's parameter.

onExported

A handler for the exported event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

To perform a custom action after data from the widget is exported, assign a function to this option. For example, this function can notify the user that the exporting has been completed. Within this function, you can use the object passed to it as the parameter.

See Also
  • onExporting - allows you to request exporting details and prevent exporting.
  • onFileSaving - allows you to access exported data and/or prevent it from being saved into a file on the user's local storage.

onExporting

A handler for the exporting event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in Knockout and AngularJS approaches.
fileName: String
The name of the file to which the widget is about to be exported.
cancel: Boolean
Assign true to this field if you need to prevent exporting.
Default Value: null

To perform a custom action before data from the widget is exported, assign a function to this option. Within this function, you can use the object passed to it as the parameter. For example, using the cancel field of this object, you can cancel exporting.

See Also
  • onExported - allows you to notify an end user when exporting is completed.
  • onFileSaving - allows you to access exported data and/or prevent it from being saved into a file on the user's local storage.

onFileSaving

A handler for the fileSaving event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
fileName: String
The name of the file to be saved.
format: String
The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'
data: BLOB
Exported data as a BLOB.
cancel: Boolean
Assign true to this field if you need to prevent the file from being saved.
Default Value: null

To perform a custom action before a file with exported data is saved on the user's local storage, assign a function to this option. Within this function, you can use the object passed to it as the parameter. For example, using the cancel field of this object, you can cancel file saving.

See Also
  • onExporting - allows you to request exporting details and prevent exporting.
  • onExported - allows you to notify an end user when exporting is completed.

onIncidentOccurred

A handler for the incidentOccurred event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Object
Information about the occurred incident.

When an error or warning appears, the widget notifies you by passing a message to the browser console. This message contains the ID of the incident, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found. However, you can handle errors and warnings in the way that you require. To do this, implement a callback function performing the required actions and assign it to the onIncidentOccurred option. Within this function, you can use information about the incident that occurred. This information can be accessed from the target field of the object passed to the callback function as a parameter. This information includes the following.

  • id
    Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
  • type
    Contains the type of the incident. This field equals 'error' for errors or 'warning' for warnings.
  • args
    Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
  • text
    Contains the text passed to the browser console. This text includes the content of the args field, if there are any.
  • widget
    Contains the name of the widget that produced the error or warning.
  • version
    Contains the currently used version of the ChartJS library.

onInitialized

A handler for the initialized event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onTooltipHidden

A handler for the tooltipHidden event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

The sparkline's tooltip becomes invisible when a user moves the mouse cursor outside of the widget.

When a tooltip is made hidden, you can perform specific actions by handling the tooltipHidden event. To do this, implement a handling function and assign it to this option. When implementing a handling function, use the object passed to it as its parameter. This object will provide you with the widget instance and its container.

onTooltipShown

A handler for the tooltipShown event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

The sparkline's tooltip appears when a user hovers the mouse cursor over it.

When a tooltip appears, you can perform specific actions by handling the tooltipShown event. To do this, implement a handling function and assign it to this option. When implementing this function, use the object passed to it as its parameter. This object will provide you with the widget instance and its container.

pathModified

Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path.

Type: Boolean
Default Value: false
Cannot be used in themes.

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

See Also

pointColor

Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types.

Type: String
Default Value: '#ffffff'

This option supports the following colors.

Show Example:
jQuery

In this example, the points are drawn in the 'papayawhip' color using the pointColor option.


                                    

                                    

pointSize

Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types.

Type: Number
Default Value: 4

Show Example:
jQuery

In this example, the points are increased in size using the pointSize option.


                                    

                                    

pointSymbol

Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types.

Type: String
Default Value: 'circle'
Accepted Values: 'circle' | 'square' | 'polygon' | 'triangle' | 'cross'

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the VizPointSymbol enum. This enum accepts the following values: Circle, Square, Polygon, Triangle and Cross.

Show Example:
jQuery

Use the drop-down menu below to select the symbol representing the sparkline points.


                                    

                                    

rtlEnabled

Specifies whether or not the widget supports right-to-left representation.

Type: Boolean
Default Value: false
Cannot be used in themes.

The most common scenario is switching all the widgets to a right-to-left reading order. In this instance, set the DevExpress.rtlEnabled field to true. If you need to switch the reading order in a particular widget, use the rtlEnabled configuration option of this widget.

showFirstLast

Specifies whether or not to indicate both the first and last values on a sparkline.

Type: Boolean
Default Value: true

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

Show Example:
jQuery

Toggle the check box below to show/hide the first and last points on the sparkline.


                                    

                                    

showMinMax

Specifies whether or not to indicate both the minimum and maximum values on a sparkline.

Type: Boolean
Default Value: false

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

Show Example:
jQuery

Toggle the check box below to show/hide the minimum and maximum points on the sparkline.


                                    

                                    

size

Specifies the size of the widget in pixels.

Type: Object

By default, the widget occupies the entire area of the parent container. If you need to set a particular size for the widget, different from the container's size, assign a height and width in pixels to height and width properties of the size object.

Using the size object, you can hide the widget. For this purpose, simply assign 0 to both the height and width of the widget.

NOTE
The size configuration object reserves space for the main widget elements, while displaying a tooltip may require extra space. To reserve the area around the widget for the tooltip, you can apply a margin to the widget's container.
Show Example:
jQuery

In this example, the size of the widget differs from the container size.


                                    

                                    

theme

Sets the name of the theme to be used in the widget.

Type: String
Default Value: 'generic.light'
Accepted Values: 'generic.light' | 'generic.dark' | 'generic.contrast' | 'android5.light' | 'ios7.default' | 'win10.black' | 'win10.white'

Use this property to set a predefined or custom theme. The options defining chart appearance will be set to the values that are set in the specified theme. You can override some of these values within the chart's configuration object.

NOTE
The following themes were deprecated or renamed: 'desktop', 'desktop-dark', 'android', 'android-holo-light', 'ios', 'win8', 'win8-white', 'win8.white', 'win8.black'. In new applications, use themes listed in the accepted values.

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the VizTheme enum. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, Android5Light, IOS7Default, Win10Black and Win10White.

Show Example:
jQuery

In this example, a blue theme is implemented on the base of the default theme. This theme is applied to the Sparkline widget using the theme option.


                                    

                                    

tooltip

Configures the tooltip.

Type: Object

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

NOTE
The tooltip is displayed outside the widget's container. If you plan to use the tooltip, make sure there is enough space around your widget to display it. For example, you can apply a margin to the widget's container to reserve the area around the widget for the tooltip.
Show Example:
jQuery

In this example, several tooltip options are altered. The tooltip is colored in 'lavender' using the tooltip's color option. In addition, the tooltip text is painted blue and displayed with a size of 12.


                                    

                                    

type

Determines the type of a sparkline.

Type: String
Default Value: 'line'
Accepted Values: 'line' | 'spline' | 'stepline' | 'area' | 'splinearea' | 'steparea' | 'bar' | 'winloss'

A sparkline type determines the visual representation of data. Different options of the Sparkline widget are available for different types. The table below reflects options that can be configured for the sparkline of a certain type.

line spline stepline area splinearea steparea bar winloss
  • argumentField
  • dataSource
  • firstLastColor
  • lineColor
  • lineWidth
  • minColor
  • maxColor
  • pointColor
  • pointSize
  • pointSymbol
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField
  • argumentField
  • dataSource
  • firstLastColor
  • lineColor
  • lineWidth
  • minColor
  • maxColor
  • pointColor
  • pointSize
  • pointSymbol
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField
  • argumentField
  • dataSource
  • firstLastColor
  • lineColor
  • lineWidth
  • minColor
  • maxColor
  • pointColor
  • pointSize
  • pointSymbol
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField
  • argumentField
  • dataSource
  • firstLastColor
  • lineColor
  • lineWidth
  • minColor
  • maxColor
  • pointColor
  • pointSize
  • pointSymbol
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField
  • argumentField
  • dataSource
  • firstLastColor
  • lineColor
  • lineWidth
  • minColor
  • maxColor
  • pointColor
  • pointSize
  • pointSymbol
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField
  • argumentField
  • dataSource
  • firstLastColor
  • lineColor
  • lineWidth
  • minColor
  • maxColor
  • pointColor
  • pointSize
  • pointSymbol
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField
  • argumentField
  • barNegativeColor
  • barPositiveColor
  • dataSource
  • firstLastColor
  • minColor
  • maxColor
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField
  • argumentField
  • dataSource
  • firstLastColor
  • lossColor
  • minColor
  • maxColor
  • showFirstLast
  • showMinMax
  • size
  • theme
  • tooltip
  • valueField
  • winColor
  • winlossThreshold

To see the sparklines of each type in operation, refer to our Visualization Gallery.

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the SparklineType enum. This enum accepts the following values: Line, Spline, StepLine, Area, SplineArea, StepArea, Bar and WinLoss.

View Area Sparkline Demo View Bar Sparkline Demo View Winloss Sparkline Demo

valueField

Specifies the data source field that provides values for a sparkline.

Type: String
Default Value: 'val'

Show Example:
jQuery

In this example, values for the sparkline are provided by the '2010' field of the data source using the valueField option.


                                    

                                    

winColor

Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only.

Type: String
Default Value: '#a9a9a9'

This option supports the following colors.

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

Show Example:
jQuery

In this example, all the 'win' bars are drawn in the 'palevioletred' color using the winColor option.


                                    

                                    

winlossThreshold

Specifies a value that serves as a threshold for the sparkline of the winloss type.

Type: Number
Default Value: 0

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 options respectively.

Show Example:
jQuery

In this example, the winlossThreshold option is set to 2100. It means that the values greater than 2100 are represented by bars growing up from the threshold line while the other values are represented by bars going down from this line.