Configuration

This option supports the following colors.

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

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

This option supports the following colors.

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

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

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

• argumentField
• valueField
• getDataSource()
• Data Layer - Overview
• Data Layer - Data Source Examples

You can configure this option in an ASP.NET MVC Control as follows:

@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

This option supports the following colors.

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG 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.

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.

This option supports the following colors.

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

This option supports the following colors.

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

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

This option supports the following colors.

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG 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.

This option supports the following colors.

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG 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.

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.

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.

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.

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.

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.

You cannot access elements in the widget because this handler is executed before they are ready. Use the onContentReady handler instead.

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.

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.

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

• DevExpress.viz.refreshPaths()

This option supports the following colors.

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

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

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.

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

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.

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.

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.

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

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.

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.

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

When using the widget as an ASP.NET MVC Control, 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

This option supports the following colors.

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

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

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.