Skip to main content

SeriesSpec

Default spec for all XY series specs.

Overrides​

  • specType -> SpecType.Series
  • chartType -> ChartType.XYAxis

Props​

Spec Props​

Inherits Spec props

name​

  • Type: name?: SeriesNameAccessor

The name of the spec. Also a mechanism to provide custom series names.

groupId​

  • Type: groupId: string
  • Default: DEFAULT_GLOBAL_ID

The ID of the spec group

useDefaultGroupDomain​

  • Type: useDefaultGroupDomain?: boolean | string

When specify a groupId on this series, this option can be used to compute this series domain as it was part of the default group (when using the boolean value true) or as the series was part of the specified group (when issuing a string).

data​

  • Type: data: D[]

Array of data

seriesType​

  • Type: seriesType: SeriesType

The type of series you are looking to render

color​

  • Type: color?: SeriesColorAccessor

Color configuration to assign colors to specific series.

hideInLegend​

  • Type: hideInLegend?: boolean
  • Default: false

If the series should appear in the legend

displayValueSettings​

  • Type: displayValueSettings?: DisplayValueSpec

y0AccessorFormat​

  • Type: y0AccessorFormat?: AccessorFormat
  • Default: - upper

Postfix string or accessor function for y1 accessor when using y0Accessors

y1AccessorFormat​

  • Type: y1AccessorFormat?: AccessorFormat
  • Default: - lower

Postfix string or accessor function for y1 accessor when using y0Accessors

filterSeriesInTooltip​

  • Type: filterSeriesInTooltip?: FilterPredicate

Predicate used to hide series in tooltip.

tickFormat​

  • Type: tickFormat?: TickFormatter
  • Default: tickFormat

A function called to format every value label.