Home > @activeviam/activeui-sdk > FormatterImplementationProperties > format

FormatterImplementationProperties.format property

A function receiving the value and sometimes caption from the data and produces a caption to be displayed in the application. Sometimes the caption is undefined because the element to format does not come from the data. For example in the case of the formatter used for the axis of charts: On numerical axis, the values to format are for 'ticks', for which the values do not necessarily correspond to values in the data. Thus, a caption cannot be provided in that case.

Signature:

format: (value: string | number, caption: string) => string;