Libraries.Interface.Controls.Charts.Bar Documentation
The Bar class is a data structure that stores information for each indiviual bar. Bar contains a barIcon that is used for accessibility and keeping track of to which series the bar belongs.
Example Code
use Libraries.Interface.Controls.Charts.Bar
class Main
action Main
//make bar
Bar bar
//add value
bar:SetValue(20.0)
//get value
number x = bar:GetValue()
end
end
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
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. |
GetHashCode() | This action gets the hash code for an object. |
GetHeight() | |
GetIcon() | |
GetName() | |
GetSeries() | |
GetValue() | |
SetHeight(number height) | |
SetIcon(Libraries.Interface.Controls.Icon icon) | |
SetName(text name) | |
SetSeries(Libraries.Interface.Controls.Charts.Series series) | |
SetValue(number value) |
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 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
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
- Libraries.Language.Object: The to be compared.
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.
GetHeight()
Return
number
GetIcon()
Return
Libraries.Interface.Controls.Icon
GetName()
Return
text
GetSeries()
Return
Libraries.Interface.Controls.Charts.Series
GetValue()
Return
number