ig.excel.CategoryAxisBinning
Remarks
This class is immutable.
Dependencies
-
ig.excel.CategoryAxisBinning
Constructor- new $.ig.excel.CategoryAxisBinning( [binWidth:number], [numberOfBins:number], [overflow:boolean], [overflowThreshold:number], [underflow:boolean], [underflowThreshold:number] );
Creates a new instance with the specified property values.
- binWidth
- Type:number
- Optional
- Specifies the value of the CategoryAxisBinning.binWidth property.
- numberOfBins
- Type:number
- Optional
- Specifies the value of the CategoryAxisBinning.numberOfBins property.
- overflow
- Type:boolean
- Optional
- Specifies the value of the CategoryAxisBinning.overflow property.
- overflowThreshold
- Type:number
- Optional
- Specifies the value of the CategoryAxisBinning.overflowThreshold property.
- underflow
- Type:boolean
- Optional
- Specifies the value of the CategoryAxisBinning.underflow property.
- underflowThreshold
- Type:number
- Optional
- Specifies the value of the CategoryAxisBinning.underflowThreshold property.
-
binWidth
- .binWidth( );
Returns the number of data points in each range, i.e., how many data points exist in each bin.
Remarks
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 CategoryAxisBinning.numberOfBins are mutually exclusive.
-
numberOfBins
- .numberOfBins( );
Returns the total number of bins.
Remarks
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 CategoryAxisBinning.binWidth are mutually exclusive.
-
overflow
- .overflow( );
Specifies whether a bin is created for all values above a given threshold.
Remarks
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 CategoryAxisBinning.overflowThreshold property to specify a threshold value.
-
overflowThreshold
- .overflowThreshold( );
Determines the threshold for the CategoryAxisBinning.overflow bin.
Remarks
This property is only applicable when the CategoryAxisBinning.overflow property is set to true.
When this property is left unset, the threshold is determined automatically.
-
underflow
- .underflow( );
Specifies whether a bin is created for all values below a given threshold.
Remarks
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 CategoryAxisBinning.underflowThreshold property to specify a threshold value.
-
underflowThreshold
- .underflowThreshold( );
Determines the threshold for the CategoryAxisBinning.underflow bin.
Remarks
This property is only applicable when the CategoryAxisBinning.underflow property is set to true.
When this property is left unset, the threshold is determined automatically.