All docs
V19.1
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
A newer version of this page is available. Switch to the current version.

jQuery Sparkline API

The Sparkline widget is a compact chart that contains only one series. Owing to their size, sparklines occupy very little space and can be easily collected in a table or embedded straight in text.

import Sparkline from "devextreme/viz/sparkline"
Type:

Object

Configuration

An object that specifies configuration options for the Sparkline widget.

Name Description
argumentField

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

barNegativeColor

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

barPositiveColor

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

dataSource

Binds the widget to data.

disabled

Specifies whether the widget responds to the user interaction.

elementAttr

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

firstLastColor

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

ignoreEmptyPoints

Specifies whether the sparkline should ignore null data points.

lineColor

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

lineWidth

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

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.

margin

Generates space around the widget.

maxColor

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

maxValue

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

minColor

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

minValue

Specifies the minimum value of the sparkline value axis.

onDisposing

A function that is executed before the widget is disposed of.

onDrawn

A function that is executed when the widget's rendering has finished.

onExported

A function that is executed after the widget is exported.

onExporting

A function that is executed before the widget is exported.

onFileSaving

A function that is executed before a file with exported widget is saved to the user's local storage.

onIncidentOccurred

A function that is executed when an error or warning occurs.

onInitialized

A function used in JavaScript frameworks to save the widget instance.

onOptionChanged

A function that is executed after a widget option is changed.

onTooltipHidden

A function that is executed when a tooltip becomes hidden.

onTooltipShown

A function that is executed when a tooltip appears.

pathModified

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

pointColor

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

pointSize

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

pointSymbol

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

rtlEnabled

Switches the widget to a right-to-left representation.

showFirstLast

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

showMinMax

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

size

Specifies the widget's size in pixels.

theme

Sets the name of the theme the widget uses.

tooltip

Configures the tooltip.

type

Determines the type of a sparkline.

valueField

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

winColor

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

winlossThreshold

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

See Also

Methods

This section describes the methods that can be used in code to manipulate objects related to the Bullet widget.

Name Description
beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

dispose()

Disposes of all the resources allocated to the Sparkline instance.

element()

Gets the root widget element.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

exportTo(fileName, format)

Exports the widget.

getDataSource()

Gets the DataSource instance.

getInstance(element)

Gets the instance of a widget found using its DOM node.

getSize()

Gets the current widget size.

instance()

Gets the widget's instance. Use it to access other methods of the widget.

off(eventName)

Detaches all event handlers from a single event.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

on(eventName, eventHandler)

Subscribes to an event.

on(events)

Subscribes to events.

option()

Gets all widget options.

option(optionName)

Gets the value of a single option.

option(optionName, optionValue)

Updates the value of a single option.

option(options)

Updates the values of several options.

print()

Opens the browser's print window.

render()

Redraws the widget.

svg()

Gets the widget's SVG markup.

See Also

Events

This section describes events fired by this widget.

Name Description
disposing

Raised before the widget is disposed of.

drawn

Raised when the widget's rendering has finished.

exported

Raised after the widget is exported.

exporting

Raised before the widget is exported.

fileSaving

Raised before a file with exported widget is saved to the user's local storage.

incidentOccurred

Raised when an error or warning occurs.

initialized

Raised only once, after the widget is initialized.

optionChanged

Raised after a widget option is changed.

tooltipHidden

Raised when a tooltip becomes hidden.

tooltipShown

Raised when a tooltip appears.

See Also