color-kitnext

@pbroom/color-kit/planeTypes

PlaneDefinition

Input shape accepted by definePlane().

interfaceimport type { PlaneDefinition } from '@pbroom/color-kit/plane';types.ts:125
interface PlaneDefinition<Model extends PlaneModel = PlaneModel> {
  model?: Model;
  x?: PlaneAxis<Model>;
  y?: PlaneAxis<Model>;
  fixed?: PlaneFixedInput<Model>;
  color?: Color;
}

Properties

model?Model

Plane model.

Defaults to 'oklch' when omitted.

x?PlaneAxis<Model>

Horizontal axis.

Defaults to the model's PLANE_MODEL_DEFAULT_AXES[model].x (l for OKLCH) with its default range.

y?PlaneAxis<Model>

Vertical axis.

Defaults to the model's PLANE_MODEL_DEFAULT_AXES[model].y (c for OKLCH) with its default range.

fixed?PlaneFixedInput<Model>

Optional fixed channels for non-axis dimensions.

Channels are interpreted relative to model, unsupported names throw, and defaults are model-specific.

color?Color

Optional anchor color converted into the selected model before resolving fixed.

Useful when switching models: omitted fixed channels are derived from this color, while explicitly provided fixed values still win.

Also exported from