Libraries.Compute.Statistics.Charts.BarChartCreator Documentation

This class is used to create a Bar Chart from columns of data in a DataFrame. This creator is also capable of using columns and factors. If only one column is given, the system counts the number of items for each point. If a factor and a column are given, the factor is the X-axis and the column is the Y-axis.

Example Code

use Libraries.Compute.Statistics.DataFrame
    use Libraries.Compute.Statistics.Charts.BarChartCreator

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

    //Create a Bar Chart and set some properties
    BarChartCreator creator
    creator:AddColumn(4)
    creator:AddFactor(0)
    creator:SetXSteps(4)

    Chart chart = frame:CreateChart(creator)
    chart:Display(2000,100

Inherits from: Libraries.Compute.Statistics.DataFrameChartCreator, Libraries.Compute.Statistics.Inputs.ColumnInput, Libraries.Language.Object, Libraries.Compute.Statistics.Inputs.FactorInput

Summary

Actions Summary Table

ActionsDescription
AddColumn(integer column)This action adds a value to the end of the input.
AddFactor(integer column)This action adds a value to the end of the input.
CalculateValueSet(Libraries.Compute.Statistics.DataFrameColumn column)
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Create(Libraries.Compute.Statistics.DataFrame frame)
EmptyColumns()This action empty's the list, clearing out all of the items contained within i
EmptyFactors()This action empty's the list, clearing out all of the items contained within i
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetColumn(integer index)This action gets the item at a given location in an array.
GetColumnIterator()This action gets an iterator for the object and returns that iterator.
GetColumnSize()This action gets the size of the array.
GetComparison()Sets the maxiumum value that will appear at the top of the scale.
GetFactor(integer index)This action gets the item at a given location in an array.
GetFactorIterator()This action gets an iterator for the object and returns that iterator.
GetFactorSize()This action gets the size of the array.
GetHashCode()This action gets the hash code for an object.
GetXSteps()
GetYSteps()
IsEmptyColumns()This action returns a boolean value, true if the container is empty and false if it contains any items.
IsEmptyFactors()This action returns a boolean value, true if the container is empty and false if it contains any items.
RemoveColumn(integer column)This action removes the first occurrence of an item that is found in the Addable object.
RemoveColumnAt(integer index)This action removes an item from an indexed object and returns that item.
RemoveFactor(integer column)This action removes the first occurrence of an item that is found in the Addable object.
RemoveFactorAt(integer index)This action removes an item from an indexed object and returns that item.
SetComparison(Libraries.Containers.Support.Comparison comparison)Sets the maxiumum value that will appear at the top of the scale.
SetScaleMaximum(number max)Sets the maxiumum value that will appear at the top of the scale.
SetScaleMinimum(number min)Sets the maxiumum value that will appear at the top of the scale.
SetXSteps(integer steps)Sets the number of steps in the scal
SetYSteps(integer steps)Sets the number of steps in the scal

Actions Documentation

AddColumn(integer column)

This action adds a value to the end of the input.

Parameters

AddFactor(integer column)

This action adds a value to the end of the input.

Parameters

CalculateValueSet(Libraries.Compute.Statistics.DataFrameColumn column)

Parameters

Return

Libraries.Containers.Array

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

EmptyColumns()

This action empty's the list, clearing out all of the items contained within i

EmptyFactors()

This action empty's the list, clearing out all of the items contained within i

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.

GetColumn(integer index)

This action gets the item at a given location in an array.

Parameters

Return

integer: The item at the given locatio

GetColumnIterator()

This action gets an iterator for the object and returns that iterator.

Return

Libraries.Containers.Iterator: Returns the iterator for an objec

GetColumnSize()

This action gets the size of the array.

Return

integer:

GetComparison()

Sets the maxiumum value that will appear at the top of the scale. Note that the other values of the scale will be affected by the maximu

Return

Libraries.Containers.Support.Comparison:

GetFactor(integer index)

This action gets the item at a given location in an array.

Parameters

Return

integer: The item at the given locatio

GetFactorIterator()

This action gets an iterator for the object and returns that iterator.

Return

Libraries.Containers.Iterator: Returns the iterator for an objec

GetFactorSize()

This action gets the size of the array.

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.

GetXSteps()

Return

integer

GetYSteps()

Return

integer

IsEmptyColumns()

This action returns a boolean value, true if the container is empty and false if it contains any items.

Return

boolean: Returns true when the container is empty and false when it is no

IsEmptyFactors()

This action returns a boolean value, true if the container is empty and false if it contains any items.

Return

boolean: Returns true when the container is empty and false when it is no

RemoveColumn(integer column)

This action removes the first occurrence of an item that is found in the Addable object.

Parameters

Return

boolean: Returns true if the item was removed and false if it was not remove

RemoveColumnAt(integer index)

This action removes an item from an indexed object and returns that item.

Parameters

RemoveFactor(integer column)

This action removes the first occurrence of an item that is found in the Addable object.

Parameters

Return

boolean: Returns true if the item was removed and false if it was not remove

RemoveFactorAt(integer index)

This action removes an item from an indexed object and returns that item.

Parameters

SetComparison(Libraries.Containers.Support.Comparison comparison)

Sets the maxiumum value that will appear at the top of the scale. Note that the other values of the scale will be affected by the maximu

Parameters

SetScaleMaximum(number max)

Sets the maxiumum value that will appear at the top of the scale. Note that the other values of the scale will be affected by the maximu

Parameters

SetScaleMinimum(number min)

Sets the maxiumum value that will appear at the top of the scale. Note that the other values of the scale will be affected by the maximu

Parameters

SetXSteps(integer steps)

Sets the number of steps in the scal

Parameters

SetYSteps(integer steps)

Sets the number of steps in the scal

Parameters