Libraries.Compute.Statistics.Charts.HistogramCreator Documentation

This class is used to create a histogram for use in an application. By default, it uses the Freedman-Diaconis rule for bin widths, which provides a reasonable looking histogram in most cases. More information can be found at: https://en.wikipedia.org/wiki/Freedman%E2%80%93Diaconis_rule

Example Code

use Libraries.Compute.Statistics.DataFrame
    use Libraries.Compute.Statistics.Charts.HistogramCreator

    DataFrame frame
    frame:Load("Data/Data.csv")

    //Create a Bar Chart and set some properties
    DataFrame frame
    frame:Load("Data/Data.csv")

    HistogramCreator creator
    creator:SetValueColumn("DRT")

    Chart chart = frame:CreateChart(creator)

    chart:SetTitle("Histogram")
    chart:SetYAxisTitle("Frequency")
    chart:SetXAxisTitle("DT")

    //we might then add this chart to a gam

Inherits from: Libraries.Compute.Statistics.DataFrameChartCreator, Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Create(Libraries.Compute.Statistics.DataFrame frame)
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetBinWidth()Obtains what the bin width wa
GetColumn()Returns the name of the value column specifie
GetHashCode()This action gets the hash code for an object.
GetTicks()This returns the number of ticks to present on the chart.
SetBinWidth(number binWidthOverride)Manually changes the bin widt
SetColumn(integer column)Sets the name of the name column specifie
SetTicks(integer ticks)This sets the number of ticks to present on the chart.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smalle

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Create(Libraries.Compute.Statistics.DataFrame frame)

Parameters

Return

Libraries.Interface.Controls.Charts.Chart

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetBinWidth()

Obtains what the bin width wa

Return

number:

GetColumn()

Returns the name of the value column specifie

Return

integer:

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode

Return

integer: The integer hash code of the object.

GetTicks()

This returns the number of ticks to present on the chart.

Return

integer: the number of tic

SetBinWidth(number binWidthOverride)

Manually changes the bin widt

Parameters

SetColumn(integer column)

Sets the name of the name column specifie

Parameters

SetTicks(integer ticks)

This sets the number of ticks to present on the chart.

Parameters