constructor

• new CategoryAxisBinning(binWidth?, numberOfBins?, overflow?, overflowThreshold?, underflow?, underflowThreshold?): CategoryAxisBinning

• Parameters

  • Optional binWidth: number

  • Optional numberOfBins: number

  • Optional overflow: boolean

  • Optional overflowThreshold: number

  • Optional underflow: boolean

  • Optional underflowThreshold: number

  Returns CategoryAxisBinning

• new CategoryAxisBinning(): CategoryAxisBinning

• Returns CategoryAxisBinning

• new CategoryAxisBinning(binWidth, numberOfBins, overflow, overflowThreshold, underflow, underflowThreshold, intervalClosedSide): CategoryAxisBinning

• Parameters

  • binWidth: number

  • numberOfBins: number

  • overflow: boolean

  • overflowThreshold: number

  • underflow: boolean

  • underflowThreshold: number

  • intervalClosedSide: IntervalClosedSide

  Returns CategoryAxisBinning

• new CategoryAxisBinning(..._rest): CategoryAxisBinning

• Parameters

  • Rest ..._rest: any[]

  Returns CategoryAxisBinning

Static $t

binWidth

• get binWidth(): number

• Returns the number of data points in each range, i.e., how many data points exist in each bin.

  Use this property to control the number of data points that should appear in each bin, allowing the total number of bins to be determined automatically.

  BinWidth and [[numberOfBins]] are mutually exclusive.

  See

  [[numberOfBins]]

  Returns number

• set binWidth(a): void

• Parameters

  • a: number

  Returns void

numberOfBins

• get numberOfBins(): number

• Returns the total number of bins.

  Use this property to control the number of bins that should appear, allowing the number of data points per bin to be determined automatically.

  NumberOfBins and [[binWidth]] are mutually exclusive.

  See

  [[binWidth]]

  Returns number

• set numberOfBins(a): void

• Parameters

  • a: number

  Returns void

overflow

• get overflow(): boolean

• Specifies whether a bin is created for all values above a given threshold.

  Setting this property to true causes a bin to be created for values above a given threshold.

  The threshold is determined automatically by default; use the [[overflowThreshold]] property to specify a threshold value.

  See

  • [[overflowThreshold]]
  • [[underflow]]

  Returns boolean

• set overflow(a): void

• Parameters

  • a: boolean

  Returns void

overflowThreshold

• get overflowThreshold(): number

• Determines the threshold for the [[overflow]] bin.

  This property is only applicable when the [[overflow]] property is set to true.

  When this property is left unset, the threshold is determined automatically.

  See

  • [[overflow]]
  • [[underflowThreshold]]

  Returns number

• set overflowThreshold(a): void

• Parameters

  • a: number

  Returns void

underflow

• get underflow(): boolean

• Specifies whether a bin is created for all values below a given threshold.

  Setting this property to true causes a bin to be created for values below a given threshold.

  The threshold is determined automatically by default; use the [[underflowThreshold]] property to specify a threshold value.

  See

  • [[overflowThreshold]]
  • [[overflow]]

  Returns boolean

• set underflow(a): void

• Parameters

  • a: boolean

  Returns void

underflowThreshold

• get underflowThreshold(): number

• Determines the threshold for the [[underflow]] bin.

  This property is only applicable when the [[underflow]] property is set to true.

  When this property is left unset, the threshold is determined automatically.

  See

  • [[underflow]]
  • [[underflowThreshold]]

  Returns number

• set underflowThreshold(a): void

• Parameters

  • a: number

  Returns void