Libraries.Compute.Statistics.Charts.LineChartCreator Documentation

This class is used to create a Line Chart from a dataframe. The class contains two possible inputs, factors and columns. Each column represents a line on the chart, while the single allowed factor represents where each data point will be mapped.

Example Code

use Libraries.Compute.Statistics.DataFrame
    use Libraries.Compute.Statistics.Charts.LineChartCreator

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

    LineChartCreator creator
    creator:AddColumn(1)
    creator:AddFactor(0)
    Chart chart = frame:CreateChart(creator)

    chart:SetTitle("Chocolate Interest over time")
    chart:SetXAxisTitle("Time Periods")
    chart:SetYAxisTitle("Popularity Percentage")
    chart:Display(1500, 75

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.
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.
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.
GetXTickCount()This action returns how many scale ticks should be used along the X axis of the LineChart.
GetYAxisMaximum()This action returns the maximum value on the Y axis, if one has been manually set.
GetYAxisMinimum()This action returns the minimum value on the Y axis, if one has been manually set.
GetYTickCount()This action returns how many scale ticks should be used along the Y axis of the LineChart.
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.
SetXTickCount(integer xTicks)This action sets how many scale ticks should be used along the X axis of the LineChart.
SetYAxisMaximum(number yAxisMaximum)This action manually sets the maximum value to present on the Y axis of the LineChart.
SetYAxisMinimum(number yAxisMinimum)This action manually sets the minimum value to present on the Y axis of the LineChart.
SetYTickCount(integer yTicks)This action sets how many scale ticks should be used along the Y axis of the LineChart.

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

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:

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.

GetXTickCount()

This action returns how many scale ticks should be used along the X axis of the LineChart. By default, this value is 5.

Return

integer: The number of ticks along the X axis of the LineChar

GetYAxisMaximum()

This action returns the maximum value on the Y axis, if one has been manually set. If no value has been set, the maximum Y axis value will be determined from the maximum value of the dataset used during the Create action. If no value has been set, this returns 1. To determine if a value has been manually set, use the "GetManualYAxisMaximum" action.

Return

number: The maximum value to be used for the Y axis, or 1 if no value has been manually se

GetYAxisMinimum()

This action returns the minimum value on the Y axis, if one has been manually set. If no value has been set, the minimum Y axis value will be determined from the minimum value of the dataset used during the Create action. If no value has been set, this returns 0. To determine if a value has been manually set, use the "GetManualYAxisMinimum" action.

Return

number: The minimum value to be used for the Y axis, or 0 if no value has been manually se

GetYTickCount()

This action returns how many scale ticks should be used along the Y axis of the LineChart. By default, this value is 5.

Return

integer: The number of ticks along the Y axis of the LineChar

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

SetXTickCount(integer xTicks)

This action sets how many scale ticks should be used along the X axis of the LineChart. By default, this value is 5.

Parameters

SetYAxisMaximum(number yAxisMaximum)

This action manually sets the maximum value to present on the Y axis of the LineChart.

Parameters

SetYAxisMinimum(number yAxisMinimum)

This action manually sets the minimum value to present on the Y axis of the LineChart.

Parameters

SetYTickCount(integer yTicks)

This action sets how many scale ticks should be used along the Y axis of the LineChart. By default, this value is 5.

Parameters