Libraries.Interface.Controls.Charts.TwoVariableChart

This action returns a default behavior for this paricular control. Some controls do nothing by default, like a TextBox that responds to different kinds of input. Others, however, have default behaviors, like a Button or a MenuItem. If there is no default behavior, this action returns undefined.

Returns true if rendering the focus event.

Parameters

• Libraries.Interface.Events.BehaviorEvent

This action adds a different Item2D into this one, storing the added Item2D at a specific index in the internal array.

Parameters

• integer index
• Libraries.Interface.Item2D

This action adds a different Item2D into this one. This makes a few things happen. 1. The added item will get this item as its parent. 2. The added item's x and y coordinates will become relative to this Item. 3. Most actions on this Item will also affect the added Item.

Parameters

• Libraries.Interface.Item2D

This action adds a new Behavior to this Item.

Parameters

• Libraries.Interface.Behaviors.Behavior

This action generates the instruction text for the Chart Area description.

Parameters

• text description: The base portion of the description that will appear before the instructions

This action generates the instruction text for a chart item description.

Parameters

• Libraries.Interface.Item: The chart item that will have the instructions
• text description: The base portion of the description that will appear before the instructions

Used to create a new ChartLine object for the chart and add it to the lines array.

Parameters

• Libraries.Interface.Controls.Charts.ChartLine

This action removes an Item2D at a specifed index from the internal array.

Parameters

• Libraries.Interface.Events.ControlActivationListener

This action adds a FocusListener to the Item. When the Item receives a FocusEvent due to either gaining or losing the focus, the listener will be notified.

Parameters

• Libraries.Interface.Events.FocusListener

This action adds a GestureListener to the Item. If the Item ever receives a GestureEvent, the listener will be notified.

Parameters

• Libraries.Interface.Events.GestureListener

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Parameters

• Libraries.Interface.Controls.Charts.GroupPanel

This action generates the instruction text for a group panel description.

Parameters

• Libraries.Interface.Controls.Charts.Graphics.ChartDrawable: The group panel that will have the instructions
• text description: The base portion of the description that will appear before the instructions

Returns true if rendering the mouse down event.

Parameters

• Libraries.Interface.Layouts.LayoutProperties

This action adds a MouseListener to the Item. If the Item ever receives a MouseEvent due to a mouse click, the mouse listener will be notified.

Parameters

• Libraries.Interface.Events.MouseListener

This action adds a MouseMovementListener to the Item. If the Item ever receives a MouseEvent due to mouse movement, the listener will be notified.

Parameters

• Libraries.Interface.Events.MouseMovementListener

This action adds a MouseWheelListener to the Item. If the Item ever receives a MouseEvent due to the mouse wheel being scrolled, the listener will be notified.

Parameters

• Libraries.Interface.Events.MouseWheelListener

Used to create a new ChartPoint object for the chart and add it to the chart point array.

Parameters

• Libraries.Interface.Controls.Charts.ChartPoint

This action adds points to the two variable chart. These point have descriptions, a chartItem, and list of points. Atrribute: Parameter summary the chart point summary. Atrribute: Parameter parentItem the chart point parent. Atrribute: Parameter points the chart point, Array.

Parameters

• Libraries.Interface.Controls.Charts.ChartItem
• Libraries.Interface.Controls.Charts.ChartItem
• Libraries.Containers.Array
• Libraries.Interface.Controls.Charts.Series

This action adds the given SelectionListeners to the Control.

Parameters

• Libraries.Interface.Events.SelectionListener: the selectionListener to add to the control.

This action adds to the list of Series.

Parameters

• Libraries.Interface.Controls.Charts.Series: the Series object to add to the list of Series.

This action generates the instruction text for a sub chart area description.

Parameters

• Libraries.Interface.Controls.Charts.ChartAreaPanel: The sub chart area that will have the instructions
• text description: The base portion of the description that will appear before the instructions

This action adds a TouchListener to the Item. If the Item ever receives a TouchEvent, the listener will be notified.

Parameters

• Libraries.Interface.Events.TouchListener

This action adjusts the chart for the legend.

This action adjusts for the x-axis.

This action adjusts for the y-axis.

This action is used to advance the item forward in time in physics space to synchronize it for time of impact solving. This action is used internally and users should not need to use this action. Attribute Parameter time The amount of seconds to advance the item forward in time

Parameters

• number time

This action applies an angular impulse to this item. The units are in kilogram units squared per second. This modifies the angular velocity of this item. Physics must be enabled on this item before using this action.

Parameters

• number impulse: The angular impulse in kilogram units squared per second

This action applies a force to this item at the passed point. The force is in kilogram units per second per second. The point is the screen coordinates where the point will be applied. If the point is not on the center of the item, then a torque will be introduced causing the item to rotate. Physics must be enabled on this item before using this action.

Parameters

• Libraries.Compute.Vector2: The force to apply to the item in kilogram units per second per second
• Libraries.Compute.Vector2: The point at which to apply the force

This action applies a force to this item at the center of the item. The force is in kilogram units per second per second. No torque is introduced to the item when using this action. Physics must be enabled on this item before using this action.

Parameters

• Libraries.Compute.Vector2: The force to apply to the item in kilogram units per second per second

This action applies a linear impulse to this item at the passed point. The impulse is in kilogram units per second. This immeadietly modifies the linear velocity of this item. The point is the screen coordinates where the impulse will be applied. If the point is not the center of the item, then the angular velocity of this item will also be modified. Physics must be enabled on this item before using this action.

Parameters

• Libraries.Compute.Vector2: The impulse to apply in kilogram units per second
• Libraries.Compute.Vector2: The point at which to apply the impulse

This action applies a torque to this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Parameters

• number torque: The torque to apply to this item in kilogram units squared per second per second

This action returns whether or not this Item is allowing its children to receive mouse events if the Item is custom drawing. If the Item isn't using custom drawing, this value is irrelevant -- children objects always receive mouse events before the parent if the parent isn't performing custom drawing.

Return

boolean:

This action is used to indicate that two items have just begun colliding. When two Items collide, the BeginCollision action should be called on both of them, with the other item passed as a parameter to the action. Note that this action does nothing by default, but classes that inherit from Item may override it.

Parameters

• Libraries.Interface.Item: The other Item involved in the collision.

This action is used when a control is moused over by the mouse.

Updates the description of all of the line segments in the array of line segments. The array should contain all points inside of a single series.

Parameters

• Libraries.Interface.Controls.Charts.ChartPoint: the first point to draw the line segment from.
• Libraries.Interface.Controls.Charts.ChartPoint: the second point to draw the line segment to.
• integer iteration

Return

text:

This action gets the position of the center of this item in global (world) coordinates.

Parameters

• boolean flag

This action stops all behaviors this Item is following without finishing them.

If we have any Series objects from movable regression lines, gather those up so we can iterate over them too.

Parameters

• Libraries.Containers.Array

Return

Libraries.Containers.Array:

This action is used to check the current platform and adjust the command instructions to use gestures rather than keys

This action is used when a control is clicked by the mouse.

This action sets the mass, mass moment of inertia, and how the 2D item should move (via linear velocity) to be at the desired location.

Return

boolean:

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.

Parameters

• Libraries.Language.Object: The object to compare to.

Return

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

This action computes the distance of the passed point from the collision shape attached to this item. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Compute.Vector2: The vector representing the point to compute the distance from
• integer childIndex: The index of the collision shape attached to this item we want the bounding box of
• Libraries.Compute.Vector2: The direction of the point from the shape

Return

number: The distance of the point from the collision shape of this item

This action tests if a point in global x,y coordinates is contained inside this Item2D. The global coordinates are considered to be the x and y coordinates of this Item plus its offsetX and offsetY values.

Parameters

• number containsX
• number containsY

Return

boolean: Whether or not the point is contained in this Item.

This action converts this chart to a text value that contains information for a scalable vector graphics file. This is useful for saving charts to disk. Each sub-class of chart must implement this action separately.

Parameters

• boolean hasAccessibility: flag to tell the ChartWriter if it should include accessibility elements and tags.

