Skip to content

Documentation / @ripl/core / SymlogScaleOptions

Interface: SymlogScaleOptions ​

Defined in: packages/core/src/scales/symlog.ts:26

Options for a symmetric-log scale, adding a configurable linear threshold to the base linear scale options.

Extends ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
clamp?booleanConstrains mapped values to the range bounds, so out-of-domain inputs never overshoot.LinearScaleOptions.clamppackages/core/src/scales/_base/index.ts:35
constant?numberThe linear threshold C; the region `x< C` around zero is treated approximately linearly, with logarithmic compression taking over beyond it. A larger constant widens the near-zero linear region. Defaults to 1.
nice?number | booleanExpand 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.nicepackages/core/src/scales/_base/index.ts:43
padToTicks?number | booleanExpands the mapping domain to tick-aligned boundaries. true uses ~10 ticks; a number sets the target tick count.LinearScaleOptions.padToTickspackages/core/src/scales/_base/index.ts:37