Skip to content

fun ​

Makes a function value: a function of t over an interval. The shape form of ribbon and line reads it in a channel, at one parameter t.

Signature ​

ts
fun(at, { domain, knots? })
f.domain()

Parameters ​

OptionTypeDefaultDescription
at(t: number) => numberrequiredThe function's value at t.
domain[min, max]requiredThe interval of t the function is defined over. Both ends are finite, and min < max.
knotsnumber[]nonePlaces in the domain where the function may bend sharply. A mark splits its drawing there.

The value ​

A function value is the same function in every group. For one function per group, return a function value from a reduce: field("x").reduce((xs) => fun(...)) (see map and reduce). It is an expression a mark reads, so it has no at to call. It has one method:

  • f.domain() is t ↦ t over the domain of f. It is the position channel that reads f at the mark's parameter: line({ x: f.domain(), y: f }).

A mark draws a function value by sampling it until the drawn path is within half a pixel of the function, and it finds the function's extent the same way. Under a coordinate transform the path is resampled again through the transform.

A function value is only valid in a channel of the shape form of ribbon and line. In any other mark's channel it is a type error and a run-time error. A plain JS function in a channel is still a row accessor, as before.

A function value has no JSON form, so a spec that holds one does not serialize it.

Example ​

ts
const bump = fun((t) => 1 + Math.exp(-((t - 4) ** 2)), { domain: [0, 10] });

line({ x: bump.domain(), y: bump }).render(container, { w: 400, h: 300 });