Return

text: the Scalable Vector Graphics (SVG) text.

This action converts this chart to a text value that contains information for a scalable vector graphics file. This is useful for saving charts to disk. Each sub-class of chart must implement this action separately.

Return

text: the Scalable Vector Graphics (SVG) text.

This action obtains the Input Table from this control, copies it, assigns it a group name, sets the control to use the new input table, and then adds it to the global input table hash table.

Parameters

• text name: the name of the group for the new input table.

Return

Libraries.Game.InputTable: the input table copy

This action creates the nodes for this item for the broadphase collision. This action is needed in order to add the item to the collision detection system. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Collision.BroadphaseCollision2D: The broadphase to add this item to
• Libraries.Game.Collision.PhysicsPosition2D: The current position of the item in physics space

This action destroys the nodes for this item for the broadphase collision, essentially removing it from the collision detection system. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Collision.BroadphaseCollision2D: The broadphase to remove this item's nodes from

This action creates a default Game object for displaying charts and sets this chart as the sole display. It is useful for interacting with charts without creating a complex game setup. The exit flag tells the system, if true, to close the pre-built display right after completing layout, which can be useful for writing to disk.

Parameters

• boolean exit

This action creates a default Game object for displaying charts and sets this chart as the sole display. It is useful for interacting with charts without creating a complex game setup.

Parameters

• integer width
• integer height

This action creates a default Game object for displaying charts and sets this chart as the sole display. It is useful for interacting with charts without creating a complex game setup.

This action creates a default Game object for displaying charts and sets this chart as the sole display. It is useful for interacting with charts without creating a complex game setup. The exit flag tells the system, if true, to close the pre-built display right after completing layout, which can be useful for writing to disk.

Parameters

• integer width
• integer height
• boolean exit

This action is used to free up any additional memory that is being used by this Item for purposes such as graphics. Note that the Item class doesn't have any extra memory that needs to be released with this action, but some classes which inherit from Item, such as Libraries.Game.Graphics.Drawable, do.

This action is used to call Dispose on this Item and on the entire children hierarchy of this Item.

This action is used to call Dispose on the entire children hierarchy of this Item. This will not call Dispose on this Item.

DisposeDrawables Empties drawables from the chart area.

This action triggers special navigation behavior in the specified navigation direction. This behavior overrides the typical navigation provided by the chart. This will only be called by the Chart if the HasSpecialNavigation action returns true for the provided parameter. By default this does nothing, but some classes may override this with custom behavior.

Parameters

• integer navigationType

The Draw action is used to perform custom drawing on this Item and its children. This is only called during the Game engine's draw phase if this Item has enabled custom drawing via the SetCustomDrawing action. This is an advanced feature, and shouldn't be used by most users. If custom drawing is enabled, this action should be overriden -- if it isn't, the Item will attempt to provide default rendering for itself, its view, and its children, without regard to depth buffering. This action is responsible for instructing the provided Painter on how to draw this item, the view, and its children, and in what order to do so.

Parameters

• Libraries.Game.Graphics.Painter2D

This action will remove all items from this item's children hierarchy. Note that this will not empty the hierarchies of the contained Items.

This action will call Empty on the entire children hierarchy of this item, and then empty this item as well.

This action is used to call Empty on all children contained in this item's children hierarchy. This will not empty the children of this item.

This action empties or removes all SelectionListeners which have been added to the Control of the given SelectionEvent.

This action enables physics for this item. Passing true turns on physics for this item while passing false turns off physics for this item.

Parameters

• boolean flag: Whether or not to enable physics for this item

This action is used when a control is moused over and it ends.

This action determines if two objects are equal based on their hash code values.

Parameters

• Libraries.Language.Object: The to be compared.

Return

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

This action gets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Parameters

• boolean flag

This action is used to indicate that two items that were previously colliding no longer are. The FinishCollision action should be called on both Items involved, with the other item passed as a parameter to the action. Note that this action does nothing by default, but classes that inherit from Item may override it.

Parameters

• Libraries.Interface.Item: The other Item involved in the collision.

If not already changed, this action will flip the axis at the current state.

This action will flip the Item2D across the X-axis. This flip is represented by the internal vertices of the Item2D. For classes that inherit from Item and can draw on the screen, this will flip the drawn image on the screen.

This action will flip the Item2D across the Y-axis. This flip is represented by the internal vertices of the Item2D. For classes that inherit from Item and can draw on the screen, this will flip the drawn image on the screen.

This action sets focus on this Item. If the Item is not focusable, it will instead look through the parent hierarchy and set focus on the first focusable ancestor. If no focusable Item can be found, this action will have no effect.

This action is fired if the item received the focus.

Parameters

• Libraries.Interface.Events.FocusEvent

This action obtains the displayable name for this region of the chart.

GenerateInfoTree Generates the tree of ChartItems that define how the chart will be navigated and what extra information might be sent to the screen reader. GenerateSummary is done in the child class: LineChart or ScatterPlot

This is called to generate the line description or summary for the screen reader given a line object.

Parameters

• Libraries.Interface.Controls.Charts.ChartLine: the line to generate a description for.

This is called to find the proper X text output based on the various ScatterPlot label overrides.

Parameters

• Libraries.Interface.Controls.Charts.ChartPoint

Return

text:

This is called to find the proper Y text output based on the various ScatterPlot label overrides.

Parameters

• Libraries.Interface.Controls.Charts.ChartPoint

Return

text:

This is called to generate the summary that is heard when you first focus on the chart points.

Parameters

• Libraries.Interface.Controls.Charts.ChartPoint

Values used to lock the initial y-intercept value of regression lines.

Return

text:

This action gets the accent color from the control.

Return

Libraries.Game.Graphics.ColorGroup: the accent control.

This action returns the current accessiblity code for this Item

Return

integer:

This action returns the custom accessibility role description for this item, if any.

Return

text:

This action returns the name of the accessiblity code for this Item as Text

Return

text:

This action returns the parent of this Item2D. An Item2D gets a parent when it is added to another Item using the Add action.

Return

Libraries.Interface.Item:

This action returns a default behavior for this paricular control. Some controls do nothing by default, like a TextBox that responds to different kinds of input. Others, however, have default behaviors, like a Button or a MenuItem. If there is no default behavior, this action returns undefined.

Return

Libraries.Interface.Behaviors.Behavior:

Returns the entire list of lines from the chart.

Return

Libraries.Containers.Array:

This action gets the inverse inertia of this item (i.e., one divided by the inertia of this item). Physics must be enabled on this item before using this action.

Return

number: The inverse inertia of this item

This action gets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Return

number: The angular velocity of this item in radians per second

This action gets the Drawable in the background of the chart.

Return

Libraries.Game.Graphics.Drawable: the chart background Drawable.

This action gets the color of the Control background color.

Return

Libraries.Game.Graphics.ColorGroup: the background the color.

This action gets the border color of the control.

Return

Libraries.Game.Graphics.ColorGroup: the controls border color.

This action gets the border style either, LayoutProperties.TOP, LayoutProperties.BOTTOM, LayoutProperties.LEFT, LayoutProperties.RIGHT, and LayoutProperties.ALL.

Return

integer:

This action gets the border thickness on the control.

Return

number: the border thickness.

This action returns the bottom left pixel rounding value.

Return

number: the bottom left pixel rounding value.

This action returns the bottom left rounding value.

Return

number: the bottom left rounding value.

This action gets the bottom margin size. The bottom margin is the space outside of the bottom border.

Return

number: the number amount of bottom margin.

This action gets the bottom padding size. The bottom padding is the space inside of the bottom border.

Return

number: the number amount of bottom padding.

This action returns the bottom right pixel rounding value.

Return

number: the bottom right pixel rounding value.

This action returns the bottom right rounding value.

Return

number: the bottom right rounding value.

This action is used to get the bounding box of the item. A bounding box is an axis-alligned rectangle containing the shape used for broadphase collision. This action is used internally and users should not need to use this action.

Parameters

• integer childIndex: The index of the collision shape attached to this item we want the bounding box of

