Skip to main content

SeriesSpec

@elastic/charts • Exports

@elastic/charts / SeriesSpec

Interface: SeriesSpec<D>

Contents​

Extends​

Type parameters​

• D extends BaseDatum = Datum

Properties​

chartType​

chartType: "xy_axis"

Chart type define the type of chart that use this spec

Overrides​

Spec.chartType

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:405

color?​

color?: SeriesColorAccessor

Set colors for specific series

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:426

data​

data: D[]

An array of data

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:422

displayValueSettings?​

displayValueSettings?: DisplayValueSpec

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:432

filterSeriesInTooltip?​

filterSeriesInTooltip?: FilterPredicate

Hide series in tooltip

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:448

groupId​

groupId: string

The ID of the spec group

Default Value​

{@link DEFAULT_GLOBAL_ID}

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:414

hideInLegend?​

hideInLegend?: boolean

If the series should appear in the legend

Default Value​

false

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:431

id​

id: string

unique Spec identifier

Inherited from​

Spec.id

Source​

packages/charts/src/specs/index.ts:14

name?​

name?: SeriesNameAccessor

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

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:409

seriesType​

seriesType: SeriesType

The type of series you are looking to render

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:424

specType​

specType: "series"

The type of spec, can be series, axis, annotation, settings etc

Overrides​

Spec.specType

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:404

tickFormat?​

tickFormat?: TickFormatter<any>

A function called to format every value label. Uses axis tickFormat when not provided.

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:453

useDefaultGroupDomain?​

useDefaultGroupDomain?: string | boolean

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)

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:420

y0AccessorFormat?​

y0AccessorFormat?: AccessorFormat

Postfix string or accessor function for y1 accessor when using y0Accessors

Default Value​

- upper

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:438

y1AccessorFormat?​

y1AccessorFormat?: AccessorFormat

Postfix string or accessor function for y1 accessor when using y0Accessors

Default Value​

- lower

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:444

Generated using typedoc-plugin-markdown and TypeDoc