Libraries.Interface.Controls.Charts.BarGroup Documentation

The BarGroup class is a data structure that stores information for each group (array) of bars 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
      BarGroup group
      //add a bar
      Bar bar
      group:AddBar(bar)
      //get a bar and set its value
      group:Get(0):SetValue(20.0)
   end
e

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
AddBar(Libraries.Interface.Controls.Charts.Bar newBar)
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()
GetLabel()
GetName()
GetSize()
SetIcon(Libraries.Interface.Controls.Icon icon)
SetLabel(Libraries.Game.Graphics.Label name)
SetName(text name)

Actions Documentation

AddBar(Libraries.Interface.Controls.Charts.Bar newBar)

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.

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.

Get(integer i)

Parameters

Return

Libraries.Interface.Controls.Charts.Bar

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

GetLabel()

Return

Libraries.Game.Graphics.Label

GetName()

Return

text

GetSize()

Return

integer

SetIcon(Libraries.Interface.Controls.Icon icon)

Parameters

SetLabel(Libraries.Game.Graphics.Label name)

Parameters

SetName(text name)

Parameters