Return

Libraries.Game.Collision.BoundingBox2D: The bounding box of the collision shape attached to this item

This action returns a rectangle that fully encloses the four corners of the Item as it is represented by its internal vertices array. Note that the rectangle produced by this action will be larger than the actual box formed by this Item's vertices if the Item is rotated.

Return

Libraries.Game.Shapes.Rectangle:

This action returns the x coordinate of the center of this Item2D.

Return

number:

This action returns the y coordinate of the center of this Item2D.

Return

number:

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Return

Libraries.Interface.Controls.Charts.ChartAreaPanel:

This action gets the chart area height percent of the whole chart height.

Return

number:

Returns the ChartItem for the chart area.

Return

Libraries.Interface.Controls.Charts.ChartItem:

This action gets the chart area width percent of the whole chart width.

Return

number:

This action gets text for a chart item.

Return

text: the chart item text.

This action gets text for a chart items.

Return

text: the chart items text.

Get all the chart points on the two variable chart.

Return

Libraries.Containers.Array:

This action gets the children of this item in an array.

Return

Libraries.Containers.Array: The children of this item in an array

This action gets the clipping coordinates of this Item2D. The coordinates are returned via the two provided Vector2 parameters, the first vector storing the x values of the left and right sides of the clipping coordinates and the second vector storing the y values of the bottom and top sides. The returned boolean value indicates if this Item uses these clipping coordinates (i.e. if this Item or one of its parent Items has clipping enabled). If the clipping is valid, the action returns true. Otherwise, it returns false.

Parameters

• Libraries.Compute.Vector2
• Libraries.Compute.Vector2

Return

boolean:

This action gets the total force on this item. The units are kilogram units per second per second. Physics must be enabled on this item before using this action.

Return

boolean: The total force in kilogram units per second per second

This action gets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Return

integer: The angular velocity of this item in radians per second

This is an action used internally to retrieve the head of the linked list of collisions with this item. This action is used internally and users should not need to use this action.

Return

Libraries.Game.Collision.CollisionEdge2D: The head of the doubly linked list of collisions

This action gets the color of a given property in the Control.

Parameters

• text property

Return

Libraries.Game.Graphics.ColorGroup:

This action get the current chart object.

Return

Libraries.Interface.Controls.Charts.Chart: the chart object.

This action returns how many rows this Control should be divided into when using a GridLayout. This will have no effect if this Control is not a container or if it is using a different layout.

Return

integer:

This action returns how many columns this Control should be divided into when using a GridLayout. This will have no effect if this Control is not a container or if it is using a different layout.

Return

integer:

This action gets the current size of the selection arrow.

Return

integer: the current size of the selection arrow.

This action returns the LayoutProperties that were last used to define the Control, and thus describe its current state. Note that if the Control hasn't been laid out yet, this will return undefined.

Return

Libraries.Interface.Layouts.LayoutProperties: The last LayoutProperties used to layout this Control, or undefined if it hasn't been laid out yet.

This action gets the current arrow's flag for direction.

Return

boolean: the current arrow's flag for direction.

This action obtains the default font for this control. This allows individual controls to customize their default font properties on a per control basis. By default, the system asks for the default system font name on a per control basis, then loads that font and returns it. Font loading is shared, so loading many fonts of the same type and size is not particularly expensive and can be done without much concern for memory requirements.

Return

Libraries.Game.Graphics.Font:

This action defines what the default font is for this control. This allows individual controls to customize their default font properties on a per control basis.

Return

text:

This action defines what the default font size for this control. This allows individual controls to customize their default font properties on a per control basis.

Return

integer:

This action returns the default LayoutProperties used for this Control.

Return

Libraries.Interface.Layouts.LayoutProperties: The default LayoutProperties of this Control.

This action sets the interface scale for the control.

Return

text: the scale, a number between 0 and 1 that scales the control.

This action defines what the default font is for this control. This allows individual controls to customize their default font properties on a per control basis.

Return

text:

This action applies a linear impulse to this item at the passed point. The impulse is in kilogram units per second. This immeadietly modifies the linear velocity of this item. The point is the screen coordinates where the impulse will be applied. If the point is not the center of the item, then the angular velocity of this item will also be modified. Physics must be enabled on this item before using this action.

Return

number:

This action returns the current internal description of the Item.

Return

text:

This action obtains the displayable name for this region of the chart.

Return

text: the display name

Returns the Item accessed "below" (via the DOWN arrow) this Item in the chart selection.

Return

Libraries.Interface.Controls.Charts.ChartItem:

This action returns the DrawableShape attached to this Item, if it has one. For a default Item2D, this action will return undefined, but Drawables will have an associated shape if they've been loaded. Attributes: Returns The DrawableShape attached to this Item, or undefined if there isn't one.

Return

Libraries.Game.Graphics.DrawableShape:

This action gets the instruction text for an enter description.

Return

text: The description for enter.

Returns the Item accessed within (default: ENTER key) this Item in the chart selection.

Return

Libraries.Interface.Controls.Charts.ChartItem:

Returns the escape Item accessed from this Item in the chart selection (by default using the ESCAPE key).

Return

Libraries.Interface.Controls.Charts.ChartItem:

This action gets the instruction text for an exit description.

Return

text: The description for exit.

Returns an array of the factor/group names

Return

Libraries.Containers.Array: Array an array of factors/groups in the chart.

This action gets the focus border color.

Return

Libraries.Game.Graphics.ColorGroup: the focus border color.

This action sets the focus color.

Return

Libraries.Game.Graphics.ColorGroup: the focus color.

This action gets focus font color.

Return

Libraries.Game.Graphics.ColorGroup: the focus font color.

This action returns an Iterator containing all of the FocusListeners that have been added to this Item using the AddFocusListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered FocusListeners.

This action returns the Font being used by this Control. How this Font is used varies between Controls, and in some cases the Control will ignore it entirely (for example, ScrollPanes), but typically this sets the font that's used for the default label on many Controls, such as Buttons. If the Font is undefined, many Controls will omit their default label.

Return

Libraries.Game.Graphics.Font: The Font being used for this Control.

This action gets the current the font color of the font contained in the Control.

Return

Libraries.Game.Graphics.ColorGroup:

This action gets the font outline color value.

Return

Libraries.Game.Graphics.ColorGroup: the font outline color value.

This action returns the font outline thickness value.

Return

number: the font outline thickness value.

This action returns the base Font size to be used by this Control, if the Control uses a Font.

Return

integer:

This action gets the total force on this item. The units are kilogram units per second per second. Physics must be enabled on this item before using this action.

Return

Libraries.Compute.Vector2: The total force in kilogram units per second per second

This action gets the color of the Control foreground color.

Return

Libraries.Game.Graphics.ColorGroup: the foreground color.

This action gets the color of the Control foreground selection color.

Return

Libraries.Game.Graphics.ColorGroup: the foreground selection color.

This action applies a force to this item at the center of the item. The force is in kilogram units per second per second. No torque is introduced to the item when using this action. Physics must be enabled on this item before using this action.

Return

number:

This action gets the instruction text for a general chart description.

Return

text: The description for a general chart.

This action returns an Iterator containing all of the GestureListeners that have been added to this Item using the AddGestureListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered GestureListeners.

This action returns the Item's global x coordinate. This is the actual world coordinate that the item exists at after it has been offset by its parent's position. If this Item doesn't have a parent, and the offset hasn't been set manually, this is the same as GetX().

Return

number:

This action returns the Item's global y coordinate. This is the actual world coordinate that the item exists at after it has been offset by its parent's position. If this Item doesn't have a parent, and the offset hasn't been set manually, this is the same as GetY().

Return

number:

This action returns the Item's global z value. For an Item2D, this simply returns the Item2D's current z value.

Return

number:

This action gets the glow color from the control.

Return

Libraries.Game.Graphics.ColorGroup: the glow color.

The GetGridHeight action returns how many cells in a column this Control occupies. By default, this value is 1. This value is only used for GridLayouts, and is ignored by other layouts.

Return

integer:

