LineAnnotationDatum

@elastic/charts • Exports

---

@elastic/charts / LineAnnotationDatum

Interface: LineAnnotationDatum<D>

The descriptive object of a line annotation

Contents

• Type parameters
• Properties
  • dataValue
  • details?
  • header?

Type parameters

• D = any

Properties

dataValue

dataValue: D

The value on the x or y axis according to the domainType configured

Source

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

---

details?

details?: string

A textual description of the annotation

Source

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

---

header?

header?: string

An header of the annotation. If undefined, than the formatted dataValue will be used

Source

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

---

Generated using typedoc-plugin-markdown and TypeDoc