Libraries.Compute.Statistics.Charts.ScatterPlotCreator Documentation

This class is used to create a scatter plot for use in an application.

Example Code

use Libraries.Compute.Statistics.DataFrame
    use Libraries.Compute.Statistics.Charts.ScatterPlotCreator

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

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

    ScatterPlotCreator creator
    creator:SetXColumn("DT")
    creator:SetYColumn("FS")

    Chart chart = frame:CreateChart(creator)

    chart:SetTitle("Scatter Plot")
    chart:SetYAxisTitle("FS")
    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.
GetHashCode()This action gets the hash code for an object.
GetManualXAxisMaximum()This action returns true if the ScatterPlotCreator is using a manually set maximum value for the X axis, or false otherwise.
GetManualXAxisMinimum()This action returns true if the ScatterPlotCreator is using a manually set minimum value for the X axis, or false otherwise.
GetManualYAxisMaximum()This action returns true if the ScatterPlotCreator is using a manually set maximum value for the Y axis, or false otherwise.
GetManualYAxisMinimum()This action returns true if the ScatterPlotCreator is using a manually set minimum value for the Y axis, or false otherwise.
GetXAxisMaximum()This action returns the maximum value on the X axis, if one has been manually set.
GetXAxisMinimum()This action returns the minimum value on the X axis, if one has been manually set.
GetXColumn()This action returns the identifier of a column from a DataFrame.
GetXTickCount()This action returns how many scale ticks should be used along the X axis of the ScatterPlot.
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.
GetYColumn()This action returns the identifier of a column from a DataFrame.
GetYTickCount()This action returns how many scale ticks should be used along the Y axis of the ScatterPlot.
SetManualXAxisMaximum(boolean manualXAxisMaximum)This action sets whether or not the creator should automatically determine the maximum value of the X axis from the provided dataset during the Create action.
SetManualXAxisMinimum(boolean manualXAxisMinimum)This action sets whether or not the creator should automatically determine the minimum value of the X axis from the provided dataset during the Create action.
SetManualYAxisMaximum(boolean manualYAxisMaximum)This action sets whether or not the creator should automatically determine the maximum value of the Y axis from the provided dataset during the Create action.
SetManualYAxisMinimum(boolean manualYAxisMinimum)This action sets whether or not the creator should automatically determine the minimum value of the Y axis from the provided dataset during the Create action.
SetXAxisMaximum(number xAxisMaximum)This action manually sets the maximum value to present on the X axis of the ScatterPlot.
SetXAxisMinimum(number xAxisMinimum)This action manually sets the minimum value to present on the X axis of the ScatterPlot.
SetXColumn(text xColumn)This action is used to select a column from a DataFrame by name.
SetXTickCount(integer xTicks)This action sets how many scale ticks should be used along the X axis of the ScatterPlot.
SetYAxisMaximum(number yAxisMaximum)This action manually sets the maximum value to present on the Y axis of the ScatterPlot.
SetYAxisMinimum(number yAxisMinimum)This action manually sets the minimum value to present on the Y axis of the ScatterPlot.
SetYColumn(text yColumn)This action is used to select a column from a DataFrame by name.
SetYTickCount(integer yTicks)This action sets how many scale ticks should be used along the Y axis of the ScatterPlot.

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.

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.

GetManualXAxisMaximum()

This action returns true if the ScatterPlotCreator is using a manually set maximum value for the X axis, or false otherwise. By default, this returns false.

Return

boolean: True if using a manually set maximum X value, or false otherwis

GetManualXAxisMinimum()

This action returns true if the ScatterPlotCreator is using a manually set minimum value for the X axis, or false otherwise. By default, this returns false.

Return

boolean: True if using a manually set minimum X value, or false otherwis

GetManualYAxisMaximum()

This action returns true if the ScatterPlotCreator is using a manually set maximum value for the Y axis, or false otherwise. By default, this returns false.

Return

boolean: True if using a manually set maximum Y value, or false otherwis

