Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class CategoryAxisBinning

Exposes properties related to category axis binning. Applicable only for Histogram and Pareto charts.

This class is immutable.

See

Series.axisBinning

Hierarchy

Hierarchy

  • Base
    • CategoryAxisBinning

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • Optional binWidth: number
    • Optional numberOfBins: number
    • Optional overflow: boolean
    • Optional overflowThreshold: number
    • Optional underflow: boolean
    • Optional underflowThreshold: number

    Returns CategoryAxisBinning

  • Returns CategoryAxisBinning

  • Parameters

    • binWidth: null | number
    • numberOfBins: null | number
    • overflow: boolean
    • overflowThreshold: null | number
    • underflow: boolean
    • underflowThreshold: null | number
    • intervalClosedSide: IntervalClosedSide

    Returns CategoryAxisBinning

  • Parameters

    • Rest ..._rest: any[]

    Returns CategoryAxisBinning

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

binWidth

  • get binWidth(): null | 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 null | number

  • set binWidth(a: null | number): void

  • Parameters

    • a: null | number

    Returns void

numberOfBins

  • get numberOfBins(): null | 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 null | number

  • set numberOfBins(a: null | number): void

  • Parameters

    • a: null | 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

    Returns boolean

  • set overflow(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

overflowThreshold

  • get overflowThreshold(): null | 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

    Returns null | number

  • set overflowThreshold(a: null | number): void

  • Parameters

    • a: null | 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

    Returns boolean

  • set underflow(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

underflowThreshold

  • get underflowThreshold(): null | 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

    Returns null | number

  • set underflowThreshold(a: null | number): void

  • Parameters

    • a: null | number

    Returns void

Methods

equals

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • Returns number

memberwiseClone

Static compare

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • Parameters

    • a: any
    • b: any

    Returns boolean