Libraries.Interface.Controls.Charts.Series Documentation

The Series class is a data structure that stores information for each set (array) of drawable items (bar icons) of a certain series. This class also contains an Icon that is used for accessibility. This will allow every bar of a series to be drawn with the same color.

Example Code

use Libraries.Interface.Controls.Charts.Series
class Main
   action Main
      //make a series
      Series series
      //add an item
      Bar bar
      series:AddItem(bar:GetIcon())
      //set the color for the series
      Color color
      series:SetColor(color:Red())
   end
e

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
AddItem(Libraries.Game.Graphics.Drawable item)
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.
GetColor()
GetHashCode()This action gets the hash code for an object.
GetIcon()
GetItem(integer index)
GetLabel()
GetName()
GetSize()
SetColor(Libraries.Game.Graphics.Color color)
SetIcon(Libraries.Interface.Controls.Icon icon)
SetLabel(Libraries.Interface.Controls.ControlLabel name)
SetName(text name)

Actions Documentation

AddItem(Libraries.Game.Graphics.Drawable item)

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.

GetColor()

Return

Libraries.Game.Graphics.Color

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(integer index)

Parameters

Return

Libraries.Game.Graphics.Drawable

GetLabel()

Return

Libraries.Interface.Controls.ControlLabel

GetName()

Return

text

GetSize()

Return

integer

SetColor(Libraries.Game.Graphics.Color color)

Parameters

SetIcon(Libraries.Interface.Controls.Icon icon)

Parameters

SetLabel(Libraries.Interface.Controls.ControlLabel name)

Parameters

SetName(text name)

Parameters