Documentation / @ripl/core / DivergingScaleOptions
Interface: DivergingScaleOptions
Defined in: packages/core/src/scales/diverging.ts:20
Options for a diverging scale, adding a midpoint to the base linear scale options.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
clamp? | boolean | Constrains mapped values to the range bounds, so out-of-domain inputs never overshoot. | LinearScaleOptions.clamp | packages/core/src/scales/_base/index.ts:38 |
midpoint? | number | The domain value that maps to the centre of the range. Defaults to the domain's midpoint. | - | packages/core/src/scales/diverging.ts:22 |
nice? | number | boolean | Expand the domain to round, tick-aligned boundaries at construction. true uses ~10 ticks; a number sets the target tick count. This is a construction-time option by design — scales stay plain callable objects with no chained .nice() method. | LinearScaleOptions.nice | packages/core/src/scales/_base/index.ts:46 |
padToTicks? | number | boolean | Expands the mapping domain to tick-aligned boundaries. true uses ~10 ticks; a number sets the target tick count. | LinearScaleOptions.padToTicks | packages/core/src/scales/_base/index.ts:40 |