Libraries.Interface.Selections.ChartSelection Documentation

This class represents a selection system for any chart class. By default, Charts have a ChartItem, which contains children, parent, and next/previous items. This allows the system to navigate the overall visual structure, in each case also allowing the system to know which item should have the focus when this change occurs. Besides this, selection works similarly to any other control, where one can get or set the selection and query it for information.

Example Code

use Libraries.Interface.Controls.Charts
    use Libraries.Game.Game

    class Main is Game
        action Main
            StartGame()
        end

        action CreateGame
            BarChart chart
            ChartSelection selection = chart:GetSelection()

            //the selection will be defined, but the item it points at (e.g., GetChartItem()) will not.
            Add(chart)
        end
    e

Inherits from: Libraries.Interface.Selections.Selection, Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Empty()This action clears the current selectio
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetChartItem()Returns the part of the chart that is selected.
GetDisplayName()This action gets the name that would be shown to the user.
GetHashCode()This action gets the hash code for an object.
GetItem()This action returns the item that contains the selection.
Initialize(Libraries.Interface.Item item, text displayName)This action sets up the component with default attributes.
IsEmpty()Returns the part of the chart that is selected.
NotifySelectionListeners()This action sends information that the selection was changed to all listener
Set(Libraries.Interface.Controls.Charts.ChartItem item)Sets the item that should be selected.
SetDisplayName(text name)This action sets the name that would be shown to the user.

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.

Empty()

This action clears the current selectio

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.

GetChartItem()

Returns the part of the chart that is selected.

Return

Libraries.Interface.Controls.Charts.ChartItem: the chart item that is selected, possibly undefined if nothing is selecte

GetDisplayName()

This action gets the name that would be shown to the user.

Example Code

action SelectionChanged(Selection selection)
            output selection:GetDisplayName()
        e

Return

text: The display name to be given to the user.

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.

GetItem()

This action returns the item that contains the selection. It is not the selection itself.

Example Code

action SelectionChanged(Selection selection)
            Item theParentItem = selection:GetItem()
        e

Return

Libraries.Interface.Item:

Initialize(Libraries.Interface.Item item, text displayName)

This action sets up the component with default attributes.

Parameters

IsEmpty()

Returns the part of the chart that is selected.

Return

boolean: the chart item that is selected, possibly undefined if nothing is selecte

NotifySelectionListeners()

This action sends information that the selection was changed to all listener

Set(Libraries.Interface.Controls.Charts.ChartItem item)

Sets the item that should be selected.

Parameters

SetDisplayName(text name)

This action sets the name that would be shown to the user. It also changes the selection, triggering a SelectionEvent.

Example Code

action SelectionChanged(Selection selection)
            selection:SetDisplayName("A new name I want to change to")
        e

Parameters