Home > @datashaper/schema > BinArgs
Signature:
export interface BinArgs extends InputColumnArgs, OutputColumnArgs Extends: InputColumnArgs, OutputColumnArgs
| Property | Modifiers | Type | Description |
|---|---|---|---|
| clamped? | boolean | (Optional) If true, values outside of the min/max boundaries will be clamped to those boundaries rather than +/-Infinity. | |
| fixedcount? | number | (Optional) Fixed number of bins. Note that the bin placements are inclusive of the bottom boundary and exclusive of the top boundary - this means there is always one extra bin for the max value when using fixed count. | |
| fixedwidth? | number | (Optional) Exact step size between bins | |
| max? | number | (Optional) Max boundary to categorize values into. If cell values are above this, they will default to +Infinity unless clamped. | |
| min? | number | (Optional) Min boundary to categorize values into. If cell values are below this, they will default to -Infinity unless clamped. | |
| nice? | boolean | (Optional) Indicates whether bins should be rounded in a readable human-friendly way. | |
| printRange? | boolean | (Optional) If true, the range for each bin will be printed as the cell value instead of the truncated numeric value. | |
| strategy | BinStrategy | Binning technique to use. |