• Public
  • Public/Protected
  • All

Interface SplineSeriesOptions

Interface for readonly configuration of SplineSeries.

Commonly used properties:

Example usage:

 // Example 1, create series with default configuration.
 const series = ChartXY.addSplineSeries({})
 // Example 2, select shape of point markers.
 const series = ChartXY.addSplineSeries({
     pointShape: PointShape.Circle



Optional automaticColorIndex

automaticColorIndex : undefined | number

Optional index to use for automatic coloring of series.

Normally series are automatically colored differently when you create several series in the same chart. However, in some cases you might want to alter this order of automatic coloring, or use the automatic color palettes on series that belong to different charts.

In these scenarios you can use automaticColorIndex to tell each series individually what is its place in the default color palette.

 // Create series using the first color in default Theme palette.
 const series1 = chart.addLineSeries({ automaticColorIndex: 0 })
 // Create another series colored with the 3rd color.
 const series2 = chart.addLineSeries({ automaticColorIndex: 2 })

Optional dataPattern

dataPattern : DataPattern

Interface for enabling powerful application specific optimizations if input data follows a specific pattern.

See DataPattern to learn if your data is eligible for such optimizations.

Example usage:

 // Example, Line Chart with timestamp X values that always progress by exactly 1 minute (60000 ms).
 // => 'ProgressiveX' + regularProgressiveStep can be used
     dataPattern: {
         // pattern: 'ProgressiveX' => Each consecutive data point has increased X coordinate.
         pattern: 'ProgressiveX',
         // regularProgressiveStep: true => The X step between each consecutive data point is regular (for example, always `1.0`).
         regularProgressiveStep: true,

Optional pointShape

pointShape : PointShape

Shape of point markers.

Select value from PointShape.

 // Example, select Circle shape of points.
 const series = ChartXY.addPointLineSeries({
     pointShape: PointShape.Circle

Optional xAxis

xAxis : Axis

Optional non-default X Axis to attach series to.

By default, series are attached to the same X Axis, that is returned by ChartXY.getDefaultAxisX.

Optional yAxis

yAxis : Axis

Optional non-default Y Axis to attach series to.

By default, series are attached to the same Y Axis, that is returned by ChartXY.getDefaultAxisY.