resolveNumber

Evaluates a value that may be a number, an expression or a date to a number, at the current parameter values, or returns fallback.

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

An expression is a refined { js } value; a date gives the fractional year it falls at, which is the number a date plots at on a numeric axis. A string that parses as a number is taken as one.

#Signature

(value: unknown, params: Record<string, number>, fallback?: number): number

#Parameters

value
A refined attribute value.
params
The parameter values, such as ctx.parameters.numbers().
fallback
What to return when the value does not come out as a number.

#Example

const radius = resolveNumber(attrs.radius, ctx.parameters.numbers(), 4);

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

Last updated