formatParameterValue

Formats a control's position back into a label for the reader, such as Mar, 09:30 or 2024-W12. The inverse of parameterValueOf.

@internote/canvas-sdkFunction
On this page
import { formatParameterValue } from '@internote/canvas-sdk';

Between two stops, as during a glide, a name reads as the nearer one and a date as the nearer day; a plain number keeps the places its step needs.

#Signature

(value: number, kind: NumberLineKind, step?: number): string

#Parameters

value
The position on the kind's number line.
kind
The parameter's kind, which says which number line the position is on.
step
The parameter's step, which decides a plain number's decimal places.

Declared in packages/canvas-sdk/src/data/parameter-values.ts:149.

Last updated