Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implemented by

Index

Methods

anchor

  • A value in the binned domain at which to anchor the bins, shifting the bin boundaries if necessary to ensure that a boundary aligns with the anchor value. By default, the minimum bin extent value serves as the anchor.

    Parameters

    • value: number

    Returns BinBuilder

as

  • The output fields at which to write the start and end bin values. The default is ["bin0", "bin1"].

    Parameters

    • start: string
    • end: string

    Returns BinBuilder

base

  • The number base to use for automatic bin determination (default 10).

    Parameters

    • value: number

    Returns BinBuilder

build

divide

  • Allowable bin step sub-divisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base) automatic bin determination can consider dividing bin step sizes by 5 and/or 2.

    Parameters

    • values: number[]

    Returns BinBuilder

extent

  • Sets the minimum and maximum values of the bin range. (required)

    Parameters

    • start: number
    • end: number

    Returns BinBuilder

field

maxBins

minStep

nice

  • If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.

    Parameters

    • value: boolean

    Returns BinBuilder

step

  • An exact step size to use between bins. If provided, options such as maxbins will be ignored.

    Parameters

    • value: number

    Returns BinBuilder

steps