DisplayValueSpec

@elastic/charts • Exports

---

@elastic/charts / DisplayValueSpec

Interface: DisplayValueSpec

Contents

• Properties
  • isAlternatingValueLabel?
  • overflowConstraints?
  • showValueLabel?
  • valueFormatter?

Properties

isAlternatingValueLabel?

isAlternatingValueLabel?: boolean

If value labels are shown, skips every other label

Default Value

false

Source

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

---

overflowConstraints?

overflowConstraints?: LabelOverflowConstraint[]

An option to hide the value label on certain conditions:

• barGeometry the label is not rendered if the width/height overflows the associated bar geometry,
• chartEdges the label is not rendered if it overflows the chart projection area.

Default Value

['barGeometry', 'chartEdges']

Source

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

---

showValueLabel?

showValueLabel?: boolean

Show value label in chart element

Default Value

false

Source

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

---

valueFormatter?

valueFormatter?: TickFormatter<any>

Function for formatting values; will use axis tickFormatter if none specified

Default Value

false

Source

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

---

Generated using typedoc-plugin-markdown and TypeDoc