The GetGridWidth action returns how many cells in a row this Control occupies. By default, this value is 1. This value is only used for GridLayouts, and is ignored by other layouts.

Return

integer:

This action returns this Control's cell x-coordinate within a GridLayout. This indicates which column this Control is located within. If the Control's parent container isn't using a GridLayout, this value is ignored.

Return

integer:

This action returns this Control's cell y-coordinate within a GridLayout. This indicates which row this Control is located within. If the Control's parent container isn't using a GridLayout, this value is ignored.

Return

integer:

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Return

Libraries.Containers.Array:

This action gets text for a group.

Return

text: the group text.

This action gets text for groups.

Return

text: the groups text.

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

This action will return the currently set height of the Item2D.

Return

number:

This action returns whether the chart is in the horizontal position.

Return

boolean:

The GetHorizontalLayoutMode is used to determine how the width of a Control is calculated. It should be one of the following constants: STANDARD, which will calculate the width as a set number of pixels plus a percentage of the container's width. FILL, which will make the width fill the remaining width of the container. FIT_CONTENTS, which will calculate the width to fit the children contents.

Return

integer: the integer that maps to the layout mode constant, one of STANDARD, FILL, or FILL_CONTENTS.

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Return

Libraries.Interface.Controls.Charts.HorizontalAxisPanel:

This action gets the horizontal panel height percent of the whole chart height.

Return

number:

This action gets the horizontal panel width percent of the whole chart width.

Return

number:

This action gets the Icon (typically an image or texture) used by this Control. Different Controls use this Icon differently, depending on their purpose.

Return

Libraries.Game.Graphics.TextureRegion:

This action gets the Icon color from the control.

Return

Libraries.Game.Graphics.ColorGroup: the icon color.

This action gets the rotational inertia of this item. The inertia is in kilogram units squared.

Return

number: The inertia of this item in kilogram units squared

This action returns the input group for this Item. When used with the Game libraries, this tag describes what InputTable (if any) can interact with this Item due to input.

Return

text: The input group tag being used by this Item.

Return

Libraries.Game.InputTable:

This action sets the base Font size to be used by this Control, if the Control uses a Font.

Return

text:

This action sets the interface scale for the control.

Return

number: the scale, a number between 0 and 1 that scales the control.

This action gets the inverse inertia of this item (i.e., one divided by the inertia of this item). Physics must be enabled on this item before using this action.

Return

number: The inverse inertia of this item

This action gets the inverse mass of the item (i.e., one divided by the mass of this item). Physics must be enabled on this item before using this action.

Return

number: The inverse mass of this item

This action returns an Item2D that was previously added to this Item2D by finding it at the given index in the internal array of children Items.

Parameters

• integer index

Return

Libraries.Interface.Item2D:

This action searches through all Items stored in this Item2D and finds the deepest Item which contains the given point in global coordinates.

Parameters

• number x
• number y

Return

Libraries.Interface.Item2D: The deepest item in the children hierarchy at the given point.

This action returns the number of items contained in this Item2D.

Return

integer:

This action returns an iterator containing all the items contained in this Item2D.

Return

Libraries.Containers.Iterator:

This is an action used internally to retrieve the head of the liked list of joints connected to this item. This action is used internally and users should not need to use this action.

Return

Libraries.Game.Physics.Joints.JointEdge2D: The head of the linked list of connected joints

This action returns the text used for this Control's label, if it has one.

Return

text: The text of this Control's label.

This action returns the current Layer2Dthat this Item2D is a part of in the Game libraries.

Return

Libraries.Game.Layer2D:

Returns true if rendering the selection event.

Return

Libraries.Interface.Layouts.Layout:

This action returns the best suited LayoutProperties stored by the Control for use with the given container width and height. The Control will attempt to find the most restricted LayoutProperties that is still valid, prioritizing width over height in case of equal values.

Parameters

• number containerWidth: The width of the container the LayoutProperties must be legal for.
• number containerHeight: The height of the container the LayoutProperties must be legal for.

Return

Libraries.Interface.Layouts.LayoutProperties: The LayoutProperties contained in the Control that is best suited to the requested container dimensions.

This action is fired if the item lost the focus.

Return

Libraries.Containers.Iterator:

This action returns how many rows this element should occupy, if the layout supports it. This effectively makes the control taller. This is most commonly used in conjunction with FormRowLayout (or StackedRowPage which uses that layout).

Return

number:

Returns the Item accessed to the left of this Item in the chart selection.

Return

Libraries.Interface.Controls.Charts.ChartItem:

This action gets the left margin size. The left margin is the space outside of the left border.

Return

number: the number amount of left margin.

This action gets the left padding size. The left padding is the space inside of the left border.

Return

number: the number amount of left padding.

This action returns the current legend, if one exists

Return

Libraries.Interface.Controls.Charts.Legend: the Legend on the chart.

This action returns the thickness of the borders drawn around the icons in the Legend, measured in pixels. If this chart doesn't have a legend, this value isn't used. By default, this value is 1.

Return

number:

Returns the title for the legend of the Chart.

Return

text:

Return a specific line from the chart.

Parameters

• integer i

Return

Libraries.Interface.Controls.Charts.ChartLine:

Set and get the line density.

Return

integer:

Given the local coordinates of a vector, this action computes the screen coordinates of the corresponding vector.

Return

number: The coordinates of the corresponding global vector Attribute Example use Libraries.Interface.Item2D use Libraries.Compute.Vector2 Item2D item Vector2 localVector item:SetWidth(100) item:SetHeight(100) item:SetPosition(400, 250) localVector:Set(0, 0) // Get the coordinates of the center of the item Vector2 worldVector = item:GetWorldVector(localVector)

This action gets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Return

Libraries.Compute.Vector2: The vector representing the linear velocity of this item in units per second

Given a global point (i.e., the screen coordinates of the point), this action computes the corresponding point relative to the center of this item.

Parameters

• Libraries.Compute.Vector2

Return

Libraries.Compute.Vector2: The coordinates of the point relative to the center of this item

Given the screen coordinates of a vector, this action computes the local coordinates of the vector (i.e., the coordinates of the vector relative to the center of this item)

Parameters

• Libraries.Compute.Vector2

Return

Libraries.Compute.Vector2: The local coordinates of the corresponding vector

This action gets the instruction text for a list order description.

Return

text: The description for list order.

This action gets the position of the center of this item in local coordinates (i.e., with respect to itself).

Return

Libraries.Compute.Vector2: The vector representing the center of this item in local coordinates

Given a global point (i.e., the screen coordinates of the point), this action computes the corresponding point relative to the center of this item.

Parameters

• Libraries.Compute.Vector2: The screen coordinates of the point to compute

Return

Libraries.Compute.Vector2: The coordinates of the point relative to the center of this item

Given the screen coordinates of a vector, this action computes the local coordinates of the vector (i.e., the coordinates of the vector relative to the center of this item)

Parameters

• Libraries.Compute.Vector2: The screen coordinates of the vector

Return

Libraries.Compute.Vector2: The local coordinates of the corresponding vector

This action returns the mass of the item in kilograms. Physics must be enabled on this item before using this action. If the item is non-responsive or unmovable, the mass is zero.

Return

number: The mass in kilograms

This action is used to advance the item forward in time in physics space to synchronize it for time of impact solving. This action is used internally and users should not need to use this action. Attribute Parameter time The amount of seconds to advance the item forward in time

Parameters

• Libraries.Game.Physics.Mass2D

This is called to find the proper Y text output based on the various ScatterPlot label overrides.

Return

integer:

This action gets the mouse down font color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse over font color value.

This action gets the mouse down font color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse down font color.

This action gets the mouse down glow color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse down glow color.

This action returns an Iterator containing all of the MouseListeners that have been added to this Item using the AddMouseListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered MouseListeners.

This action returns an Iterator containing all of the MouseMovementListeners that have been added to this Item using the AddMouseMovementListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered MouseMovementListeners.

This action gets the mouse over color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse over color.

This action gets the mouse over font color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse over font color value.

This action gets the mouse over glow color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse over glow color.

