planeModelDefaultRange
Returns the default axis range definePlane() uses for a channel of a model.
import { planeModelDefaultRange } from '@pbroom/color-kit/plane';model-specs.ts:462function planeModelDefaultRange(
model: PlaneModel,
channel: PlaneChannel,
): [number, number] | undefined;Some defaults are descending (OKLCH and HCT chroma, HCT tone, HSL/HSV saturation, lightness and value, OKLab b) so that larger values sit at y = 0, the top of a screen-space plane.
Parameters
- model
PlaneModel - Plane model to inspect.
- channel
PlaneChannel - Channel whose default range should be read.
Returns
[number, number] | undefinedA new [start, end] tuple, or undefined when the model has no such channel.
Throws
- When
modelis not a supported plane model.
Example
import { planeModelDefaultRange } from '@pbroom/color-kit/plane';
planeModelDefaultRange('oklch', 'c'); // → [0.4, 0]
planeModelDefaultRange('hsl', 'l'); // → [100, 0]
planeModelDefaultRange('oklch', 'r'); // → undefinedSee also
Also exported from
@pbroom/color-kitthe same declaration, re-exported