GroupBySpec

@elastic/charts • Exports

---

@elastic/charts / GroupBySpec

Interface: GroupBySpec<D>

Contents

• Extends
• Type parameters
• Properties
  • by
  • chartType
  • format?
  • id
  • sort
  • specType

Extends

• Spec

Type parameters

• D extends BaseDatum = any

Properties

by

by: GroupByAccessor<D>

Function to return a unique value by which to group the data

Source

packages/charts/src/specs/group_by.ts:37

---

chartType

chartType: ChartType

Chart type define the type of chart that use this spec

Inherited from

Spec.chartType

Source

packages/charts/src/specs/spec_type.ts:31

---

format?

format?: GroupByFormatter<D>

Formatter used on all by values.

Only for displayed values, not used in sorting or other internal computations.

Source

packages/charts/src/specs/group_by.ts:47

---

id

id: string

unique Spec identifier

Inherited from

Spec.id

Source

packages/charts/src/specs/spec_type.ts:29

---

sort

sort: Predicate

Sort predicate used to sort grouped data

Source

packages/charts/src/specs/group_by.ts:41

---

specType

specType: SpecType

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

Inherited from

Spec.specType

Source

packages/charts/src/specs/spec_type.ts:33

---

Generated using typedoc-plugin-markdown and TypeDoc