Libraries.Interface.Controls.Charts.PlotGroup Documentation

The PlotGroup class is a data structure that stores information for each group (array) of plots at a certain tick or by a certain factor marked by its label. This class also contains an Icon that is used for accessibility.

Example Code

use Libraries.Interface.Controls.Charts.BarGroup
class Main
   action Main
      //make group
      PlotGroup group
      //add a plot
      Plot plot
      group:AddPlot(plot)
      //get a plot set its data
      group:Get(0):SetData(Vector v)
   end
end

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
AddPlot(Libraries.Interface.Controls.Charts.Plot newPlot)
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Get(integer i)
GetHashCode()This action gets the hash code for an object.
GetIcon()
GetItem()
GetMaxOutlierValue()
GetMaxValue()
GetMinOutlierValue()
GetMinValue()
GetName()
GetSize()
SetIcon(Libraries.Interface.Controls.Icon icon)
SetItem(Libraries.Game.Graphics.Drawable item)
SetName(text name)

Actions Documentation

AddPlot(Libraries.Interface.Controls.Charts.Plot newPlot)

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 (smaller)

Parameters

Return

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

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(t)

Parameters

Return

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

Get(integer i)

Parameters

Return

Libraries.Interface.Controls.Charts.Plot

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.

GetIcon()

Return

Libraries.Interface.Controls.Icon

GetItem()

Return

Libraries.Game.Graphics.Drawable

GetMaxOutlierValue()

Return

number

GetMaxValue()

Return

number

GetMinOutlierValue()

Return

number

GetMinValue()

Return

number

GetName()

Return

text

GetSize()

Return

integer

SetIcon(Libraries.Interface.Controls.Icon icon)

Parameters

SetItem(Libraries.Game.Graphics.Drawable item)

Parameters

SetName(text name)

Parameters