This action returns an Iterator containing all of the MouseWheelListeners that have been added to this Item using the AddMouseWheelListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered MouseWheelListeners.

This action returns the current internal name of the Item.

Return

text:

This action returns the next focus item. When this Item has the focus and the user requests the focus to advance (e.g. by pressing the tab key), the returned value is the next item to receive that focus, if it is defined. If it isn't defined, the focus can not advance from this Item.

Return

Libraries.Interface.Item: The next Item to receive focus after this one.

This action gets the number of broadphase nodes this item has. This action is used internally and users should not need to use this action.

Return

integer: The number of broadphase nodes attached to this item

This action returns all of the broadphase nodes attached to this item in an array. This action is used internally and users should not need to use this action.

Return

Libraries.Containers.Array: The broadphase nodes attached to this item in an array

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Return

integer:

Returns the number of full chart lines from the chart.

Return

integer:

Returns the number of points from the chart. (scatter)

Return

integer:

This action gets a generic property with a specified name from the control.

Parameters

• text property: the property name.

Return

number: the number value of the property.

This action returns the X offset of the Item. The offset tells the Item where to relate its X position to. In other words, the X offset is where an X coordinate of 0 is for this Item. This is automatically set when using an action to add an Item to another Item.

Return

number:

This action returns the Y offset of the item. The offset tells the Item where to relate its Y position to. In other words, the Y offset is where a Y coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Return

number:

This action returns the Z offset of the item. The offset tells the Item where to relate its Z position to. In other words, the Z offset is where a Z coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Return

number:

This action will return the current X origin of this Item2D. By default, the origin is at the coordinates 0, 0.

Return

number:

This action will return the current Y origin of this Item2D. By default, the origin is at the coordinates 0, 0.

Return

number:

This action returns the parent of this Item2D. An Item2D gets a parent when it is added to another Item using the Add action.

Return

Libraries.Interface.Item2D:

This action returns the height of the Control relative to the size of its container, if the container's Layout supports it.

Return

number: The target height as a percentage (as a value between 0.0 and 1.0) of the container's height.

This action returns the x-coordinate of the "origin" of the Control, as a percentage of its width. The origin is the point that the Control is positioned by. For example, by default, the origin is at 0% x and 0% y, or the bottom-left corner of the Control. Changing the percentage origin x and y to 0.5 (50%) would mean the Control should be positioned using its center instead. The origin point is used by layouts that allow for specific positioning, such as ManualLayout or GridLayout. It is ignored by layouts that have special positioning rules, such as FlowLayout.

Return

number:

This action returns the y-coordinate of the "origin" of the Control, as a percentage of its width. The origin is the point that the Control is positioned by. For example, by default, the origin is at 0% x and 0% y, or the bottom-left corner of the Control. Changing the percentage origin x and y to 0.5 (50%) would mean the Control should be positioned using its center instead. The origin point is used by layouts that allow for specific positioning, such as ManualLayout or GridLayout. It is ignored by layouts that have special positioning rules, such as FlowLayout.

Return

number:

This action returns the width of the Control relative to the size of its container, if the container's Layout supports it.

Return

number: The target width as a percentage (as a value between 0.0 and 1.0) of the container's width.

This action returns the x position of the Control relative to the size of its container, if the container's Layout supports it.

Return

number: The target x position as a percentage (as a value between 0.0 and 1.0) of the container's width.

This action returns the y position of the Control relative to the size of its container, if the container's Layout supports it.

Return

number: The target y position as a percentage (as a value between 0.0 and 1.0) of the container's height.

This action computes the distance of the passed point from the collision shape attached to this item. This action is used internally and users should not need to use this action.

Return

Libraries.Game.Physics.PhysicsProperties2D: The distance of the point from the collision shape of this item

This action returns the target height of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

Return

number: The target height of this Control in pixels.

This action returns the target width of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

Return

number: The target height of this Control in pixels.

This action returns the target x position of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

Return

number: The target x position of this Control in pixels.

This action returns the target y position of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

Return

number: The target y position of this Control in pixels.

This action returns the thickness of the borders drawn around points in the chart, measured in pixels. This is only applied to points, not other chart elements like bars. If this chart isn't drawing any points, this value isn't used. By default, this value is 0.

Return

number:

Get the point radius.

Return

integer:

Returns the value of the showPoints flag.

Return

boolean:

The GetContextMenu action returns this Control's context menu, if it has one. A context menu is a PopupMenu which appears when a user wants additonal context about this Control (most commonly by right-clicking on the Control).

Return

Libraries.Interface.Controls.PopupMenu:

This action returns the previous focus item. When this Item has the focus and the user requests the focus to move backwards (e.g. by pressing shift & tab), the returned value is the previous item to receive that focus, if it is defined. If it isn't defined, the focus can not move backwards from this Item.

Return

Libraries.Interface.Item: The previous Item to receive focus before this one.

Return

integer

Parameters

• text key

Return

Libraries.Data.Formats.JavaScriptObjectNotation

Return

Libraries.Containers.Iterator

Updates the description of all of the points in the array of points. The array should contain all points inside of a single series. Useful if data changes during dynamic use (e.g., movable regression line changes, so residuals need to be updated in the descriptions).

Return

integer:

This action is used to update this items position in physics space after physics solving is finished for this item. This action is used internally and users should not need to use this action.

Return

number:

Returns the entire list of regions from the chart.

Return

Libraries.Containers.Array:

This action gets the regression line color.

Return

Libraries.Game.Graphics.Color: the color value of the regression line.

This action gets the regression line density represented by an integer value.

Return

integer: the density value of the regression line.

This action gets the inverse mass of the item (i.e., one divided by the mass of this item). Physics must be enabled on this item before using this action.

Return

integer: The inverse mass of this item

This action gets the total torque on this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Return

number: The total torque in kilogram units squared per second per second

Returns the Item accessed to the right of this Item in the chart selection.

Return

Libraries.Interface.Controls.Charts.ChartItem:

This action gets the right margin size. The right margin is the space outside of the right border.

Return

number: the number amount of right margin.

This action gets the right padding size. The right padding is the space inside of the right border.

Return

number: the number amount of right padding.

Gets the current degree of rotation of this Item.

Return

number:

Gets the current rotation of this Item in radians.

Return

number:

This action is used to check whether the x-axis label rotation has been overridden.

Return

boolean: true if the x-axis labels are rotated.

This action will return the current x-scaling value of this Item2D. By default, the x-scaling value of an Item is 1.

Return

number:

This action will return the current y-scaling value of this Item2D. By default, the y-scaling value of an Item is 1.

Return

number:

This action returns the x coordinate of the Item on the screen. If the Item hasn't been attached to a Layer, this will return a "Not a Number" value instead.

Return

number:

This action returns the y coordinate of the Item on the screen. If the Item hasn't been attached to a Layer, this will return a "Not a Number" value instead.

Return

number:

This action gets the script file path.

Return

text: the script file path.

This action gets the ChartSelection, which contains the ChartItem that is currently selected. The reason why we use this indirection, instead of getting the items directly, is because this ensures the operating system is informed whenever selections are changed. The item can be obtained from this selection by calling GetChartItem on the selection. The selection is intended to never be undefined, even if nothing is selected.

Return

Libraries.Interface.Selections.ChartSelection: the current selection

This action gets chart drawables selection arrow drawable object.

Return

Libraries.Game.Graphics.Drawable: the charts slection arrow object.

This action gets the selection border color.

Return

Libraries.Game.Graphics.ColorGroup: the selection border color.

This action gets the selection bracket (Array).

Return

Libraries.Containers.Array: the Array of the selection bracket.

This action gets the selection color from the control.

Return

Libraries.Game.Graphics.ColorGroup: the selection color.

This action gets the selection font color on the control.

Return

Libraries.Game.Graphics.ColorGroup: the selection font color.

This action return an iterator of all SelectionListeners which have been added to the Control of the given SelectionEvent.

Return

Libraries.Containers.Iterator: All SelectionListeners registered with the Control.

This action get the list of Series from the chart.

Return

