formatLiveValue

Formats a live value for display in text: about four significant figures, or an em dash when there is no value yet.

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

The em dash covers a server render, an environment that has not mounted and a value the surface could not compute. Every live number on a page goes through this, so one in prose and one in a mark's label read alike.

#Signature

(value: number | undefined, options?: LiveValueFormatOptions): string

#Parameters

value
The value, or undefined for one not yet published.
options
How many figures to show.

Declared in packages/canvas-sdk/src/content/live-value-store.ts:317.

Last updated