The requested page is not available for the requested platform. You are viewing the content for Default platform.

BootstrapChartSeriesTemplateSettings Class

Stores settings for the series template.

Namespace: DevExpress.Web.Bootstrap

Assembly: DevExpress.Web.Bootstrap.v19.2.dll

Declaration

public class BootstrapChartSeriesTemplateSettings :
    JsonProperties,
    IDataSourceViewSchemaAccessor,
    IClientCustomModifier
Public Class BootstrapChartSeriesTemplateSettings
    Inherits JsonProperties
    Implements IDataSourceViewSchemaAccessor,
               IClientCustomModifier

Remarks

In most cases, you can organize the array that is assigned to the chart's BootstrapWebClientUIWidget.DataSource property in the following way.


[
    {arg: arg1Value, series1Value: val11, series2Value: val12, ...}
    {arg: arg2Value, series1Value: val21, series2Value: val22, ...}
    ...
    {arg: argNValue, series1Value: valN1, series2Value: valN2, ...}
]

Each object that is included in the array represents an argument value and the values of all series for this argument.

However, there are some scenarios in which you do not know exactly how many series will be added. In these cases, you will not be able to define the data source in the manner detailed above. Instead, define it in the following way.


[
    {seriesName: series1, arg: arg11Value, val: value11 }
    {seriesName: series1, arg: arg12Value, val: value12 }
    ...
    {seriesName: seriesM, arg: argM1Value, val: valueM1 }
    {seriesName: seriesM, arg: argM2Value, val: valueM2 }
    ...
]

If you define a data source in this manner, set the argument and value fields using the BootstrapChartCommonSeriesBase.ArgumentField and BootstrapChartSeries.ValueField properties . Then, define a template for the series using the BootstrapChartSeriesTemplateSettings class. Within this class, set the data source field that specifies the series name to the BootstrapChartSeriesTemplateSettings.NameField property.

If you need to specify individual values for options of a particular series, assign a callback function to the BootstrapChartSeriesTemplateSettings.OnClientCustomizeSeries property.

Inheritance

Object
StateManager
PropertiesBase
DevExpress.Web.Bootstrap.Internal.JsonProperties
BootstrapChartSeriesTemplateSettings
See Also