Libraries.Containers.Array: the array.

This action gets text for a series.

Return

text: the series text.

This action gets the shaddow color from the control.

Return

Libraries.Game.Graphics.ColorGroup: the shaddow color.

This action returns the shadow edge fade property.

Return

number: the shadow edge fade number.

This action returns the shadow height property.

Return

number: the shadow height number.

This action returns the shadow width property.

Return

number: the shadow width number.

This action returns the shadow X value.

Return

number: the shadow X value.

This action returns the shadow Y value.

Return

number: the shadow Y value.

This item returns the collision shape of this item. The collision shape is the shape the collision system will use to test for collisions with this item. Note that this may be different from the shape drawn on the screen.

Return

Libraries.Game.Collision.Shapes.CollisionShape2D: The collision shape for this item

This action returns an integer representing the type of collision shape currently attached to this item.

Return

integer: The integer representing the type of collision shape for this item

This action gets the children of this item in an array.

Return

number: The children of this item in an array

This action gets the style file path.

Return

text: the style file path.

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Return

Libraries.Containers.Array:

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Return

Libraries.Containers.Array:

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Return

Libraries.Containers.Array:

This action get the current subtitle for the chart.

Return

text: the subtitle of the chart

This action gets the subtitle area height in percent (between 0 and 1). This is handled automatically so users don't need to use this action directly.

Return

number: percent of screen height alloted for the title

This action gets the Label object for the chart subtitle.

Return

Libraries.Interface.Controls.Charts.ChartLabel:

This action returns the swept movement of this item used for time of impact solving for the physics system. This action is used internally and users should not need to call this action.

Return

Libraries.Game.Collision.Sweep2D: The swept motion of this item

This action gets the title of the chart

Return

text: the title of the chart

Gets the title area height percent. This is handled automatically so users don't need to use this action directly.

Return

number: percent of screen height alloted for the title

This action returns the Label for the chart title.

Return

Libraries.Interface.Controls.Charts.ChartLabel: the chart title label

This action returns the top left pixel rounding value.

Return

number: the top left pixel rounding value.

This action returns the top left rounding value.

Return

number: the top left rounding value.

This action gets the top margin size. The top margin is the space outside of the top border.

Return

number: the number amount of top margin.

This action gets the top padding size. The top padding is the space inside of the top border.

Return

number: the number amount of top padding.

This action returns the top right pixel rounding value.

Return

number: the top right pixel rounding value.

This action returns the top right rounding value.

Return

number: the top right rounding value.

This action gets the total torque on this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Return

number: The total torque in kilogram units squared per second per second

This action gets the flag to determine if touch exploration is enabled.

Return

boolean: The flag for touch exploration.

This action returns an Iterator containing all of the TouchListeners that have been added to this Item using the AddTouchListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered TouchListeners.

This action returns the position of the item in physical space. This acction is used internally and should not be used by users to get the position of this item on the screen.

Return

Libraries.Game.Collision.PhysicsPosition2D: The position and angle of this item in physics space

This action gets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action

Return

Libraries.Game.Collision.PhysicsPosition2D: The position and angle of the item in physics space in the previous frame

This action gets the unfocused selection border color on the control.

Return

Libraries.Game.Graphics.ColorGroup: the unfocused selection border color.

This action gets the unfocused selection color on the control.

Return

Libraries.Game.Graphics.ColorGroup: the unfocused selection color.

This action gets the unfocused selection font color on the control.

Return

Libraries.Game.Graphics.ColorGroup: the unfocused selection font color.

Returns the Item accessed "above" (via the UP arrow) this Item in the chart selection.

Return

Libraries.Interface.Controls.Charts.ChartItem:

This action gets the instruction text for a value order description.

Return

text: The description for value order.

This action returns whether the chart is in the vertical position.

Return

boolean:

The SetVerticalLayoutMode is used to determine how the height of a Control is calculated. It should be one of the following constants: STANDARD, which will calculate the height as a set number of pixels plus a percentage of the container's height. FILL, which will make the height fill the remaining height of the container. FIT_CONTENTS, which will calculate the height to fit the children contents. FIT_FONT, which will fit the height of the Control to the line height of the Font set in this LayoutProperties.

Return

integer: the integer that maps to the layout mode constant, one of STANDARD, FILL, FILL_CONTENTS, or FIT_FONT.

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Return

Libraries.Interface.Controls.Charts.VerticalAxisPanel:

This action gets the vertical panel height percent of the whole chart height.

Return

number:

This action gets the vertical panel width percent of the whole chart width.

Return

number:

The SetClipping action is used to enable or disable clipping. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

Return

Libraries.Interface.Views.View2D:

This action searches through all Items stored in this Item2D and finds the deepest Item which contains the given point in global coordinates. This action will only return items which are visible (that is, IsShowing() returns true).

Parameters

• number x
• number y

Return

Libraries.Interface.Item2D: The deepest visible item in the children hierarchy at the given point.

This action will return the currently set width of the Item2D.

Return

number:

This action gets the position of the center of this item in global (world) coordinates.

Return

Libraries.Compute.Vector2: The vector representing the center of this item in global coordinates

Given a point relative to the center of this item, this action computes and returns that point in screen coordinates.

Parameters

• Libraries.Compute.Vector2: The point in coordinates with respect to the center of this item

Return

Libraries.Compute.Vector2: The screen coordinates of the passed local point

Given the local coordinates of a vector, this action computes the screen coordinates of the corresponding vector.

Parameters

• Libraries.Compute.Vector2: The coordinates of a local vector

Return

Libraries.Compute.Vector2: The coordinates of the corresponding global vector Attribute Example use Libraries.Interface.Item2D use Libraries.Compute.Vector2 Item2D item Vector2 localVector item:SetWidth(100) item:SetHeight(100) item:SetPosition(400, 250) localVector:Set(0, 0) // Get the coordinates of the center of the item Vector2 worldVector = item:GetWorldVector(localVector)

This action returns the currently set X coordinate of the Item.

Return

number:

This action gets the number of the maximum value on the X axis. Atrribute: Returns the number value of the maximum on the x axis.

Return

number:

This action gets the number of the minimum value on the X axis. Atrribute: Returns the number value of the minumum on the x axis.

Return

number:

This action gets the title for the X-Axis of the Chart.

Return

text: the x-axis title.

This action gets whether the X axis uses percent values or not. Atrribute: Returns the boolean value of percent being used on the x axis.

Return

boolean:

This action is used to get the X-axis labels.

Return

Libraries.Containers.Array: the array of ChartLabel's displayed on the X-axis.

This action is used to get the number of degrees the X-axis labels are rotated.

Return

integer: the degrees the labels are rotated.

This action returns the currently set Y coordinate of the Item.

Return

number:

This action gets the number of the maximum value on the Y axis. Atrribute: Returns the number value of the maximum on the y axis.

Return

number:

This action gets the number of the minimum value on the Y axis. Atrribute: Returns the number value of the minimum on the y axis.

Return

number:

Returns the title for the Y-Axis of the Chart.

Return

text: the y-axis title.

This action gets whether the y axis values are using percent format. Atrribute: Returns true if the y axis is in percent.

Return

boolean:

This action is used to get the list of Y-axis labels from the Y-axis component.

Return

Libraries.Containers.Array: the array containing all of the labels on the Y-axis.

This action returns the currently set Z value of this Item2D.

Return

number:

This action checks if the chart has accessibility information included.

Return

boolean: true if the accessibility information include in the chart.

This action returns true when the border thickness on the control has been set.

Return

boolean: true when the border has thickness on the control.

This action returns true when teh bottom border is enabled.

Return

boolean:

This action returns the current status of the bottom left pixel rounding value.

Return

boolean: true if the control has a bottom left pixel rounding value.

This action returns the current status of the bottom left rounding value.

Return

boolean: true if the control has a bottom left rounding value.

This action returns the current status of the bottom right pixel rounding value.

Return

boolean: true if the control has a bottom right pixel rounding value.

This action returns the current status of the bottom right rounding value.

Return

boolean: true if the control has a bottom right rounding value.