GetManualYAxisMinimum()

This action returns true if the ScatterPlotCreator is using a manually set minimum value for the Y axis, or false otherwise. By default, this returns false.

Return

boolean: True if using a manually set minimum Y value, or false otherwis

GetXAxisMaximum()

This action returns the maximum value on the X axis, if one has been manually set. If no value has been set, the maximum X 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 "GetManualXAxisMaximum" action.

Return

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

GetXAxisMinimum()

This action returns the minimum value on the X axis, if one has been manually set. If no value has been set, the minimum X 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 "GetManualXAxisMinimum" action.

Return

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

GetXColumn()

This action returns the identifier of a column from a DataFrame. This column is used to indicate the X value of each point on the ScatterPlot.

Return

text: The column name of the X variable on the ScatterPlo

GetXTickCount()

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

Return

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

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

GetYColumn()

This action returns the identifier of a column from a DataFrame. This column is used to indicate the Y value of each point on the ScatterPlot.

Return

text: The column name of the Y variable on the ScatterPlo

GetYTickCount()

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

Return

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

SetManualXAxisMaximum(boolean manualXAxisMaximum)

This action sets whether or not the creator should automatically determine the maximum value of the X axis from the provided dataset during the Create action. Passing this action the "true" value will make it use the manually set value from SetXAxisMaximum, and using "false" will make it automatically determine the value from the data. By default, this value is false. Setting the value manually via SetXAxisMaximum also automatically sets this value, so typically this action is only needed to reset a creator to its default behavior via SetManualXAxisMaximum(false).

Parameters

SetManualXAxisMinimum(boolean manualXAxisMinimum)

This action sets whether or not the creator should automatically determine the minimum value of the X axis from the provided dataset during the Create action. Passing this action the "true" value will make it use the manually set value from SetXAxisMinimum, and using "false" will make it automatically determine the value from the data. By default, this value is false. Setting the value manually via SetXAxisMinimum also automatically sets this value, so typically this action is only needed to reset a creator to its default behavior via SetManualXAxisMinimum(false).

Parameters

SetManualYAxisMaximum(boolean manualYAxisMaximum)

This action sets whether or not the creator should automatically determine the maximum value of the Y axis from the provided dataset during the Create action. Passing this action the "true" value will make it use the manually set value from SetYAxisMaximum, and using "false" will make it automatically determine the value from the data. By default, this value is false. Setting the value manually via SetYAxisMaximum also automatically sets this value, so typically this action is only needed to reset a creator to its default behavior via SetManualYAxisMaximum(false).

Parameters

SetManualYAxisMinimum(boolean manualYAxisMinimum)

This action sets whether or not the creator should automatically determine the minimum value of the Y axis from the provided dataset during the Create action. Passing this action the "true" value will make it use the manually set value from SetYAxisMinimum, and using "false" will make it automatically determine the value from the data. By default, this value is false. Setting the value manually via SetYAxisMinimum also automatically sets this value, so typically this action is only needed to reset a creator to its default behavior via SetManualYAxisMinimum(false).

Parameters

SetXAxisMaximum(number xAxisMaximum)

This action manually sets the maximum value to present on the X axis of the ScatterPlot.

Parameters

SetXAxisMinimum(number xAxisMinimum)

This action manually sets the minimum value to present on the X axis of the ScatterPlot.

Parameters

SetXColumn(text xColumn)

This action is used to select a column from a DataFrame by name. The named column will be used as the X value of each point on the ScatterPlot.

Parameters

SetXTickCount(integer xTicks)

This action sets how many scale ticks should be used along the X axis of the ScatterPlot. 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 ScatterPlot.

Parameters

SetYAxisMinimum(number yAxisMinimum)

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

Parameters

SetYColumn(text yColumn)

This action is used to select a column from a DataFrame by name. The named column will be used as the Y value of each point on the ScatterPlot.

Parameters

SetYTickCount(integer yTicks)

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

Parameters