API / Utilities / ValueFormat

ValueFormat: NumberFormat | DateFormat

Defined in: src/core/types/chart/base.ts:39

Specifies how a value should be formatted for display.

• { type: 'number' } — numeric formatting with optional precision, units, percent display, etc.
  See FormatNumberOptions for all available options.
• { type: 'date' } — date/time formatting

ExamplesExamples

// Two decimal places, shown as percent
{ type: 'number', precision: 2, format: 'percent' }

// Compact thousands: 1 500 000 → "1.5M"
{ type: 'number', unit: 'auto', precision: 1 }

// Date value (Unix ms) formatted as "17 October 2025"
{ type: 'date', format: 'DD MMMM YYYY' }