This action gets whether the color property override is activated.

Parameters

• text property

Return

boolean: true if the color property is overridden.

This action sets the visability of the factor name annotation on the points.

Return

boolean: true displays the annotation on the points.

This action returns the current status of the font outline thickness.

Return

boolean: true if the control has a font outline thickness set.

This action returns true if the chart has groups.

Return

boolean:

This action returns true when teh left border is enabled.

Return

boolean:

This action returns true if this chart includes a movable regression line, or false otherwise.

Return

boolean: True if this chart has a movable regression line, or false otherwise.

This action returns an integer representing the type of collision shape currently attached to this item.

Return

boolean: The integer representing the type of collision shape for this item

This action gets whether the number property override is activated.

Parameters

• text property

Return

boolean: true if the number property is overridden.

Return

boolean

Parameters

• text key

Return

boolean

This action returns true when teh right border is enabled.

Return

boolean:

This action returns the current status of the shadow edge fade.

Return

boolean: true if the control has a shadow edge fade.

This action returns the current status of the shadow height.

Return

boolean: true if the control has a shadow height.

This action returns the current status of the shadow width.

Return

boolean: true if the control has a shadow width.

This action returns the current status of the shadow X value.

Return

boolean: true if the control has a shadow X value.

This action returns the current status of the shadow Y value.

Return

boolean: true if the control has a shadow Y value.

This action indicates if this Control has special behavior when asked to navigate in a specific direction. The parameter should be one of ChartItem's navigation constants, e.g. UP, DOWN, ENTER, etc. By default this always returns false, but some classes may override this with different values.

Parameters

• integer navigationType

Return

boolean:

This action returns true when teh top border is enabled.

Return

boolean:

This action returns the current status of the top left pixel rounding value.

Return

boolean: true if the control has a top left pixel rounding value.

This action returns the current status of the top left rounding value.

Return

boolean: true if the control has a top left rounding value.

This action returns the current status of the top right pixel rounding value.

Return

boolean: true if the control has a top right pixel rounding value.

This action returns the current status of the top right rounding value.

Return

boolean: true if the control has a top right rounding value.

This action is used to indicate that an Item and all Items that were added to it should not be visible on the screen. Note that the Item class on its own cannot be drawn on the screen, but classes that inherit from it such as Libraries.Game.Graphics.Drawable can be. By default, Items are considered visible.

This action hides all major and minor grid lines on the x-axis and y-axis.

Flag used to hide all the points of all lines.

This action hides the ticks on the X and Y axis.

This action hides all major and minor grid lines on the x-axis.

This action hides all major and minor grid lines on the y-axis.

This action hides all major grid lines on the x-axis and y-axis.

This action hides all major grid lines on the x-axis.

This action hides all major grid lines on the y-axis.

This action hides all minor grid lines on the x-axis and y-axis.

This action hides all minor grid lines on the x-axis.

This action hides all minor grid lines on the y-axis.

This action returns whether or not this Item accepts mouse input. If the value is true, this will intercept incoming mouse events, triggering any related MouseListeners and InputSets and preventing the mouse event from propagating to other Items on the Layer. The default value is true.

Return

boolean: True if this Item can receive mouse events, or false otherwise.

Single set of brackets and arrows reused for all selectable elements that would need them

Return

boolean:

The IsClipping action returns true if pixel clipping is enabled, or false if it is disabled. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

Return

boolean: Whether or not pixel clipping is enabled for this Item.

This action determines whether this item is collidable.

Return

boolean: True if this item is collidable, false otherwise

The IsCustomDrawing action returns whether or not this Item is directly managing how itself and its children are drawn. When this value is true, the Item is responsible for determining its rendering via the Draw(Painter2D) action -- if this action isn't overridden, the Item and its children won't be drawn. This is an advanced feature only necessary for complex custom components, and most users will not need to use this functionality.

Return

boolean: Whether or not this Item is currently using custom drawing rules.

This action returns whether or not any items are contained in this Item.

Return

boolean:

This action enables or disables escape to last item functionality. If enabled, this object's Escape Item will be the last ChartItem that accessed this Item via the Enter key. That means that if this is enabled, the escape item will be dynamically adjusted, instead of a static value.

Return

boolean:

This action sets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Return

boolean:

This action will return if the Item2D is currently flipped across the x-axis.

Return

boolean:

This action will return if the Item2D is currently flipped across the y-axis.

Return

boolean:

This action returns whether or not the Item can currently receive focus. This property can be set with SetFocusable().

Return

boolean:

The IsFocused action determines if this Item is currently focused, returning true if it is, or false if it is not.

Return

boolean:

This action returns true if the y-intercepts of the regression lines are locked, or false otherwise.

Return

boolean: True if the y-intercepts of the regression lines are locked, or false otherwise.

This action gets the number of broadphase nodes this item has. This action is used internally and users should not need to use this action.

Return

boolean: The number of broadphase nodes attached to this item

This action returns true if the item has been added to a Layer, or false otherwise.

Return

boolean: True if the item is on a Layer, or false otherwise.

Sets the escape Item accessed from this Item in the chart selection (by default using the ESCAPE key).

Return

boolean:

This action determines whether physics is currently enabled for this item.

Return

boolean: True if physics is enabled for this item, false otherwise

Returns true if rendering the focus event.

Return

boolean:

Returns true if rendering the mouse down event.

Return

boolean:

Returns true if rendering the mouse over event.

Return

boolean:

Returns true if rendering the selection event.

Return

boolean:

This action sets this item to be collidable. Passing true turns on collision for this item while passing false turns off collision for this item.

Return

boolean:

This action determines whether physics is currently enabled for this item.

Return

boolean: True if physics is enabled for this item, false otherwise

This action returns true if the chart is separated by factor or series.

Return

boolean:

This action returns true if the chart is separated by factor.

Return

boolean:

This action returns true if the chart is separated by series.

Return

boolean:

This action returns whether the Item is currently set to be visible on the screen.

Return

boolean: A boolean representing whether or not the Item is currently visible.

This action checks if the legend is shown.

Return

boolean: true if the legend is shown.

This action checks if the linear regression line is visible on the chart.

Return

boolean: True if the linear regression line is shown.

This action checks if the major grid lines on the x-axis are shown.

Return

boolean:

This action checks if the major grid lines on the y-axis are shown.

Return

boolean:

This action checks if the minor grid lines on the x-axis are shown.

Return

boolean:

This action checks if the minor grid lines on the y-axis are shown.

Return

boolean:

Return

boolean:

This action checks if the titles are visible.

Return

boolean: true if the sub chart titles are showing

This action checks if the subtitle is visible.

Return

boolean: true if the chart subtitle is showing

This action checks if the title is visible.

Return

boolean: true if the chart title is showing

This action checks if the x-axis to visible (true) or hidden (false).

Return

boolean: True if the x-axis is shown.

This action checks if the title is visible.

Return

boolean: true if the x-axis title is showing

This action checks if the Y-axis to visible (true) or hidden (false).

Return

boolean: True if the Y-axis is shown.

This action checks if the title is visible.

Return

boolean: true if the y-axis title is showing

This action gets the position of the center of this item in local coordinates (i.e., with respect to itself).

Return

boolean: The vector representing the center of this item in local coordinates

This action sets the x-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Return

boolean:

This action creates the nodes for this item for the broadphase collision. This action is needed in order to add the item to the collision detection system. This action is used internally and users should not need to use this action.

Return

boolean:

LoadChartAreaItems This action is used to load the graphical components of the chart area. This is handled automatically by the Game engine as needed, and most users shouldn't need to use this action directly.

LoadGraphics This action is used to load the graphical components of the Control. This is handled automatically by the Game engine as needed, and most users shouldn't need to use this action directly.

Parameters

• Libraries.Interface.Layouts.LayoutProperties

This action locks the y-intercepts of regression lines to the given value (most commonly 0).

Parameters

• number intercept: The new y-intercept value that all regression lines in the chart must pass through.

This action is fired if the item lost the focus.

Parameters

• Libraries.Interface.Events.FocusEvent

