SeriesSeries

Series type adds extra features to uPlot series:

ConfigurationConfiguration

DataData

• series.data: (number | string | null)[] - series data

• series.transform?: (val: number | null | string, series: DataSeries[], idx: number) => number | null - series data transformation method

• series.postProcess?: (data: (number | null)[], idx: number, y: Yagr) => (number | null)[]; - series data post processing method (will be called if exists after all data transformations)

Name and IDName and ID

• series.name?: string - series name Renders in the tooltip and inline legend. If not this is not passed, Series <series index> name will be generated.

• series.id?: string - series ID, generated automatically if not passed

AppearanceAppearance

• series.color?: string - single property to avoid uPlot's fill/stroke for different series types For lines and points, color refers to the stroke color, while it is the fill color for areas and columns. Sets to black if not passed.

• series.width?: number - line width (line type charts)

• series.lineColor? string - line color (area type charts)

• series.lineWidth?: number - line width over area (area type charts)

• series.visible?: boolean; - series visibility

ScaleScale

• series.scale?: string - series scale

VisualizationVisualization

• series.type?: ChartType - series visualization type
• series.spanGaps?: boolean - join paths over null-points
• series.interpolation?: InterpolationSetting - series line interpolation type
• series.cursorOptions?: CursorOptions - series cursor options

Data referencesData references

• series.max?: number - comes from uPlot
• series.min?: number - comes from uPlot
• series.avg?: number - calculates before uPlot data will be set
• series.sum?: number - calculates before uPlot data will be set
• series.count?: number - calculates before uPlot data will be set

TooltipTooltip

• series.formatter?: (value: string | number | null, serie: Series) => string - formatter for series point values (formatting in tooltip)

• series.showInTooltip?: boolean - show series in tooltip, added to implement more flexible line hiding patterns

• series.precision?: number - series precision in tooltip Used to override axis precision.

Cursor snapToValues overrideCursor snapToValues override

series.snapToValues?: SnapToValue | false - snap dataIdx value (default: closest) Used to override cursor.snapToValues.

Stacking groupStacking group

series.stackGroup?: number - stack series group Used to combine series in different stacks. Keep in mind that stacks are just the sum of all real values, and stacks will be calculated wrong if there are data alignment artifacts on a given X-point on some lines. To avoid that, there are special data interpolation options in Yagr (see data alignment for more information). null values in stacks will be interpreted as zeros.

InterpolationInterpolation

Interpolation of line curves. Don't confuse it with data alignment interpolation
series.interpolation?: InterpolationSetting

type InterpolationType = 'linear' | 'left' | 'right' | 'smooth';

• linear - linear interpolation
  

• left - left interpolation (previous point value)
  

• right - right interpolation (next point value)
  

• smooth - smooth interpolation (Bezier curve interpolation)