Contents Previous Next


GetHistogramBars Method (BDKInput Object)

Description

Returns the bar boundaries and heights for a histogram graph of the input data.

Syntax

object.GetHistogramBars(numBins as Integer, barBoundaries() as Double, barHeights() as Double, Optional min, Optional max)

Arguments

numBars (Required Integer) – the number of bars in the histogram. Set to BDKAutoNumBins to determine the number of bins dynamically based of the number of data points.

barBoundaries (Required Array of Doubles) – the boundaries of the histogram bins. This array is automatically dimensioned from 1 to 1+numBins. The first value in the array is the left side of the first histogram bin. The last value in the array is the right side of the last histogram bin.

barHeights (Required Array of Doubles) – the heights of the histogram bars. This array is automatically dimensioned from 1 to numBins.

min (Optional Double) – set this value to change where the left side of the first bin will be placed. If left out, this argument defaults to the minimum value in the data set.

max (Optional Double) – set this value to change where the right side of the last bin will be placed. If left out, this argument defaults to the maximum value in the data set.

Return Value

None.

Example

'Get the boundaries and heights of a 10 bin histogram:
Dim bounds() as Double, heights() as Double
InputObj.GetHistogramBars(10, bounds(), heights())