Unlike many kinds of user interface controls, there is no universal way of interacting with a chart and, as such, this may be defined by any chart to be custom. As such, charts must be able to take messages suggesting an item in the chart has either lost or gained the focus. Broadly speaking, this is done automatically and while charts need to implement this action, they do not need to call this action directly. This action will control the GainedSelection for ChartItems shared amoung all charts. Any ChartItems specific to one type of chart (i.e. lines for LineCharts) will have an addition GainedSelection action defined in the inherited class.

LostSelection is a supplemental action to the parent Chart's LostSelection. Any items specific to only this type of chart or if an item needs different highlighting instructions than that of the parent class, it will have their LostSelection defined here. Unlike many kinds of user interface controls, there is no universal way of interacting with a chart and, as such, this may be defined by any chart to be custom. As such, charts must be able to take messages suggesting an item in the chart has either lost or gained the focus. Broadly speaking, this is done automatically and while charts need to implement this action, they do not need to call this action directly.

Parameters

• Libraries.Interface.Controls.Charts.ChartItem: the ChartItem representing the structure for this particular kind of chart.

This action will increase the x and y coordinates of this Item by the values stored in the provided Vector2.

Parameters

• Libraries.Compute.Vector2

This action will increase the x and y coordinates of this Item by the given amounts.

Parameters

• number xAmount
• number yAmount

This action will increase the x-coordinate of this Item by the given amount.

Parameters

• number xAmount

This action will increase the y-coordinate of this Item by the given amount.

Parameters

• number yAmount

This action will increase the z-coordinate of this Item by the given amount.

Parameters

• number zAmount

This action returns whether or not the Control is in need of laying out by its container (or the parent Layer2D, if no container Control exists).

Return

boolean:

This action indicates whether the system needs its graphics updated.

Return

boolean: whether or not an update is required

This action adds a different Item2D into this one, storing the added Item2D at a specific index in the internal array.

Parameters

• Libraries.Interface.Events.ControlActivationEvent

This action will notify all SelectionListeners which have been added to the Control of the given SelectionEvent.

Parameters

• Libraries.Interface.Events.SelectionEvent: The SelectionEvent to send to all SelectionListeners registered with the Control.

OnSelectionChange is a supplemental action to the parent Chart's OnSelectionChange. Any items specific to only this type of chart or if an item needs different highlighting instructions than that of the parent class, it will have their GainedSelection defined here. Unlike many kinds of user interface controls, there is no universal way of interacting with a chart and, as such, this may be defined by any chart to be custom. As such, charts must be able to take messages suggesting an item in the chart has either lost or gained the focus. Broadly speaking, this is done automatically and while charts need to implement this action, they do not need to call this action directly.

Parameters

• Libraries.Interface.Controls.Charts.ChartItem: the ChartItem representing the structure for this particular kind of chart.

This action returns the value of a flag for tracking whether the orientation has changed.

Return

boolean:

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Parameters

• Libraries.Containers.Array

This action is used by the layout to position the graphical components of the Chart. Layout is handled automatically so users don't need to use this action directly.

Parameters

• Libraries.Containers.Array

Checks to see if the Item2D's internal vertices are up to date, and updates them if they are not. This is used primarily internally to ensure that the item's vertices are properly aligned before use, e.g. to project an image on the screen at the coordinates of the vertices. Most users will never need to use this action directly.

This action takes a gesture event and handles it. It will first test to see if the gesture event took place within the bounds of this Item. If so, it will notify any GestureListeners of the event. If the event was not contained within this Item, or if there are no GestureListeners on this Item, the Item will ask its parent Item to process the event, if there is a parent.

Parameters

• Libraries.Interface.Events.GestureEvent

This action takes a mouse event and handles it. It will first test to see if the mouse event took place within the bounds of this Item. If so, it will notify any MouseListeners of the event. If the event was not contained within this Item, or if there are no MouseListeners on this Item, the Item will ask its parent Item to process the mouse event, if there is a parent.

Parameters

• Libraries.Interface.Events.MouseEvent

This action takes a touch event and handles it. It will first test to see if the touch event took place within the bounds of this Item. If so, it will notify any TouchListeners of the event. If the event was not contained within this Item, or if there are no TouchListeners on this Item, the Item will ask its parent Item to process the touch event, if there is a parent.

Parameters

• Libraries.Interface.Events.TouchEvent

This action is used to draw this Item on the screen, and then draw all of the Item's children hierarchy on the screen. Note that Items themselves can not be drawn, but some classes that extend the Item class, such as the Libraries.Game.Graphics.Drawable class, can be. To see how they draw, see their documentation.

Parameters

• Libraries.Game.Graphics.Painter2D

This action is used when a control is released by the mouse.

This action removes an Item2D from the internal array.

Parameters

• Libraries.Interface.Item2D

Return

boolean:

This action removes an Item2D at a specifed index from the internal array.

Parameters

• integer index

Return

Libraries.Interface.Item2D:

This action removes an Item2D from the internal array.

Parameters

• Libraries.Interface.Events.ControlActivationListener

This action removes a FocusListener from the Item. The listener will no longer receive notification if the Item gets a FocusEvent.

Parameters

• Libraries.Interface.Events.FocusListener

This action removes a GestureListener from the Item. The listener will no longer receive notification if the Item gets a GestureEvent.

Parameters

• Libraries.Interface.Events.GestureListener

Returns true if rendering the mouse over event.

Parameters

• Libraries.Interface.Layouts.LayoutProperties

This action removes a MouseListener from the Item. The listener will no longer receive notification if the Item gets a mouse click event.

Parameters

• Libraries.Interface.Events.MouseListener

This action removes a MouseMovementListener from the Item. The listener will no longer receive notification if the Item gets a mouse movement event.

Parameters

• Libraries.Interface.Events.MouseMovementListener

This action removes a MouseWheelListener from the Item. The listener will no longer receive notification if the Item gets a mouse wheel event.

Parameters

• Libraries.Interface.Events.MouseWheelListener

This action removes the given SelectionListeners from the Control.

Parameters

• Libraries.Interface.Events.SelectionListener: the selectionListener to remove from the control.

Return

boolean: true if the selectionListener is removed.

This action removes a TouchListener from the Item. The listener will no longer receive notification if the Item gets a TouchEvent.

Parameters

• Libraries.Interface.Events.TouchListener

This action requests that this Control should be laid out by its container (or the Layer2D if there is no containing Control) during the next Update.

This action requests that this Control (as well as all of its descendents) should reload their graphics during the next Update.

This action informs the engine that this Item needs to recalculate its vertex values before they can be used (most commonly, to be drawn to the screen). Most users will never need to call this directly. If you are using a custom ShaderProgram with this Item, you can use this action to indicate that the shader mapping should reset the vertex values for this Item before its drawn again.

This action sets the y-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Parameters

• boolean flag

This action is used to indicate that the Control no longer needs to be laid out. This is called internally by the system as needed, and shouldn't be necessary for most users.

This action sets the mass, mass moment of inertia, and how the 2D item should move (via linear velocity) to be at the desired location.

This action is called whenever the window is resized.

Rotates this Item2D by the given number of degrees. This will also rotate all Items in the children hierarchy of this Item.

Parameters

• number degrees

This action is used to rotate the X-axis labels by a number of degrees.

Parameters

• integer degrees: between 0 and 360.

This is a helper action for saving that saves at the path relative to the current working directory.

Parameters

• text path: the path relative to the working directory.

This action saves this chart to disk at the position of the current file. To conduct the conversion, the file extension is used. Only Scalable Vector Graphics (SVG) is currently supported.

Parameters

• Libraries.System.File: the location of where to save the file.

This action will multiply the x scaling and y scaling values, respectively, by the given numbers. A parameter of 0 or less will be ignored.

Parameters

• number xAmount
• number yAmount

This action will multiply the current scaling value by the given number. A parameter of 0 or less will be ignored.

Parameters

• number amount

This action will multiply the current scaling value by the given number. A parameter of 0 or less will be ignored. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Parameters

• number amount