Libraries.Interface.Controls.Charts.TwoVariableChart Documentation
The TwoVariableChart class is Chart object that inherits from Control and like other UI elements it is added to the Game class. TwoVariableChart is a parent to the LineChart and the ScatterPlot class and is not directly used itself.
Example Code
use Libraries.Interface.Controls.Charts
use Libraries.Interface.Controls.Charts.LineChart
use Libraries.Game.Game
class Main is Game
action Main
StartGame()
end
action CreateGame
LineChart chart
Add(chart)
end
end
Inherits from: Libraries.Interface.Controls.Charts.Chart, Libraries.Interface.Controls.Control, Libraries.Interface.Item, Libraries.Interface.Controls.Charts.ChartItem, Libraries.Interface.Item2D, Libraries.Language.Object
Actions Documentation
Activate()
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.
Activate(Libraries.Interface.Events.BehaviorEvent event)
Add(integer index, Libraries.Interface.Item2D newItem)
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
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(0, child)
Add(Libraries.Interface.Item2D newItem)
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
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(child)
AddBehavior(Libraries.Interface.Behaviors.Behavior behavior)
AddChartAreaInstructions(text description)
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
AddChartItemInstructions(Libraries.Interface.Item chartItem, text description)
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
AddChartLine(Libraries.Interface.Controls.Charts.ChartLine newLine)
Used to create a new ChartLine object for the chart and add it to the lines array.
Parameters
AddControlActivationListener(Libraries.Interface.Events.ControlActivationListener listener)
This action removes an Item2D at a specifed index from the internal array.
Parameters
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(0, child)
parentItem:Remove(0)
AddFocusListener(Libraries.Interface.Events.FocusListener listener)
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
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.FocusListener
Item myItem
FocusListener listener
myItem:AddFocusListener(listener)
AddGestureListener(Libraries.Interface.Events.GestureListener listener)
This action adds a GestureListener to the Item. If the Item ever receives a GestureEvent, the listener will be notified.
Parameters
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.GestureListener
Item myItem
GestureListener listener
myItem:AddGestureListener(listener)
AddGroupPanel(Libraries.Interface.Controls.Charts.GroupPanel group)
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
AddGroupPanelInstructions(Libraries.Interface.Controls.Charts.Graphics.ChartDrawable groupPanel, text description)
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
AddLayoutProperties(Libraries.Interface.Layouts.LayoutProperties properties)
Returns true if rendering the mouse down event.
Parameters
AddMouseListener(Libraries.Interface.Events.MouseListener listener)
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
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.MouseListener
Item myItem
MouseListener listener
myItem:AddMouseListener(listener)
AddMouseMovementListener(Libraries.Interface.Events.MouseMovementListener listener)
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
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.MouseMovementListener
Item myItem
MouseMovementListener listener
myItem:AddMouseMovementListener(listener)
AddMouseWheelListener(Libraries.Interface.Events.MouseWheelListener listener)
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
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.MouseWheelListener
Item myItem
MouseWheelListener listener
myItem:AddMouseWheelListener(listener)
AddPoint(Libraries.Interface.Controls.Charts.ChartPoint point)
Used to create a new ChartPoint object for the chart and add it to the chart point array.
Parameters
AddPoints(Libraries.Interface.Controls.Charts.ChartItem summary, Libraries.Interface.Controls.Charts.ChartItem parentItem, Libraries.Containers.Array<Libraries.Interface.Controls.Charts.ChartPoint> points, Libraries.Interface.Controls.Charts.Series currentSeries)
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
AddSelectionListener(Libraries.Interface.Events.SelectionListener listener)
This action adds the given SelectionListeners to the Control.
Parameters
- Libraries.Interface.Events.SelectionListener: the selectionListener to add to the control.
AddSeries(Libraries.Interface.Controls.Charts.Series series)
This action adds to the list of Series.
Parameters
- Libraries.Interface.Controls.Charts.Series: the Series object to add to the list of Series.
AddSubChartAreaInstructions(Libraries.Interface.Controls.Charts.ChartAreaPanel subChartArea, text description)
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
AddTouchListener(Libraries.Interface.Events.TouchListener listener)
This action adds a TouchListener to the Item. If the Item ever receives a TouchEvent, the listener will be notified.
Parameters
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.TouchListener
Item myItem
TouchListener listener
myItem:AddTouchListener(listener)
AdjustForLegend()
This action adjusts the chart for the legend.
AdjustForXAxis()
This action adjusts for the x-axis.
AdjustForYAxis()
This action adjusts for the y-axis.
Advance(number time)
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
ApplyAngularImpulse(number impulse)
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:ApplyAngularImpulse(80)
ApplyForce(Libraries.Compute.Vector2 force, Libraries.Compute.Vector2 point)
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
Example
use Libraries.Compute.Vector2
use Libraries.Interface.Item2D
Item2D item
Vector2 force
Vector2 point
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
point:Set(100, 100) // apply the force to the top right corner of the item
item:ApplyForce(force, point)
ApplyForceToCenter(Libraries.Compute.Vector2 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
Example
use Libraries.Compute.Vector2
use Libraries.Interface.Item2D
Item2D item
Vector2 force
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
item:ApplyForce(force)
ApplyLinearImpulse(Libraries.Compute.Vector2 impulse, Libraries.Compute.Vector2 point)
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
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 impulse
Vector2 point
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
impulse:Set(100)
point:Set(100, 100) // apply the impulse to the top right corner
item:ApplyLinearImpulse(impulse, point)
ApplyTorque(number torque)
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:ApplyTorque(350)
AreChildrenProcessingMouseEvents()
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:
BeginCollision(Libraries.Interface.Item item)
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.
Example
use Libraries.Interface.Item
Item collider1
Item collider2
collider1:BeginCollision(collider2)
collider2:BeginCollision(collider1)
BeginMouseOver()
This action is used when a control is moused over by the mouse.
CalculateLineSegmentPhrase(Libraries.Interface.Controls.Charts.ChartPoint point1, Libraries.Interface.Controls.Charts.ChartPoint point2, integer iteration)
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:
CanRotate(boolean flag)
This action gets the position of the center of this item in global (world) coordinates.
Parameters
- boolean flag
CancelBehaviors()
This action stops all behaviors this Item is following without finishing them.
CastToPoints(Libraries.Containers.Array<Libraries.Interface.Item> chartAreaItems)
If we have any Series objects from movable regression lines, gather those up so we can iterate over them too.
Parameters
Return
CheckPlatformInstructions()
This action is used to check the current platform and adjust the command instructions to use gestures rather than keys
Example
use Libraries.Compute.Statistics.DataFrame
use Libraries.Interface.Controls.Charts.BarChart
DataFrame frame
frame:Load("Data.csv")
frame:AddSelectedColumn(1)
BarChart chart = frame:BarChart()
chart:CheckPlatformInstructions
ClickedMouse()
This action is used when a control is clicked by the mouse.
CollideWithChildren()
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:
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.
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Example
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
ComputeDistance(Libraries.Compute.Vector2 point, integer childIndex, Libraries.Compute.Vector2 normalOut)
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
Contains(number containsX, number containsY)
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.
Example
use Libraries.Interface.Item2D
Item2D item
item:SetPosition(50, 50)
item:SetWidth(100)
item:SetHeight(50)
boolean value = item:Contains(125, 70)
ConvertToScalableVectorGraphics(boolean hasAccessibility)
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.
ConvertToScalableVectorGraphics()
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.
CopyAndActivateInputTable(text name)
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
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.TextBox
use Libraries.Game.InputTable
class Main is Game
action Main
StartGame()
end
action CreateGame
TextBox box
InputTable copy = box:CopyAndActivateInputTable("New Group")
end
action Update(number seconds)
end
end
CreateNodes(Libraries.Game.Collision.BroadphaseCollision2D broadphase, Libraries.Game.Collision.PhysicsPosition2D transform)
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
DestroyNodes(Libraries.Game.Collision.BroadphaseCollision2D broadphase)
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
Display(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. 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
Display(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.
Parameters
- integer width
- integer height
Display()
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.
Display(integer width, integer height, 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. 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
Dispose()
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.
DisposeAll()
This action is used to call Dispose on this Item and on the entire children hierarchy of this Item.
DisposeChildren()
This action is used to call Dispose on the entire children hierarchy of this Item. This will not call Dispose on this Item.
DisposeDrawables()
DisposeDrawables Empties drawables from the chart area.
DoSpecialNavigation(integer navigationType)
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
Draw(Libraries.Game.Graphics.Painter2D painter)
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
Empty()
This action will remove all items from this item's children hierarchy. Note that this will not empty the hierarchies of the contained Items.
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child1
Item2D child2
Item2D grandchild
parentItem:Add(child1)
parentItem:Add(child2)
child1:Add(grandChild)
parentItem:Empty()
EmptyAll()
This action will call Empty on the entire children hierarchy of this item, and then empty this item as well.
EmptyChildren()
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.
EmptySelectionListeners()
This action empties or removes all SelectionListeners which have been added to the Control of the given SelectionEvent.
EnablePhysics(boolean flag)
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
Example
use Libraries.Game.Graphics.Drawable
Drawable circle
circle:LoadFilledCircle(30)
circle:EnablePhysics(true)
EndMouseOver()
This action is used when a control is moused over and it ends.
Equals(Libraries.Language.Object object)
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.
Example
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
FastMoving(boolean flag)
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
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 velocity
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
velocity:Set(100, 0)
item:SetLinearVelocity(velocity)
Vector2 currentVelocity = item:GetLinearVelocity()
FinishCollision(Libraries.Interface.Item item)
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.
Example
use Libraries.Interface.Item
Item collider1
Item collider2
collider1:FinishCollision(collider2)
collider2:FinishCollision(collider1)
FlipOrientation()
If not already changed, this action will flip the axis at the current state.
Example
//Would result in the y-axis having the title "My X title" and the x-axis having the title "My Y title"
chart:SetXAxisTitle("My X title")
chart:SetYAxisTitle("My Y title")
chart:FlipOrientation() // Flipping after setting titles
//Would result in the y-axis having the title "My Y title" and the x-axis having the title "My X title"
chart:FlipOrientation() // Flipping before setting titles
chart:SetXAxisTitle("My X title")
chart:SetYAxisTitle("My Y title")
FlipX()
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.
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:FlipX()
FlipY()
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.
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:FlipY()
Focus()
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.
GainedFocus(Libraries.Interface.Events.FocusEvent event)
GainedSelection()
This action obtains the displayable name for this region of the chart.
GenerateInfoTree()
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
GenerateLineDescription(Libraries.Interface.Controls.Charts.ChartLine line)
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.
GeneratePointDescriptionX(Libraries.Interface.Controls.Charts.ChartPoint point)
This is called to find the proper X text output based on the various ScatterPlot label overrides.
Parameters
Return
text:
GeneratePointDescriptionY(Libraries.Interface.Controls.Charts.ChartPoint point)
This is called to find the proper Y text output based on the various ScatterPlot label overrides.
Parameters
Return
text:
GeneratePointSummary(Libraries.Interface.Controls.Charts.ChartPoint point)
This is called to generate the summary that is heard when you first focus on the chart points.
Parameters
GenerateSummary()
Only used if the chart has a Legend. Otherwise, this does nothing.
Return
text:
GetAccentColor()
This action gets the accent color from the control.
Return
Libraries.Game.Graphics.ColorGroup: the accent control.
GetAccessibilityCode()
This action returns the current accessiblity code for this Item
Return
integer:
GetAccessibilityRoleDescription()
This action returns the custom accessibility role description for this item, if any.
Return
text:
GetAccessibilityType()
This action returns the name of the accessiblity code for this Item as Text
Return
text:
GetAccessibleParent()
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
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(child)
Item2D item = child:GetParent()
GetActivationBehavior()
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
GetAllLines()
GetAngularDamping()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inverseInertia = item:GetInverseInertia()
GetAngularVelocity()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetAngularVelocity(0.1)
number angularVelocity = item:GetAngularVelocity()
GetBackground()
This action gets the Drawable in the background of the chart.
Return
Libraries.Game.Graphics.Drawable: the chart background Drawable.
GetBackgroundColor()
This action gets the color of the Control background color.
Return
Libraries.Game.Graphics.ColorGroup: the background the color.
GetBorderColor()
This action gets the border color of the control.
Return
Libraries.Game.Graphics.ColorGroup: the controls border color.
GetBorderStyle()
This action gets the border style either, LayoutProperties.TOP, LayoutProperties.BOTTOM, LayoutProperties.LEFT, LayoutProperties.RIGHT, and LayoutProperties.ALL.
Return
integer:
GetBorderThickness()
This action gets the border thickness on the control.
Return
number: the border thickness.
GetBottomLeftPixelRounding()
This action returns the bottom left pixel rounding value.
Return
number: the bottom left pixel rounding value.
GetBottomLeftRounding()
This action returns the bottom left rounding value.
Return
number: the bottom left rounding value.
GetBottomMargin()
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.
GetBottomPadding()
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.
GetBottomRightPixelRounding()
This action returns the bottom right pixel rounding value.
Return
number: the bottom right pixel rounding value.
GetBottomRightRounding()
This action returns the bottom right rounding value.
Return
number: the bottom right rounding value.
GetBoundingBox(integer childIndex)
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
GetBoundingRectangle()
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
Example
use Libraries.Interface.Item2D
use Libraries.Game.Shapes.Rectangle
Item2D myItem
myItem:SetBoundingBox(20, 80, 100, 100)
Rectangle box = myItem:GetBoundingRectangle()
GetCenterX()
This action returns the x coordinate of the center of this Item2D.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetWidth(20)
myItem:SetX(100)
number x = myItem:GetCenterX()
GetCenterY()
This action returns the y coordinate of the center of this Item2D.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetHeight(20)
myItem:SetY(100)
number y = myItem:GetCenterY()
GetChartArea()
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
GetChartAreaHeightPercent()
This action gets the chart area height percent of the whole chart height.
Return
number:
GetChartAreaItem()
GetChartAreaWidthPercent()
This action gets the chart area width percent of the whole chart width.
Return
number:
GetChartItemText()
This action gets text for a chart item.
Return
text: the chart item text.
GetChartItemsText()
This action gets text for a chart items.
Return
text: the chart items text.
GetChartPoints()
GetChildren()
This action gets the children of this item in an array.
Return
Libraries.Containers.Array: The children of this item in an array
Example
use Libraries.Interface.Item2D
Item2D parent
Item2D child1
Item2D child2
parent:Add(child1)
parent:Add(child2)
Array<Item2D> children = parent:GetChildren()
GetClipCoordinates(Libraries.Compute.Vector2 xCoords, Libraries.Compute.Vector2 yCoords)
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
Return
boolean:
GetCollisionGroupFlag()
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
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 force
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
item:SetForce(force)
Vector2 totalForce = item:GetForce()
GetCollisionGroupIndex()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetAngularVelocity(0.1)
number angularVelocity = item:GetAngularVelocity()
GetCollisionList()
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
GetColorProperty(text property)
This action gets the color of a given property in the Control.
Parameters
- text property
Return
GetContainer()
This action get the current chart object.
Return
Libraries.Interface.Controls.Charts.Chart: the chart object.
GetContainerGridHeight()
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:
GetContainerGridWidth()
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:
GetCurrentLayoutProperties()
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.
GetDefaultFont()
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
Example
use Libraries.Interface.Controls.TextBox
use Libraries.Game.Graphics.Font
TextBox box
text name = box:GetDefaultFont()
output name
GetDefaultFontName()
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:
Example
use Libraries.Interface.Controls.TextBox
TextBox box
text name = box:GetDefaultFontName()
output name
GetDefaultFontSize()
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:
Example
use Libraries.Interface.Controls.TextBox
TextBox box
integer size = box:GetDefaultFontSize()
output size
GetDefaultLayoutProperties()
This action returns the default LayoutProperties used for this Control.
Return
Libraries.Interface.Layouts.LayoutProperties: The default LayoutProperties of this Control.
GetDensity()
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:
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 impulse
Vector2 point
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
impulse:Set(100)
point:Set(100, 100) // apply the impulse to the top right corner
item:ApplyLinearImpulse(impulse, point)
GetDescription()
This action returns the current internal description of the Item.
Return
text:
Example
use Libraries.Interface.Item
Item item
item:SetDescription("Used for demo purposes.")
output "My item's description is : " + item:GetDescription()
GetDisplayName()
This action obtains the displayable name for this region of the chart.
Return
text: the display name
GetDownItem()
Returns the Item accessed "below" (via the DOWN arrow) this Item in the chart selection.
Return
GetDrawableShape()
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
GetEnterInstruction()
This action gets the instruction text for an enter description.
Return
text: The description for enter.
GetEnterItem()
Returns the Item accessed within (default: ENTER key) this Item in the chart selection.
Return
GetEscapeItem()
Returns the escape Item accessed from this Item in the chart selection (by default using the ESCAPE key).
Return
GetExitInstruction()
This action gets the instruction text for an exit description.
Return
text: The description for exit.
GetFactorList()
Returns an array of the factor/group names
Return
Libraries.Containers.Array: Array
GetFocusBorderColor()
This action gets the focus border color.
Return
Libraries.Game.Graphics.ColorGroup: the focus border color.
GetFocusColor()
GetFocusFontColor()
GetFocusListeners()
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.
GetFont()
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.
GetFontColor()
This action gets the current the font color of the font contained in the Control.
Return
GetFontOutlineColor()
This action gets the font outline color value.
Return
Libraries.Game.Graphics.ColorGroup: the font outline color value.
GetFontOutlineThickness()
This action returns the font outline thickness value.
Return
number: the font outline thickness value.
GetFontSize()
This action returns the base Font size to be used by this Control, if the Control uses a Font.
Return
integer:
GetForce()
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
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 force
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
item:SetForce(force)
Vector2 totalForce = item:GetForce()
GetForegroundColor()
This action gets the color of the Control foreground color.
Return
Libraries.Game.Graphics.ColorGroup: the foreground color.
GetForegroundSelectionColor()
This action gets the color of the Control foreground selection color.
Return
Libraries.Game.Graphics.ColorGroup: the foreground selection color.
GetFriction()
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:
Example
use Libraries.Compute.Vector2
use Libraries.Interface.Item2D
Item2D item
Vector2 force
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
item:ApplyForce(force)
GetGeneralInstruction()
This action gets the instruction text for a general chart description.
Return
text: The description for a general chart.
GetGestureListeners()
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.
GetGlobalX()
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:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetX(100)
myItem:SetX(30)
number globalX = myItem:GetGlobalX()
GetGlobalY()
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:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetY(60)
myItem:SetX(90)
number globalY = myItem:GetGlobalY()
GetGlobalZ()
This action returns the Item's global z value. For an Item2D, this simply returns the Item2D's current z value.
Return
number:
GetGlowColor()
This action gets the glow color from the control.
Return
Libraries.Game.Graphics.ColorGroup: the glow color.
GetGridHeight()
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:
GetGridWidth()
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:
GetGridX()
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:
GetGridY()
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:
GetGroupPanels()
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
GetGroupText()
This action gets text for a group.
Return
text: the group text.
GetGroupsText()
This action gets text for groups.
Return
text: the groups text.
GetHashCode()
This action gets the hash code for an object.
Return
integer: The integer hash code of the object.
Example
Object o
integer hash = o:GetHashCode()
GetHeight()
This action will return the currently set height of the Item2D.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
number height = myItem:GetHeight()
GetHorizontalFlag()
This action returns whether the chart is in the horizontal position.
Return
boolean:
GetHorizontalLayoutMode()
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.
GetHorizontalPanel()
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
GetHorizontalPanelHeightPercent()
This action gets the horizontal panel height percent of the whole chart height.
Return
number:
GetHorizontalPanelWidthPercent()
This action gets the horizontal panel width percent of the whole chart width.
Return
number:
GetIcon()
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
GetIconColor()
This action gets the Icon color from the control.
Return
Libraries.Game.Graphics.ColorGroup: the icon color.
GetInertia()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inertia = item:GetInertia()
GetInputGroup()
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.
Example
use Libraries.Interface.Item
Item item
item:SetInputGroup("arrowKeys")
output "My item's input group is : " + item:GetInputGroup()
GetInputTable()
Return
GetInterfaceOptionsKey()
This action sets the base Font size to be used by this Control, if the Control uses a Font.
Return
text:
GetInterfaceScale()
This action sets the interface scale for the control.
Return
number: the scale, a number between 0 and 1 that scales the control.
GetInverseInertia()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inverseInertia = item:GetInverseInertia()
GetInverseMass()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inverseMass = item:GetInverseMass()
GetItem(integer index)
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
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child1
Item2D child2
parentItem:Add(child1)
parentItem:Add(child2)
Item temp = parentItem:GetItem(0)
GetItemAt(number x, number y)
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.
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
Item2D grandchild
parentItem:Add(child)
child:Add(grandchild)
grandchild:SetHeight(100)
grandchild:SetWidth(100)
Item2D temp = parentItem:GetItemAt(75, 75)
GetItemCount()
This action returns the number of items contained in this Item2D.
Return
integer:
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child1
Item2D child2
parentItem:Add(child1)
parentItem:Add(child2)
integer size = parentItem:GetItemCount()
GetItems()
This action returns an iterator containing all the items contained in this Item2D.
Return
Example
use Libraries.Interface.Item2D
use Libraries.Containers.Iterator
Item2D parentItem
Item2D child1
Item2D child2
parentItem:Add(child1)
parentItem:Add(child2)
Iterator<Item2D> iterator = parentItem:GetItems()
GetJointList()
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
GetLabelText()
This action returns the text used for this Control's label, if it has one.
Return
text: The text of this Control's label.
GetLayer()
This action returns the current Layer2Dthat this Item2D is a part of in the Game libraries.
Return
GetLayout()
GetLayoutProperties(number containerWidth, number containerHeight)
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.
GetLayoutProperties()
GetLayoutRows()
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:
GetLeftItem()
Returns the Item accessed to the left of this Item in the chart selection.
Return
GetLeftMargin()
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.
GetLeftPadding()
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.
GetLegend()
This action returns the current legend, if one exists
Return
Libraries.Interface.Controls.Charts.Legend: the Legend on the chart.
GetLegendIconBorderThickness()
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:
GetLegendTitle()
Returns the title for the legend of the Chart.
Return
text:
GetLine(integer i)
Return a specific line from the chart.
Parameters
- integer i
Return
GetLineDensity()
Set and get the line density.
Return
integer:
GetLinearDamping()
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)
GetLinearVelocity()
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
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 velocity
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
velocity:Set(100, 0)
item:SetLinearVelocity(velocity)
Vector2 currentVelocity = item:GetLinearVelocity()
GetLinearVelocityFromLocalPoint(Libraries.Compute.Vector2 localPoint)
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
Return
Libraries.Compute.Vector2: The coordinates of the point relative to the center of this item
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 worldPoint
item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 350)
worldPoint:Set(400, 350) // the lower left corner of the item
Vector2 localPoint = item:GetLocalPoint(worldPoint)
GetLinearVelocityFromWorldPoint(Libraries.Compute.Vector2 worldPoint)
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
Return
Libraries.Compute.Vector2: The local coordinates of the corresponding vector
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 worldVector
item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 350)
worldVector:Set(400, 350) // the lower left corner of the item
Vector2 localVector = item:GetLocalVector(worldVector)
GetListOrderInstruction()
This action gets the instruction text for a list order description.
Return
text: The description for list order.
GetLocalCenter()
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
GetLocalPoint(Libraries.Compute.Vector2 worldPoint)
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
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 worldPoint
item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 350)
worldPoint:Set(400, 350) // the lower left corner of the item
Vector2 localPoint = item:GetLocalPoint(worldPoint)
GetLocalVector(Libraries.Compute.Vector2 worldVector)
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
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 worldVector
item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 350)
worldVector:Set(400, 350) // the lower left corner of the item
Vector2 localVector = item:GetLocalVector(worldVector)
GetMass()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number mass = item:GetMass()
GetMass(Libraries.Game.Physics.Mass2D mass)
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
GetMaximumSubdivisions()
This is called to find the proper Y text output based on the various ScatterPlot label overrides.
Return
integer:
GetMouseDownColor()
This action gets the mouse down font color.
Return
Libraries.Game.Graphics.ColorGroup: the mouse over font color value.
GetMouseDownFontColor()
This action gets the mouse down font color.
Return
Libraries.Game.Graphics.ColorGroup: the mouse down font color.
GetMouseDownGlowColor()
This action gets the mouse down glow color.
Return
Libraries.Game.Graphics.ColorGroup: the mouse down glow color.
GetMouseListeners()
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.
GetMouseMovementListeners()
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.
GetMouseOverColor()
This action gets the mouse over color.
Return
Libraries.Game.Graphics.ColorGroup: the mouse over color.
GetMouseOverFontColor()
This action gets the mouse over font color.
Return
Libraries.Game.Graphics.ColorGroup: the mouse over font color value.
GetMouseOverGlowColor()
This action gets the mouse over glow color.
Return
Libraries.Game.Graphics.ColorGroup: the mouse over glow color.
GetMouseWheelListeners()
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.
GetName()
This action returns the current internal name of the Item.
Return
text:
Example
use Libraries.Interface.Item
Item item
item:SetName("My Item")
output "My item's name is " + item:GetName()
GetNextFocus()
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.
GetNodeCount()
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
GetNodes()
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
GetNumberOfChartAreas()
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:
GetNumberOfLines()
Returns the number of full chart lines from the chart.
Return
integer:
GetNumberOfPoints()
Returns the number of points from the chart. (scatter)
Return
integer:
GetNumberProperty(text property)
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.
GetOffsetX()
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:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetX(100)
number offset = myItem:GetOffsetX()
GetOffsetY()
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:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetY(75)
number offset = myItem:GetOffsetY()
GetOffsetZ()
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:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetZ(75)
number offset = myItem:GetOffsetZ()
GetOriginX()
This action will return the current X origin of this Item2D. By default, the origin is at the coordinates 0, 0.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetOriginCenter()
number xOrigin = myItem:GetOriginX()
GetOriginY()
This action will return the current Y origin of this Item2D. By default, the origin is at the coordinates 0, 0.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetOriginCenter()
number yOrigin = myItem:GetOriginY()
GetParent()
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
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(child)
Item2D item = child:GetParent()
GetPercentageHeight()
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.
GetPercentageOriginX()
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:
GetPercentageOriginY()
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:
GetPercentageWidth()
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.
GetPercentageX()
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.
GetPercentageY()
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.
GetPhysicsProperties()
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
GetPixelHeight()
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.
GetPixelWidth()
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.
GetPixelX()
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.
GetPixelY()
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.
GetPointBorderThickness()
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:
GetPointDensity()
Get the point radius.
Return
integer:
GetPointsFlag()
Returns the value of the showPoints flag.
Return
boolean:
GetPopupMenu()
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
GetPreviousFocus()
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.
GetPropertiesSize()
Return
integer
GetProperty(text key)
GetPropertyKeyIterator()
GetQuadrantThreshold()
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:
GetRawInertia()
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:
GetRegions()
GetRegressionLineColor()
This action gets the regression line color.
Return
Libraries.Game.Graphics.Color: the color value of the regression line.
GetRegressionLineDensity()
This action gets the regression line density represented by an integer value.
Return
integer: the density value of the regression line.
GetResponsiveness()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inverseMass = item:GetInverseMass()
GetRestitution()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetTorque(200)
number totalTorque = item:GetTorque()
GetRightItem()
Returns the Item accessed to the right of this Item in the chart selection.
Return
GetRightMargin()
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.
GetRightPadding()
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.
GetRotation()
Gets the current degree of rotation of this Item.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetRotation(90)
number rotation = myItem:GetRotation()
GetRotationInRadians()
Gets the current rotation of this Item in radians.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetRotation(90)
number rotation = myItem:GetRotationInRadians()
GetRotationOverride()
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.
GetScaleX()
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:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:Scale(1.25)
number scaleX = myItem:GetScaleX()
GetScaleY()
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:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:Scale(1.25)
number scaleY = myItem:GetScaleY()
GetScreenX()
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:
GetScreenY()
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:
GetScriptFilepath()
This action gets the script file path.
Return
text: the script file path.
GetSelection()
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
GetSelectionBorderColor()
This action gets the selection border color.
Return
Libraries.Game.Graphics.ColorGroup: the selection border color.
GetSelectionColor()
This action gets the selection color from the control.
Return
Libraries.Game.Graphics.ColorGroup: the selection color.
GetSelectionFontColor()
This action gets the selection font color on the control.
Return
Libraries.Game.Graphics.ColorGroup: the selection font color.
GetSelectionListeners()
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.
GetSeriesList()
GetSeriesText()
This action gets text for a series.
Return
text: the series text.
GetShadowColor()
This action gets the shaddow color from the control.
Return
Libraries.Game.Graphics.ColorGroup: the shaddow color.
GetShadowEdgeFade()
This action returns the shadow edge fade property.
Return
number: the shadow edge fade number.
GetShadowHeight()
This action returns the shadow height property.
Return
number: the shadow height number.
GetShadowWidth()
This action returns the shadow width property.
Return
number: the shadow width number.
GetShadowX()
This action returns the shadow X value.
Return
number: the shadow X value.
GetShadowY()
This action returns the shadow Y value.
Return
number: the shadow Y value.
GetShape()
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
Example
use Libraries.Game.Drawable
use Libraries.Game.Collision.Shapes.Circle
Drawable ball
ball:Load("ball.png")
Circle circle
circle:SetRadius(30)
ball:SetShape(circle)
CollisionShape2D shape = ball:GetShape()
GetShapeType()
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
GetSleepTime()
This action gets the children of this item in an array.
Return
number: The children of this item in an array
Example
use Libraries.Interface.Item2D
Item2D parent
Item2D child1
Item2D child2
parent:Add(child1)
parent:Add(child2)
Array<Item2D> children = parent:GetChildren()
GetStyleFilepath()
This action gets the style file path.
Return
text: the style file path.
GetSubChartAreas()
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
GetSubHorizontalPanels()
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
GetSubVerticalPanels()
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
GetSubtitle()
This action get the current subtitle for the chart.
Return
text: the subtitle of the chart
GetSubtitleAreaHeightPercent()
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
GetSubtitleLabel()
This action gets the Label object for the chart subtitle.
Return
GetSweep()
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
GetTitle()
This action gets the title of the chart
Return
text: the title of the chart
GetTitleAreaHeightPercent()
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
GetTitleLabel()
This action returns the Label for the chart title.
Return
Libraries.Interface.Controls.Charts.ChartLabel: the chart title label
GetTopLeftPixelRounding()
This action returns the top left pixel rounding value.
Return
number: the top left pixel rounding value.
GetTopLeftRounding()
This action returns the top left rounding value.
Return
number: the top left rounding value.
GetTopMargin()
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.
GetTopPadding()
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.
GetTopRightPixelRounding()
This action returns the top right pixel rounding value.
Return
number: the top right pixel rounding value.
GetTopRightRounding()
This action returns the top right rounding value.
Return
number: the top right rounding value.
GetTorque()
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetTorque(200)
number totalTorque = item:GetTorque()
GetTouchExplorationEnabled()
This action gets the flag to determine if touch exploration is enabled.
Return
boolean: The flag for touch exploration.
GetTouchListeners()
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.
GetTransform()
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
GetTransform0()
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
GetUnfocusedSelectionBorderColor()
This action gets the unfocused selection border color on the control.
Return
Libraries.Game.Graphics.ColorGroup: the unfocused selection border color.
GetUnfocusedSelectionColor()
This action gets the unfocused selection color on the control.
Return
Libraries.Game.Graphics.ColorGroup: the unfocused selection color.
GetUnfocusedSelectionFontColor()
This action gets the unfocused selection font color on the control.
Return
Libraries.Game.Graphics.ColorGroup: the unfocused selection font color.
GetUpItem()
Returns the Item accessed "above" (via the UP arrow) this Item in the chart selection.
Return
GetValueOrderInstruction()
This action gets the instruction text for a value order description.
Return
text: The description for value order.
GetVerticalFlag()
This action returns whether the chart is in the vertical position.
Return
boolean:
GetVerticalLayoutMode()
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.
GetVerticalPanel()
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
GetVerticalPanelHeightPercent()
This action gets the vertical panel height percent of the whole chart height.
Return
number:
GetVerticalPanelWidthPercent()
This action gets the vertical panel width percent of the whole chart width.
Return
number:
GetView2D()
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
GetVisibleItemAt(number x, number y)
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.
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
Item2D grandchild
parentItem:Add(child)
child:Add(grandchild)
grandchild:SetHeight(100)
grandchild:SetWidth(100)
Item2D temp = parentItem:GetVisibleItemAt(75, 75)
GetWidth()
This action will return the currently set width of the Item2D.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
number width = myItem:GetWidth()
GetWorldCenter()
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
GetWorldPoint(Libraries.Compute.Vector2 localPoint)
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
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 localPoint
item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 250)
localPoint:Set(0, 0) // Get the coordinates of the center of the item
Vector2 worldPoint = item:GetWorldPoint(localPoint)
GetWorldVector(Libraries.Compute.Vector2 localVector)
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)
GetX()
This action returns the currently set X coordinate of the Item.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
number value = myItem:GetX()
GetXAxisMaximum()
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:
GetXAxisMinimum()
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:
GetXAxisTitle()
This action gets the title for the X-Axis of the Chart.
Return
text: the x-axis title.
GetXAxisUsePercent()
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:
GetXLabels()
This action is used to get the X-axis labels.
Return
Libraries.Containers.Array: the array of ChartLabel's displayed on the X-axis.
GetXLabelsRotation()
This action is used to get the number of degrees the X-axis labels are rotated.
Return
integer: the degrees the labels are rotated.
GetY()
This action returns the currently set Y coordinate of the Item.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
number value = myItem:GetY()
GetYAxisMaximum()
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:
GetYAxisMinimum()
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:
GetYAxisTitle()
Returns the title for the Y-Axis of the Chart.
Return
text: the y-axis title.
GetYAxisUsePercent()
This action gets whether the y axis values are using percent format. Atrribute: Returns true if the y axis is in percent.
Return
boolean:
GetYLabels()
This action is used to get the list of Y-axis labels from the Y-axis component.
Return
Libraries.Containers.Array: the array
GetZ()
This action returns the currently set Z value of this Item2D.
Return
number:
Example
use Libraries.Interface.Item2D
Item2D myItem
number value = myItem:GetZ()
HasAccessibility()
This action checks if the chart has accessibility information included.
Return
boolean: true if the accessibility information include in the chart.
HasBorderThickness()
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.
HasBottomBorder()
This action returns true when teh bottom border is enabled.
Return
boolean:
HasBottomLeftPixelRounding()
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.
HasBottomLeftRounding()
This action returns the current status of the bottom left rounding value.
Return
boolean: true if the control has a bottom left rounding value.
HasBottomRightPixelRounding()
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.
HasBottomRightRounding()
This action returns the current status of the bottom right rounding value.
Return
boolean: true if the control has a bottom right rounding value.
HasColorPropertyOverride(text property)
This action gets whether the color property override is activated.
Parameters
- text property
Return
boolean: true if the color property is overridden.
HasFactorAnnotations()
This action sets the visability of the factor name annotation on the points.
Return
boolean: true displays the annotation on the points.
HasFontOutlineThickness()
This action returns the current status of the font outline thickness.
Return
boolean: true if the control has a font outline thickness set.
HasGroups()
This action returns true if the chart has groups.
Return
boolean:
HasLeftBorder()
This action returns true when teh left border is enabled.
Return
boolean:
HasMovableRegressionLine()
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.
HasMoved()
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
HasNumberPropertyOverride(text property)
This action gets whether the number property override is activated.
Parameters
- text property
Return
boolean: true if the number property is overridden.
HasProperties()
Return
boolean
HasProperty(text key)
Parameters
- text key
Return
boolean
HasRightBorder()
This action returns true when teh right border is enabled.
Return
boolean:
HasShadowEdgeFade()
This action returns the current status of the shadow edge fade.
Return
boolean: true if the control has a shadow edge fade.
HasShadowHeight()
This action returns the current status of the shadow height.
Return
boolean: true if the control has a shadow height.
HasShadowWidth()
This action returns the current status of the shadow width.
Return
boolean: true if the control has a shadow width.
HasShadowX()
This action returns the current status of the shadow X value.
Return
boolean: true if the control has a shadow X value.
HasShadowY()
This action returns the current status of the shadow Y value.
Return
boolean: true if the control has a shadow Y value.
HasSpecialNavigation(integer navigationType)
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:
HasTopBorder()
This action returns true when teh top border is enabled.
Return
boolean:
HasTopLeftPixelRounding()
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.
HasTopLeftRounding()
This action returns the current status of the top left rounding value.
Return
boolean: true if the control has a top left rounding value.
HasTopRightPixelRounding()
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.
HasTopRightRounding()
This action returns the current status of the top right rounding value.
Return
boolean: true if the control has a top right rounding value.
Hide()
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.
Example
use Libraries.Interface.Item
Item item
item:Hide()
HideAllGridLines()
This action hides all major and minor grid lines on the x-axis and y-axis.
HideAllPoints()
Flag used to hide all the points of all lines.
HideAllTicks()
This action hides the ticks on the X and Y axis.
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:HideAllTicks()
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
HideAllXGridLines()
This action hides all major and minor grid lines on the x-axis.
HideAllYGridLines()
This action hides all major and minor grid lines on the y-axis.
HideMajorGridLines()
This action hides all major grid lines on the x-axis and y-axis.
HideMajorXGridLines()
This action hides all major grid lines on the x-axis.
HideMajorYGridLines()
This action hides all major grid lines on the y-axis.
HideMinorGridLines()
This action hides all minor grid lines on the x-axis and y-axis.
HideMinorXGridLines()
This action hides all minor grid lines on the x-axis.
HideMinorYGridLines()
This action hides all minor grid lines on the y-axis.
IsAcceptingMouseInput()
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.
IsAccessibleParent()
Must be set before displaying the chart.
Return
boolean:
IsClipping()
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.
IsCollidable()
This action determines whether this item is collidable.
Return
boolean: True if this item is collidable, false otherwise
Example
use Libraries.Game.Graphics.Drawable
Drawable circle
circle:LoadFilledCircle(30)
circle:SetCollidable(true)
boolean result = circle:IsCollidable
IsCustomDrawing()
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.
IsEmpty()
This action returns whether or not any items are contained in this Item.
Return
boolean:
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child1
parentItem:Add(child1)
boolean wasEmpty = parentItem:IsEmpty()
IsEscapingToLastItem()
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:
IsFastMoving()
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:
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetAngularVelocity(0.1)
IsFlippedX()
This action will return if the Item2D is currently flipped across the x-axis.
Return
boolean:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:FlipX()
boolean flip = myItem:IsFlippedX()
IsFlippedY()
This action will return if the Item2D is currently flipped across the y-axis.
Return
boolean:
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:FlipY()
boolean flip = myItem:IsFlippedY()
IsFocusable()
This action returns whether or not the Item can currently receive focus. This property can be set with SetFocusable().
Return
boolean:
IsFocused()
The IsFocused action determines if this Item is currently focused, returning true if it is, or false if it is not.
Return
boolean:
IsLockingRegressionYIntercepts()
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.
IsNonResponsive()
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
IsOnLayer()
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.
IsPassingThroughSelection()
Sets the escape Item accessed from this Item in the chart selection (by default using the ESCAPE key).
Return
boolean:
IsPhysicsEnabled()
This action determines whether physics is currently enabled for this item.
Return
boolean: True if physics is enabled for this item, false otherwise
Example
use Libraries.Game.Graphics.Drawable
Drawable circle
circle:LoadFilledCircle(30)
circle:EnablePhysics(true)
boolean result = circle:IsPhysicsEnabled()
IsRenderingFocus()
Returns true if rendering the focus event.
Return
boolean:
IsRenderingMouseDown()
Returns true if rendering the mouse down event.
Return
boolean:
IsRenderingMouseOver()
Returns true if rendering the mouse over event.
Return
boolean:
IsRenderingSelection()
Returns true if rendering the selection event.
Return
boolean:
IsResponsive()
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:
Example
use Libraries.Game.Graphics.Drawable
Drawable circle
circle:LoadFilledCircle(30)
circle:SetCollidable(true)
IsRotationAllowed()
This action determines whether physics is currently enabled for this item.
Return
boolean: True if physics is enabled for this item, false otherwise
Example
use Libraries.Game.Graphics.Drawable
Drawable circle
circle:LoadFilledCircle(30)
circle:EnablePhysics(true)
boolean result = circle:IsPhysicsEnabled()
IsSeparated()
This action returns true if the chart is separated by factor or series.
Return
boolean:
IsSeparatedByFactor()
This action returns true if the chart is separated by factor.
Return
boolean:
IsSeparatedBySeries()
This action returns true if the chart is separated by series.
Return
boolean:
IsShowing()
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.
Example
use Libraries.Interface.Item
Item item
item:Hide()
boolean visible = item:IsShowing()
IsShowingLegend()
This action checks if the legend is shown.
Return
boolean: true if the legend is shown.
IsShowingLinearRegression()
This action checks if the linear regression line is visible on the chart.
Return
boolean: True if the linear regression line is shown.
IsShowingMajorXGridLines()
This action checks if the major grid lines on the x-axis are shown.
Return
boolean:
IsShowingMajorYGridLines()
This action checks if the major grid lines on the y-axis are shown.
Return
boolean:
IsShowingMinorXGridLines()
This action checks if the minor grid lines on the x-axis are shown.
Return
boolean:
IsShowingMinorYGridLines()
This action checks if the minor grid lines on the y-axis are shown.
Return
boolean:
IsShowingPatterns()
Return
boolean:
IsShowingSubChartAreaTitles()
This action checks if the titles are visible.
Return
boolean: true if the sub chart titles are showing
IsShowingSubtitle()
This action checks if the subtitle is visible.
Return
boolean: true if the chart subtitle is showing
IsShowingTitle()
This action checks if the title is visible.
Return
boolean: true if the chart title is showing
IsShowingXAxis()
This action checks if the x-axis to visible (true) or hidden (false).
Return
boolean: True if the x-axis is shown.
IsShowingXAxisTitle()
This action checks if the title is visible.
Return
boolean: true if the x-axis title is showing
IsShowingYAxis()
This action checks if the Y-axis to visible (true) or hidden (false).
Return
boolean: True if the Y-axis is shown.
IsShowingYAxisTitle()
This action checks if the title is visible.
Return
boolean: true if the y-axis title is showing
IsSimulated()
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
IsSimulationRequired()
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:
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetLinearVelocityX(100)
IsUnmovable()
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()
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(Libraries.Interface.Layouts.LayoutProperties properties)
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
LockRegressionYIntercept(number intercept)
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.
Example
use Libraries.Compute.Statistics.DataFrame
use Libraries.Interface.Controls.Charts.ScatterPlot
DataFrame frame
frame:Load("Data/ChartTestData.csv")
frame:AddSelectedColumns("Column1")
frame:AddSelectedColumns("Column2")
frame:AddSelectedFactors("Factor1")
ScatterPlot chart = frame:ScatterPlot()
chart:SetTitle("ScatterPlot Feature Example")
chart:SetSubtitle("Two Columns - One Factor")
chart:ShowLinearRegression(true)
chart:ShowSquaresOfResiduals(true)
chart:ShowMovableRegressionLine(true)
chart:SetResidualSquareThickness(2)
chart:LockRegressionYIntercept(0)
chart:Display(1200, 1200)
LostFocus(Libraries.Interface.Events.FocusEvent event)
LostSelection()
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(Libraries.Interface.Controls.Charts.ChartItem ci)
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.
Move(Libraries.Compute.Vector2 movement)
This action will increase the x and y coordinates of this Item by the values stored in the provided Vector2.
Parameters
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D myItem
myItem:SetX(50)
myItem:SetY(80)
Vector2 vector
vector:Set(25, -20)
myItem:Move(vector)
Move(number xAmount, number yAmount)
This action will increase the x and y coordinates of this Item by the given amounts.
Parameters
- number xAmount
- number yAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetX(50)
myItem:SetY(80)
myItem:Move(25, -20)
MoveX(number xAmount)
This action will increase the x-coordinate of this Item by the given amount.
Parameters
- number xAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetX(50)
myItem:MoveX(25)
MoveY(number yAmount)
This action will increase the y-coordinate of this Item by the given amount.
Parameters
- number yAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetY(50)
myItem:MoveY(25)
MoveZ(number zAmount)
This action will increase the z-coordinate of this Item by the given amount.
Parameters
- number zAmount
Example
use Libraries.Interface.Item@D
Item2D myItem
myItem:SetZ(5)
myItem:MoveZ(2)
NeedsLayout()
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:
NeedsTreeUpdate()
This action indicates whether the system needs its graphics updated.
Return
boolean: whether or not an update is required
NotifyControlActivationListeners(Libraries.Interface.Events.ControlActivationEvent event)
This action adds a different Item2D into this one, storing the added Item2D at a specific index in the internal array.
Parameters
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(0, child)
NotifySelectionListeners(Libraries.Interface.Events.SelectionEvent event)
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(Libraries.Interface.Controls.Charts.ChartItem ci)
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.
OrientationChanged()
This action returns the value of a flag for tracking whether the orientation has changed.
Return
boolean:
OverrideXLabelsWithText(Libraries.Containers.Array<text> labels)
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
OverrideYLabelsWithText(Libraries.Containers.Array<text> labels)
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
PrepareVertices()
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.
ProcessGestureEvent(Libraries.Interface.Events.GestureEvent event)
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
Example
use Libraries.Interface.Item2D
use Libraries.Interface.Events.GestureEvent
use Libraries.Interface.Events.GestureListener
Item2D myItem
GestureListener listener
myItem:AddGestureListener(listener)
GestureEvent event
event:eventType = event:DOUBLE_TAP
myItem:ProcessGestureEvent(event)
ProcessMouseEvent(Libraries.Interface.Events.MouseEvent event)
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
Example
use Libraries.Interface.Item2D
use Libraries.Interface.Events.MouseEvent
use Libraries.Interface.Events.MouseListener
Item2D myItem
MouseListener listener
myItem:AddMouseListener(listener)
MouseEvent event
event:eventType = event:CLICKED_MOUSE
myItem:ProcessMouseEvent(event)
ProcessTouchEvent(Libraries.Interface.Events.TouchEvent event)
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
Example
use Libraries.Interface.Item2D
use Libraries.Interface.Events.TouchEvent
use Libraries.Interface.Events.TouchListener
Item2D myItem
TouchListener listener
myItem:AddTouchListener(listener)
TouchEvent event
event:eventType = event:BEGAN
myItem:ProcessTouchEvent(event)
QueueForDrawing(Libraries.Game.Graphics.Painter2D painter)
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
ReleasedMouse()
This action is used when a control is released by the mouse.
Remove(Libraries.Interface.Item2D item)
This action removes an Item2D from the internal array.
Parameters
Return
boolean:
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(0, child)
parentItem:Remove(child)
Remove(integer index)
This action removes an Item2D at a specifed index from the internal array.
Parameters
- integer index
Return
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(0, child)
parentItem:Remove(0)
RemoveControlActivationListener(Libraries.Interface.Events.ControlActivationListener listener)
This action removes an Item2D from the internal array.
Parameters
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(0, child)
parentItem:Remove(child)
RemoveFocusListener(Libraries.Interface.Events.FocusListener listener)
This action removes a FocusListener from the Item. The listener will no longer receive notification if the Item gets a FocusEvent.
Parameters
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.FocusListener
Item myItem
FocusListener listener
myItem:AddFocusListener(listener)
myItem:RemoveFocusListener(listener)
RemoveGestureListener(Libraries.Interface.Events.GestureListener listener)
This action removes a GestureListener from the Item. The listener will no longer receive notification if the Item gets a GestureEvent.
Parameters
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.GestureListener
Item myItem
GestureListener listener
myItem:AddGestureListener(listener)
myItem:RemoveGestureListener(listener)
RemoveLayoutProperties(Libraries.Interface.Layouts.LayoutProperties properties)
Returns true if rendering the mouse over event.
Parameters
RemoveMouseListener(Libraries.Interface.Events.MouseListener listener)
This action removes a MouseListener from the Item. The listener will no longer receive notification if the Item gets a mouse click event.
Parameters
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.MouseListener
Item myItem
MouseListener listener
myItem:AddMouseListener(listener)
myItem:RemoveMouseListener(listener)
RemoveMouseMovementListener(Libraries.Interface.Events.MouseMovementListener listener)
This action removes a MouseMovementListener from the Item. The listener will no longer receive notification if the Item gets a mouse movement event.
Parameters
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.MouseMovementListener
Item myItem
MouseMovementListener listener
myItem:AddMouseMovementListener(listener)
myItem:RemoveMouseMovementListener(listener)
RemoveMouseWheelListener(Libraries.Interface.Events.MouseWheelListener listener)
This action removes a MouseWheelListener from the Item. The listener will no longer receive notification if the Item gets a mouse wheel event.
Parameters
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.MouseWheelListener
Item myItem
MouseWheelListener listener
myItem:AddMouseWheelListener(listener)
myItem:RemoveMouseWheelListener(listener)
RemoveSelectionListener(Libraries.Interface.Events.SelectionListener listener)
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.
RemoveTouchListener(Libraries.Interface.Events.TouchListener listener)
This action removes a TouchListener from the Item. The listener will no longer receive notification if the Item gets a TouchEvent.
Parameters
Example
use Libraries.Interface.Item
use Libraries.Interface.Events.TouchListener
Item myItem
TouchListener listener
myItem:AddTouchListener(listener)
myItem:RemoveTouchListener(listener)
RequestLayout()
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.
RequestReloadGraphics()
This action requests that this Control (as well as all of its descendents) should reload their graphics during the next Update.
RequestVerticesUpdate()
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.
RequireSimulation(boolean flag)
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
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetLinearVelocityY(100)
ResetLayoutFlag()
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.
ResetMass()
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.
Resize()
This action is called whenever the window is resized.
Rotate(number degrees)
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
Example
use Libraries.Interface.Item
Item myItem
myItem:Rotate(65)
RotateXLabels(integer degrees)
This action is used to rotate the X-axis labels by a number of degrees.
Parameters
- integer degrees: between 0 and 360.
Save(text path)
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.
Save(Libraries.System.File file)
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.
Scale(number xAmount, number yAmount)
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
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScale(1.5)
myItem:Scale(1.1, 0.9)
Scale(number amount)
This action will multiply the current scaling value by the given number. A parameter of 0 or less will be ignored.
Parameters
- number amount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScale(1.5)
myItem:Scale(1.1)
ScaleFromCenter(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
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScale(1.5)
myItem:ScaleFromCenter(1.1)
ScaleFromCenter(number xAmount, number yAmount)
This action will multiply the current scaling values of the x and y planes 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 xAmount
- number yAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScale(1.5)
myItem:ScaleFromCenter(1.1, 0.9)
Select(Libraries.Interface.Controls.Charts.ChartItem item)
This action sets the ChartItem that is currently selected. This call has the same effect as calling GetSelection, then Set(ChartItem) on the selection.
Parameters
- Libraries.Interface.Controls.Charts.ChartItem: the current item to be selected
SelectByFirstLetters(text firstLetter)
This action selects an item in the Control using first letter navigation, if the Control supports it. If the Control doesn't support first letter navigation, this will do nothing.
Parameters
- text firstLetter
SelectionDown()
This action moves the selection down within the chart.
SelectionEnter()
This action moves the selection to enter the current grouping or panel.
SelectionEscape()
This action moves the selection to the "escape" item, typically moving upwards to the containing group or panel.
SelectionLeft()
This action moves the selection to the left within the chart.
SelectionNextFocus()
This action moves the selection to the "next" focus item, typically moving upwards to the containing group or panel.
SelectionPreviousFocus()
This action moves the selection to the "previous" focus item, typically moving upwards to the containing group or panel.
SelectionRight()
This action moves the selection to the right within the chart.
SelectionUp()
This action moves the selection up within the chart.
SeparateByFactor()
SeparateByFactor will attempt to create faceted sub chart area panels. Each factor/group (independent variable) will get it's own panel. Each sub area will contain all elements associated with that factor and requests a single column.
SeparateByFactor(boolean flag)
SeparateByFactor will attempt to create faceted sub chart area panels. Each factor/group (independent variable) will get it's own panel. Each sub area will contain all elements associated with that factor.
Parameters
- boolean flag
SeparateByFactor(integer requestedColumns)
SeparateByFactor will attempt to create faceted sub chart area panels. Each factor/group (independent variable) will get it's own panel. Each sub area will contain all elements associated with that factor and requests some number of columns.
Parameters
- integer requestedColumns: the number of requested columns to arrange each chart.
SeparateBySeries()
SeparateBySeries will attempt to create faceted sub-chart area panels. Each series entry in the legend will get its own chart area. Each sub-area will contain all elements associated with that series. This creates a single column of sub-chart area panels.
SeparateBySeries(integer requestedColumns)
SeparateBySeries will attempt to create faceted sub-chart area panels. Each series entry in the legend will get its own chart area. Each sub-area will contain all elements associated with that series. This creates a specified number of columns of sub-chart area panels.
Parameters
- integer requestedColumns: the number of columns requested to display the sub-charts.
SeparateBySeries(boolean flag)
SeparateBySeries will attempt to create faceted sub-chart area panels. Each series entry in the legend will get its own chart area. Each sub-area will contain all elements associated with that series.
Parameters
- boolean flag
SetAccentColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the accent color on the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the accent control.
SetAcceptsMouseInput(boolean accepts)
This action sets whether or not this Item accepts mouse input. If set to 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.
Parameters
- boolean accepts: True to set this Item to receive mouse events, or false to ignore them.
SetAccessibilityCode(integer newAccessibilityCode)
This action changes the accessibility code for this Item. This should be done with care because setting the accessiblity code to the incorrect type can cause accessibility to stop functioning or, in some cases, cause the program to crash.
Parameters
- integer newAccessibilityCode: the new accessibility code for this Item.
SetAccessibilityFlag(boolean hasAccessibility)
This action sets a flag to know if all of the accessibility information should be included. This may be used to reduce the size of the image in cases where it will be used as a flat image such as in a PDF.
Parameters
- boolean hasAccessibility: flag to tell the ChartWriter if it should include accessibility elements and tags.
SetAccessibilityRoleDescription(text newRoleDescription)
This action sets a custom accessibility role description for this item. This should only be done if there is not a standard accessibility code for the type of item being implemented. If the item behaves very similarly to a standard control type, then set the accessibility code to that standard type while also setting the role description. For example, if implementing an item that extends Control, is keyboard focusable, and responds to activation via both mouse clicks and the Space key, like a button, but it shouldn't be described as a button, then set the accessibility code to BUTTON and the custom role description to whatever is appropriate. If there isn't a suitable accessibility code, or if in doubt, set the accessibility code to CUSTOM.
Parameters
- text newRoleDescription: the new custom role description for this Item.
SetAngularDamping(number angularDamping)
This action gets the rotational inertia of this item. The inertia is in kilogram units squared.
Parameters
- number angularDamping
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inertia = item:GetInertia()
SetAngularVelocity(number angularVelocity)
This action sets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.
Parameters
- number angularVelocity: The angular velocity of this item in radians per second
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetAngularVelocity(0.1)
SetAnnotationFontSize(integer size)
This action sets the annotation font size on the points.
Parameters
- integer size: the font size of point annotations.
SetBackground(Libraries.Game.Graphics.Drawable background)
This action sets the Drawable in the background of the chart.
Parameters
- Libraries.Game.Graphics.Drawable: the chart background.
SetBackgroundColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the background color in the Control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the background color.
SetBorderColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the border color of the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the border color.
SetBorderStyle(integer style)
This action sets the border style either, LayoutProperties.TOP, LayoutProperties.BOTTOM, LayoutProperties.LEFT, LayoutProperties.RIGHT, and LayoutProperties.ALL.
Parameters
- integer style
SetBorderThickness(number value)
This action sets the border thickness on the control.
Parameters
- number value: the border thickness.
SetBottomLeftPixelRounding(number value)
This action sets the bottom left pixel rounding value.
Parameters
- number value: the bottom left pixel rounding value.
SetBottomLeftRounding(number value)
This action sets the bottom left rounding value.
Parameters
- number value: the bottom left rounding value.
SetBottomMargin(number padding)
This action sets the bottom margin size. The bottom margin is the space outside of the bottom border.
Parameters
- number padding: the amount of bottom margin.
SetBottomPadding(number padding)
This action sets the bottom padding size. The bottom padding is the space inside of the bottom border.
Parameters
- number padding: the amount of bottom margin.
SetBottomRightPixelRounding(number value)
This action sets the bottom right pixel rounding value.
Parameters
- number value: the bottom right pixel rounding value.
SetBottomRightRounding(number value)
This action sets the bottom right rounding value.
Parameters
- number value: the bottom right rounding value.
SetBoundingBox(number newX, number newY, number newWidth, number newHeight)
This action will set the x coordinate, y coordinate, width, and height of the Item2D, respectively.
Parameters
- number newX
- number newY
- number newWidth
- number newHeight
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetBoundingBox(50, 200, 100, 75)
SetCenter(number setX, number setY)
This action will set the X and Y coordinates of the Item so that the center of the Item is located at the given X, Y coordinates.
Parameters
- number setX
- number setY
Example
use Libraries.Interface.Item
Item myItem
myItem:SetCenter(70, 40)
SetCenterX(number setX)
This action will set the X coordinate of the Item so that the center of the Item is aligned with the given X coordinate value.
Parameters
- number setX
Example
use Libraries.Interface.Item
Item myItem
myItem:SetCenterX(70)
SetCenterY(number setY)
This action will set the Y coordinate of the Item so that the center of the Item is aligned with the given Y coordinate value.
Parameters
- number setY
Example
use Libraries.Interface.Item
Item myItem
myItem:SetCenterY(65)
SetChildrenProcessingMouseEvents(boolean shouldProcess)
The SetChildrenProcessingMouseEvents action is used to set whether or not children items should receive mouse events if this Item is using custom drawing. This affects only custom drawing Items -- if the Item isn't drawing, children objects will always receive the mouse events first. This value is false by default. This is an advanced feature only necessary for complex custom components, and most users will not need to use this.
Parameters
- boolean shouldProcess
SetClipCoordinates(Libraries.Game.Graphics.Painter2D painter)
This action sets the clipping coordinates of the given painter to respect the coordinates of this Item (if it's clipping) as well as any clipping being performed by parent Items. This action is called automatically by the Game engine as necessary, and most users will never need to use this action directly.
Parameters
SetClipping(boolean clip)
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.
Parameters
- boolean clip: True to enable pixel clipping, false to disable.
SetCollidable(boolean flag)
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.
Parameters
- boolean flag: Whether or not to turn collision on for this item
Example
use Libraries.Game.Graphics.Drawable
Drawable circle
circle:LoadFilledCircle(30)
circle:SetCollidable(true)
SetCollideWithChildren(boolean flag)
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
Parameters
- boolean flag
SetCollisionGroupFlag(boolean flag)
This action sets the total torque on this item. The units are kilogram units squared per second per second. This action should be used to set the total torque on this item. If we want to apply a torque to this item, we should use the ApplyTorque actions instead. Physics must be enabled on this action before using this action.
Parameters
- boolean flag
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetTorque(200)
SetCollisionGroupIndex(integer index)
This action sets the total force on this item. The units are kilogram units per second per second. This action should be used to set the total force on this item. If we want to apply a force to this item, we should use the ApplyForce actions instead. Physics must be enabled on this item before using this action.
Parameters
- integer index
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 force
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
item:SetForce(force)
SetCollisionList(Libraries.Game.Collision.CollisionEdge2D edge)
This is an action used internally by the physics system to keep track of the collisions with this item in a linked list structure. This action sets the head of the linked list of collisions to the passed CollisionEdge2D object. This action is used internally and users should not need to use this action.
Parameters
- Libraries.Game.Collision.CollisionEdge2D: The new head of the linked list of collisions
SetColorPalette(Libraries.Game.Graphics.Color colorA, Libraries.Game.Graphics.Color colorB, Libraries.Game.Graphics.Color colorC)
This action sets a custom color palette with three colors.
Parameters
- Libraries.Game.Graphics.Color: a color.
- Libraries.Game.Graphics.Color: a color.
- Libraries.Game.Graphics.Color: a color.
SetColorPalette(Libraries.Game.Graphics.Color color)
This action sets a custom color palette with one color.
Parameters
- Libraries.Game.Graphics.Color: a colors.
SetColorPalette(Libraries.Game.Graphics.Color colorA, Libraries.Game.Graphics.Color colorB)
This action sets a custom color palette with two colors.
Parameters
- Libraries.Game.Graphics.Color: a color.
- Libraries.Game.Graphics.Color: a color.
SetColorPalette(Libraries.Containers.Array<Libraries.Game.Graphics.Color> palette)
SetColorPaletteToCalm()
This action sets the color palette to a collection of calm colors.
SetColorPaletteToColorgorical()
This action sets the color palette to a collection of colorgorical colors.
SetColorPaletteToCoolScale()
This action sets the color palette to a collection of cool scaled colors. Created by Stefan van der Walt (https://github.com/stefanv) and Nathaniel Smith (https://github.com/njsmith) https://cran.r-project.org/web/packages/viridis/vignettes/intro-to-viridis.html
SetColorPaletteToDisturbing()
This action sets the color palette to a collection of disturbing colors.
SetColorPaletteToExciting()
This action sets the color palette to a collection of exciting colors.
SetColorPaletteToMagma()
This action sets the color palette to a collection of magma colors.
SetColorPaletteToNegative()
This action sets color palette to a collection of negative colors.
SetColorPaletteToPlayful()
This action sets the color palette to a collection of playful colors.
SetColorPaletteToPositive()
This action sets the color palette to a collection of positive colors.
SetColorPaletteToSerious()
This action sets the color palette to a collection of serious colors.
SetColorPaletteToTrustworthy()
This action sets the color palette to a collection of trustworthy colors.
SetColorPaletteToWarmScale()
This action sets the color palette to a collection of warm scaled colors.
SetColorProperty(text property, Libraries.Game.Graphics.ColorGroup value)
This action sets the color and property in the Control.
Parameters
- text property
- Libraries.Game.Graphics.ColorGroup: the color.
SetContainer(Libraries.Interface.Controls.Charts.Chart container)
This action sets the current chart object.
Parameters
- Libraries.Interface.Controls.Charts.Chart: the chart object.
SetContainerGridHeight(integer containerGridHeight)
This action sets 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. If this value is 0 or less, then the GridLayout will use its default grid height and ignore this value.
Parameters
- integer containerGridHeight
SetContainerGridWidth(integer containerGridWidth)
This action sets 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. If this value is 0 or less, then the GridLayout will use its default grid width and ignore this value.
Parameters
- integer containerGridWidth
SetCornerPixelRounding(number bottomLeft, number bottomRight, number topLeft, number topRight)
This action sets how much rounding to apply to the four corners of a rectangular control. This action takes the amount of rounding to apply as a number of pixels.
Parameters
- number bottomLeft: The rounding value to be applied to the bottom left corner, in pixels.
- number bottomRight: The rounding value to be applied to the bottom right corner, in pixels.
- number topLeft: The rounding value to be applied to the top left corner, in pixels.
- number topRight: The rounding value to be applied to the top right corner, in pixels.
SetCornerRounding(number bottomLeft, number bottomRight, number topLeft, number topRight)
This action sets how much rounding to apply to the four corners of a rectangular control. The expected values are between 0 and 1, where 0 indicates no rounding, and 1 indicates full rounding. (If all four corners are set to have full rounding, the result will appear to be a circle.)
Parameters
- number bottomLeft: The rounding value to be applied to the bottom left corner (between 0 and 1).
- number bottomRight: The rounding value to be applied to the bottom right corner (between 0 and 1).
- number topLeft: The rounding value to be applied to the top left corner (between 0 and 1).
- number topRight: The rounding value to be applied to the top right corner (between 0 and 1).
SetCurrentPaletteToGrayScale()
This action sets the color palette to a collection of grey colors.
SetCustomDrawing(boolean isCustom)
The SetCustomDrawing action is used to indicate that this Item wants to directly manage how itself and its children are drawn. When this is set to true, the Item must be responsible for determining this 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.
Parameters
- boolean isCustom: True if this Item should use custom drawing, or false to use default drawing rules.
SetDensity(number density)
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 density
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:ApplyAngularImpulse(80)
SetDescription(text newDescription)
This action sets the internal description of the Item.
Parameters
- text newDescription
Example
use Libraries.Interface.Item
Item item
item:SetDescription("Used for demo purposes.")
SetDisplayName(text info)
This action sets the display name of the chart item.
Parameters
- text info
SetDownItem(Libraries.Interface.Controls.Charts.ChartItem downItem)
Sets the Item accessed "below" (via the DOWN arrow) this Item in the chart selection.
Parameters
SetEnterInstruction(text enterInstruction)
This action sets the instruction text for an enter description.
Parameters
- text enterInstruction: The description for enter.
SetEnterItem(Libraries.Interface.Controls.Charts.ChartItem enterItem)
Sets the Item accessed within (default: ENTER key) this Item in the chart selection.
Parameters
SetEscapeItem(Libraries.Interface.Controls.Charts.ChartItem escapeItem)
Sets the escape Item accessed from this Item in the chart selection (by default using the ESCAPE key).
Parameters
SetEscapeToLastItem(boolean escape)
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.
Parameters
- boolean escape
SetExitInstruction(text exitInstruction)
This action sets the instruction text for an exit description.
Parameters
- text exitInstruction: The description for exit.
SetFactorList(Libraries.Containers.Array<text> factorList)
This action sets the list of factor or group names.
Parameters
- Libraries.Containers.Array: an array of factor/group names in the chart.
SetFlipX(boolean flip)
This action will set the Item2D to be flipped across the X-axis according to the boolean. If the boolean value is false, the Item2D will be set to its unflipped state. If it is true, the Item will be set to its flipped state.
Parameters
- boolean flip
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetFlipX(true)
SetFlipY(boolean flip)
This action will set the Item2D to be flipped across the Y-axis according to the boolean. If the boolean value is false, the Item2D will be set to its unflipped state. If it is true, the Item will be set to its flipped state.
Parameters
- boolean flip
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetFlipY(true)
SetFocusBorderColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the focus border color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the focus border color.
SetFocusColor(Libraries.Game.Graphics.ColorGroup value)
SetFocusFontColor(Libraries.Game.Graphics.ColorGroup value)
This action sets focus font color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the focus font color.
SetFocusable(boolean focus)
The SetFocusable action sets whether or not this Item should be focusable. If the Item is currently focused and made unfocusable, then it will lose focus, and there will be no focused element.
Parameters
- boolean focus
SetFont(Libraries.Game.Graphics.Font font)
This action sets the Font to be 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.
Parameters
- Libraries.Game.Graphics.Font: The Font to use for this Control.
SetFontColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the font color of the font contained in the Control.
Parameters
SetFontOutlineColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the font outline color value.
Parameters
- Libraries.Game.Graphics.ColorGroup: the font outline color value.
SetFontOutlineThickness(number value)
This action sets the font outline thickness value.
Parameters
- number value: the font outline thickness value.
SetFontSize(integer size)
This action sets the overall font size.
Parameters
- integer size: of the overall font.
SetForce(Libraries.Compute.Vector2 force)
This action sets the total force on this item. The units are kilogram units per second per second. This action should be used to set the total force on this item. If we want to apply a force to this item, we should use the ApplyForce actions instead. Physics must be enabled on this item before using this action.
Parameters
- Libraries.Compute.Vector2: The total force in kilogram units per second per second
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 force
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
item:SetForce(force)
SetForegroundColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the foreground color in the Control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the foreground color.
SetForegroundSelectionColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the foreground selection color in the Control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the foreground selection color.
SetFriction(number friction)
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 friction
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:ApplyTorque(350)
SetGeneralInstruction(text generalInstruction)
This action sets the instruction text for a general description.
Parameters
- text generalInstruction
SetGlowColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the glow color on the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the glow color.
SetGridHeight(integer gridHeight)
The SetGridHeight action sets 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.
Parameters
- integer gridHeight
SetGridPosition(integer gridX, integer gridY)
This action sets this Control's cell coordinates within a GridLayout. This indicates which column and row this Control is located within. If the Control's parent container isn't using a GridLayout, these values are ignored.
Parameters
- integer gridX
- integer gridY
SetGridSize(integer gridWidth, integer gridHeight)
The SetGridSize action sets how many cells wide and tall this Control is within a grid. By default, each of these values are 1. These values are only used for GridLayouts, and are ignored by other layouts.
Parameters
- integer gridWidth
- integer gridHeight
SetGridWidth(integer gridWidth)
The SetGridWidth action sets 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.
Parameters
- integer gridWidth
SetGridX(integer gridX)
This action sets 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.
Parameters
- integer gridX
SetGridY(integer gridY)
This action sets 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.
Parameters
- integer gridY
SetHasMoved(boolean flag)
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.
Parameters
- boolean flag
SetHeight(number newHeight)
This action will set the height of the Item2D.
Parameters
- number newHeight
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetHeight(70)
SetHighlightColor(Libraries.Game.Graphics.Color color)
Sets the default selection color (highlighting) the chart items
Parameters
SetHorizontalLayoutMode(integer mode)
The SetHorizontalLayoutMode 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.
Parameters
- integer mode: A layout mode constant, one of STANDARD, FILL, or FILL_CONTENTS.
SetIcon(Libraries.Game.Graphics.TextureRegion icon)
This action sets the Icon used by this Control. Different Controls use this Icon differently, depending on their purpose.
Parameters
- Libraries.Game.Graphics.TextureRegion: The Icon to use for this Control.
SetIconColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the Icon color on the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the icon color.
SetInputGroup(text group)
This action sets 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.
Parameters
- text group: The new input group to use.
Example
use Libraries.Interface.Item
Item item
item:SetInputGroup("arrowKeys")
output "My item's input group is : " + item:GetInputGroup()
SetInterfaceOptionsKey(text key)
This action returns the base Font size to be used by this Control, if the Control uses a Font.
Parameters
- text key
SetInterfaceScale(number scale)
This action sets the interface scale for the control.
Parameters
- number scale: a number between 0 and 1 that scales the control.
SetItem(integer index, Libraries.Interface.Item2D newItem)
This action sets a value inside the internal item array of this Item2D.
Parameters
- integer index
- Libraries.Interface.Item2D
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child1
Item2D child2
parentItem:Add(child1)
parentItem:SetItem(0, child2)
SetJointList(Libraries.Game.Physics.Joints.JointEdge2D edge)
This is an action used internally by the physics system to keep track of the joints connected to this item in a linked list structure. This action sets the head of the linked list of collisions to the passed CollisionEdge2D object. This action is used internally and users should not need to use this action.
Parameters
SetLabelText(text labelText)
This action sets the text in this Control's label, if it has one.
Parameters
- text labelText: The text to use for this Control's label.
SetLayer(Libraries.Game.Layer2D parentLayer)
This action is used by the Game libraries to create a reference to the layer that this Item2D exists on. It is automatically called as needed by the Layer2Dclass. Most users will never need to use this action directly.
Parameters
SetLayout(Libraries.Interface.Layouts.Layout layout)
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
Example
use Libraries.Interface.Item2D
Item2D parentItem
Item2D child
parentItem:Add(child)
SetLayoutRows(number layoutRows)
This action sets 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).
Parameters
- number layoutRows
SetLeftItem(Libraries.Interface.Controls.Charts.ChartItem leftItem)
Sets the Item accessed to the left of this Item in the chart selection.
Parameters
SetLeftMargin(number padding)
This action sets the left margin size. The left margin is the space outside of the left border.
Parameters
- number padding: the amount of left margin.
SetLeftPadding(number padding)
This action sets the left padding size. The left padding is the space inside of the left border.
Parameters
- number padding: the amount of left margin.
SetLegend(Libraries.Interface.Controls.Charts.Legend legend)
This action sets the Legend object
Parameters
- Libraries.Interface.Controls.Charts.Legend: the legend to set
SetLegendIconBorderThickness(number thickness)
This action sets 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.
Parameters
- number thickness
Example
use Libraries.Compute.Statistics.DataFrame
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Interface.Controls.Charts.Chart
DataFrame frame
frame:Load("ChartTestData.csv")
frame:AddSelectedColumns("Column1")
frame:AddSelectedColumns("Column2")
frame:AddSelectedColumns("Column3")
frame:AddSelectedFactors("Factor1")
BarChart chart = frame:BarChart()
chart:SetTitle("BarChart Test")
chart:SetSubtitle("Three Columns - One Factor")
chart:SetLegendIconBorderThickness(3)
chart:ShowAnnotations(true)
chart:Display()
SetLegendLabelFontSize(integer size)
This action sets the legend label font size.
Parameters
- integer size: of the legend label font.
SetLegendLocationToBottom()
Sets the legend to show beneath the chart area.
SetLegendLocationToLeft()
Sets the legend to show left of the chart area.
SetLegendLocationToRight()
Sets the legend to show right of the chart area.
SetLegendLocationToTop()
Sets the legend to show on top of the chart area.
SetLegendTitle(text name)
Set the title for the legend of the Chart
Parameters
- text name: the title of the legend.
SetLegendTitleFontSize(integer size)
This action sets the legend title font size.
Parameters
- integer size: of the legend title font.
SetLineDensity(integer density)
Set and get the line density.
Parameters
- integer density
SetLinearDamping(number linearDamping)
Given a point relative to the center of this item, this action computes and returns that point in screen coordinates.
Parameters
- number linearDamping
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 localPoint
item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 250)
localPoint:Set(0, 0) // Get the coordinates of the center of the item
Vector2 worldPoint = item:GetWorldPoint(localPoint)
SetLinearVelocity(Libraries.Compute.Vector2 linearVelocity)
This action sets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.
Parameters
- Libraries.Compute.Vector2: The vector representing the linear velocity of this item in units per second
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 velocity
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
velocity:Set(100, 0)
item:SetLinearVelocity(velocity)
SetLinearVelocityX(number linearVelocityX)
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.
Parameters
- number linearVelocityX: The x-component of this item's linear velocity in units per second
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetLinearVelocityX(100)
SetLinearVelocityY(number linearVelocityY)
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
- number linearVelocityY: The y-component of this item's linear velocity in units per second
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetLinearVelocityY(100)
SetListOrderInstruction(text listOrderInstruction)
This action sets the instruction text for a list order description.
Parameters
- text listOrderInstruction: The description for list order.
SetMass(number mass)
This action is used to syncronize the item's position in physics space with its position in the tree used for broadphase collision. This action is used internally and users should not need to use this action.
Parameters
- number mass
SetMass(Libraries.Game.Physics.Mass2D mass)
This action sets 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.
Parameters
SetMaximumSubdivisons(integer subdivisions)
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
- integer subdivisions
SetMinorXGridlineCount(integer count)
This action sets the number of minor X-axis gridlines. Note, that major gridlines are drawn to match the number and location of axis ticks. Minor gridlines default to 5 intervals between major gridlines. The minor gridline interval count can be manually changed. No option to customize density or color at this time.
Parameters
- integer count: amount of minor gridlines on the X-axis.
SetMinorYGridlineCount(integer count)
This action sets the number of minor Y-axis gridlines. Note, that major gridlines are drawn to match the number and location of axis ticks. Minor gridlines default to 5 intervals between major gridlines. The minor gridline interval count can be manually changed. No option to customize density or color at this time.
Parameters
- integer count: amount of minor gridlines on the Y-axis.
SetMouseDownColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the mouse down color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the mouse down color.
SetMouseDownFontColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the mouse down font color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the mouse down font color.
SetMouseDownGlowColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the mouse down glow color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the mouse down glow color.
SetMouseOverColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the mouse over color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the mouse over color.
SetMouseOverFontColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the mouse over font color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the mouse over font color value.
SetMouseOverGlowColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the mouse over glow color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the mouse over glow color.
SetName(text newName)
This action sets the internal name of the Item.
Parameters
- text newName
Example
use Libraries.Interface.Item
Item item
item:SetName("My Item")
SetNeedsUpdate(boolean update)
This action tells the system to update all of its graphics because its structure has changed. This might be true if the charts are being used to update a live data source.
Parameters
- boolean update: whether or not an update is required
SetNextFocus(Libraries.Interface.Item next)
This action sets 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 focus will move to the next focus item, if it is defined.
Parameters
- Libraries.Interface.Item: The next Item to receive focus after this one.
SetNonResponsive()
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.
SetNumberProperty(text property, number value)
This action sets a generic property with a specified name and number value.
Parameters
- text property: the property name.
- number value: the number value for the generic property.
SetOffset(number xAmount, number yAmount)
This action will set both the X and Y offsets of the item, respectively.
Parameters
- number xAmount
- number yAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffset(100, 75)
SetOffset(number xAmount, number yAmount, number zAmount)
This action will set X, Y, and Z offsets of the item, respectively.
Parameters
- number xAmount
- number yAmount
- number zAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffset(100, 75, 2)
SetOffsetX(number xAmount)
This action sets 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.
Parameters
- number xAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetX(100)
SetOffsetY(number yAmount)
This action sets 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.
Parameters
- number yAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetY(75)
SetOffsetZ(number zAmount)
This action sets 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.
Parameters
- number zAmount
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetZ(75)
SetOrientationToHorizontal()
SetOrientationToHorizontal sets the orientation to horizontal.
SetOrientationToVertical()
SetOrientationToVertical sets the orientation to vertical.
SetOrigin(number setX, number setY)
This action will set the origin of the Item to be at the given location in the Item. This is used when projecting the Item's vertices onto the screen, i.e. when determining where to draw a picture on the screen.
Parameters
- number setX
- number setY
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOrigin(20, 20)
SetOriginCenter()
This action will set the origin of the Item to be at the current center of the Item's width and height bounds.
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(50, 80)
myItem:SetOriginCenter()
SetParent(Libraries.Interface.Item2D newItem)
This action sets a reference to the parent item. It is called automatically when an Item2D is added as a child to another Item2D. Most users will not need to use this action directly.
Parameters
SetPassThroughSelection(boolean passThroughSelection)
If pass through selection is enabled, attempting to enter or escape into this item will instead try to pass the selection through to the following enter/escape item.
Parameters
- boolean passThroughSelection
SetPercentageHeight(number height)
This action sets the height of the Control relative to the size of its container, if the container's Layout supports it.
Parameters
- number height: The target height as a percentage (as a value between 0.0 and 1.0) of the container's height.
SetPercentageOriginX(number x)
This action sets 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.
Parameters
- number x
SetPercentageOriginY(number y)
This action sets 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.
Parameters
- number y
SetPercentageWidth(number width)
This action sets the width of the Control relative to the size of its container, if the container's Layout supports it.
Parameters
- number width: The target width as a percentage (as a value between 0.0 and 1.0) of the container's width.
SetPercentageX(number x)
This action sets the x position of the Control relative to the size of its container, if the container's Layout supports it.
Parameters
- number x: The target x position as a percentage (as a value between 0.0 and 1.0) of the container's width.
SetPercentageY(number y)
This action sets the y position of the Control relative to the size of its container, if the container's Layout supports it.
Parameters
- number y: The target y position as a percentage (as a value between 0.0 and 1.0) of the container's width.
SetPhysicsProperties(Libraries.Game.Physics.PhysicsProperties2D properties)
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
SetPixelHeight(number height)
This action sets the height of the Control in pixels, if the container's Layout supports it. If the Control has also been set to use a percentage of the container's height to set the height, then the two values will be added together.
Parameters
- number height: The target height of this Control in pixels.
SetPixelWidth(number width)
This action sets the width of the Control in pixels, if the container's Layout supports it. If the Control has also been set to use a percentage of the container's width to set the width, then the two values will be added together.
Parameters
- number width
SetPixelX(number x)
This action sets the x position of the Control in pixels, if the container's Layout supports it. If the Control has also been set to use a percentage of the container's width to set the x position, then the two values will be added together.
Parameters
- number x: The target x position of this Control in pixels.
SetPixelY(number y)
This action sets the y position of the Control in pixels, if the container's Layout supports it. If the Control has also been set to use a percentage of the container's height to set the y position, then the two values will be added together.
Parameters
- number y: The target y position of this Control in pixels.
SetPointBorderThickness(number pointBorderThickness)
This action sets 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.
Parameters
- number pointBorderThickness
SetPointDensity(integer radius)
Set the point radius.
Parameters
- integer radius
SetPopupMenu(Libraries.Interface.Controls.PopupMenu menu)
The SetPopupMenu action attaches a PopupMenu to this Control, which can be opened by interacting with it (most commonly by right-clicking on the Control).
Parameters
SetPosition(number setX, number setY)
This action will set both the X coordinate and the Y coordinate of the Item, in that order.
Parameters
- number setX
- number setY
Example
use Libraries.Interface.Item
Item myItem
myItem:SetPosition(30, 70)
SetPosition(number setX, number setY, number setZ)
This action will set both the X and Y coordinates of this Item2D, and will additionally set the Z value of this Item2D.
Parameters
- number setX
- number setY
- number setZ
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetPosition(30, 70, 3)
SetPreviousFocus(Libraries.Interface.Item previous)
This action sets 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 focus will move to the previous focus item, if it is defined.
Parameters
- Libraries.Interface.Item: The previous Item to receive focus before this one.
SetProperty(text key, Libraries.Data.Formats.JavaScriptObjectNotation value)
Parameters
SetQuadrantThreshold(integer threshold)
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
- integer threshold
SetRegressionLineColor(Libraries.Game.Graphics.Color color)
SetRegressionLineDensity(integer density)
This action sets the regression line density.
Parameters
- integer density: the line density represented by an integer value.
SetResponsive()
This action determines whether this item is collidable.
Example
use Libraries.Game.Graphics.Drawable
Drawable circle
circle:LoadFilledCircle(30)
circle:SetCollidable(true)
boolean result = circle:IsCollidable
SetResponsiveness(integer type)
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.
Parameters
- integer type
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number mass = item:GetMass()
SetRestitution(number restitution)
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
- number restitution
Example
use Libraries.Compute.Vector2
use Libraries.Interface.Item2D
Item2D item
Vector2 force
Vector2 point
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
point:Set(100, 100) // apply the force to the top right corner of the item
item:ApplyForce(force, point)
SetRightItem(Libraries.Interface.Controls.Charts.ChartItem rightItem)
Sets the Item accessed to the right of this Item in the chart selection.
Parameters
SetRightMargin(number padding)
This action sets the right margin size. The right margin is the space outside of the right border.
Parameters
- number padding: the amount of right margin.
SetRightPadding(number padding)
This action sets the right padding size. The right padding is the space inside of the right border.
Parameters
- number padding: the amount of right margin.
SetRotation(number degrees)
Sets this Item2D to be rotated to an angle of the given number of degrees. This will also rotate all Items in the children hierarchy of this Item.
Parameters
- number degrees
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetRotation(90)
SetRotationOverride(boolean flag)
This action is used to set when the x-axis label rotation has been overridden.
Parameters
- boolean flag: true if the x-axis labels are rotated.
SetScale(number scale)
This action sets the scale of this Item2D, causing the vertices of the item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height.
Parameters
- number scale
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScale(1.25)
SetScale(number newX, number newY)
This action sets separate scaling values for the x and y planes on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height.
Parameters
- number newX
- number newY
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScale(1.5, 0.75)
SetScaleFromCenter(number newX, number newY)
This action sets separate scaling values for the x and y planes on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height. 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 newX
- number newY
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScaleFromCenter(1.5, 0.75)
SetScaleFromCenter(number scale)
This action sets the scale of this Item2D, causing the vertices of the item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height. 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 scale
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScaleFromCenter(1.25)
SetScaleX(number scaleX)
This action sets the scaling value of the x plane on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width. The default scaling values are 1.0, or 100% of the Item's width and height.
Parameters
- number scaleX
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScaleX(1.5)
SetScaleY(number scaleY)
This action sets the scaling value of the y plane on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the height. The default scaling values are 1.0, or 100% of the Item's width and height.
Parameters
- number scaleY
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 200)
myItem:SetScaleY(0.75)
SetScreenPositionFromPhysicsPosition()
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.
Example
use Libraries.Game.Drawable
use Libraries.Game.Collision.Shapes.Circle
Drawable ball
ball:Load("ball.png")
Circle circle
circle:SetRadius(30)
ball:SetShape(circle)
CollisionShape2D shape = ball:GetShape()
SetScriptFilepath(text scriptFilepath)
This action sets the file path for a script.
Parameters
- text scriptFilepath: the file path.
SetSelectionBorderColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the selection border color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the selection border color.
SetSelectionColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the selection color on the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the selection color.
SetSelectionFontColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the selection font color on the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the selection font color.
SetSeriesList(Libraries.Containers.Array<Libraries.Interface.Controls.Charts.Series> series)
SetShadowColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the shaddow color on the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the shaddow color.
SetShadowEdgeFade(number value)
This action sets the shadow edge fade percent. A value between 0 and 1.
Parameters
- number value: the shadow edge fade percent.
SetShadowHeight(number value)
This action sets the shadow height percent. A value between 0 and 1.
Parameters
- number value: the shadow height.
SetShadowWidth(number value)
This action sets the shadow width percent. A value between 0 and 1.
Parameters
- number value: the shadow width.
SetShadowX(number value)
This action sets the shadow X value.
Parameters
- number value: the shadow X value.
SetShadowY(number value)
This action sets the shadow Y value.
Parameters
- number value: the shadow Y value.
SetShape(Libraries.Game.Collision.Shapes.CollisionShape2D shape)
This action sets 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. A copy of the passed shape is used for the collison shape for this item.
Parameters
- Libraries.Game.Collision.Shapes.CollisionShape2D: The collision shape to use for this item
Example
use Libraries.Game.Drawable
use Libraries.Game.Collision.Shapes.Circle
Drawable ball
ball:Load("ball.png")
Circle circle
circle:SetRadius(30)
ball:SetShape(circle)
SetSize(number newWidth, number newHeight)
This action will set the width and height of the Item2D, respectively.
Parameters
- number newWidth
- number newHeight
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetSize(100, 50)
SetSleepTime(number time)
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
- number time
Example
use Libraries.Game.Graphics.Drawable
Drawable circle
circle:LoadFilledCircle(30)
circle:EnablePhysics(true)
SetStyleFilepath(text styleFilepath)
This action sets the file path for a style.
Parameters
- text styleFilepath: the file path.
SetSubtitle(text name)
This action sets the subtitle of the chart.
Parameters
- text name
SetSubtitleFontSize(integer size)
This action sets the subtitle font size.
Parameters
- integer size: of the subtitle font.
SetTitle(text name)
This action sets the title of the chart.
Parameters
- text name
SetTitleFontSize(integer size)
This action sets the title font size.
Parameters
- integer size: of the title font.
SetToDefaultFontSize()
This action sets the font size to the system's specified default size for Forms. By default, this is font size 20, the same as the medium font size.
Example
use Libraries.Interface.Forms.Form
use Libraries.Interface.Forms.Page
use Libraries.Interface.Controls.Button
Form form
Page page = form:GetMainPage()
Button button = page:AddButton("Click for Bacon")
button:SetToDefaultFontSize()
form:Display()
SetToHugeFont()
This action sets the font size to the system's specified "huge" size for Forms. By default, this is font size 60.
Example
use Libraries.Interface.Forms.Form
use Libraries.Interface.Forms.Page
use Libraries.Interface.Controls.Button
Form form
Page page = form:GetMainPage()
Button button = page:AddButton("Click for Bacon")
button:SetToHugeFont()
form:Display()
SetToLargeFont()
This action sets the font size to the system's specified "large" size for Forms. By default, this is font size 32.
Example
use Libraries.Interface.Forms.Form
use Libraries.Interface.Forms.Page
use Libraries.Interface.Controls.Button
Form form
Page page = form:GetMainPage()
Button button = page:AddButton("Click for Bacon")
button:SetToLargeFont()
form:Display()
SetToMediumFont()
This action sets the font size to the system's specified "medium" size. By default, this is font size 20.
Example
use Libraries.Interface.Forms.Form
use Libraries.Interface.Forms.Page
use Libraries.Interface.Controls.Button
Form form
Page page = form:GetMainPage()
Button button = page:AddButton("Click for Bacon")
button:SetToMediumFont()
form:Display()
SetToSmallFont()
This action sets the font size to the system's specified "small" size. By default, this is font size 14.
Example
use Libraries.Interface.Forms.Form
use Libraries.Interface.Forms.Page
use Libraries.Interface.Controls.Button
Form form
Page page = form:GetMainPage()
Button button = page:AddButton("Click for Bacon")
button:SetToSmallFont()
form:Display()
SetToTinyFont()
This action sets the font size to the system's specified "tiny" size. By default, this is font size 10.
Example
use Libraries.Interface.Forms.Form
use Libraries.Interface.Forms.Page
use Libraries.Interface.Controls.Button
Form form
Page page = form:GetMainPage()
Button button = page:AddButton("Click for Bacon")
button:SetToTinyFont()
form:Display()
SetTopLeftPixelRounding(number value)
This action sets the top left pixel rounding value.
Parameters
- number value: the top left pixel rounding value.
SetTopLeftRounding(number value)
This action sets the top left rounding value.
Parameters
- number value: the top left rounding value.
SetTopMargin(number padding)
This action sets the top margin size. The top margin is the space outside of the top border.
Parameters
- number padding: the amount of top margin.
SetTopPadding(number padding)
This action sets the top padding size. The top padding is the space inside of the top border.
Parameters
- number padding: the amount of top margin.
SetTopRightPixelRounding(number value)
This action sets the top right pixel rounding value.
Parameters
- number value: the top right pixel rounding value.
SetTopRightRounding(number value)
This action sets the top right rounding value.
Parameters
- number value: the top right rounding value.
SetTorque(number torque)
This action sets the total torque on this item. The units are kilogram units squared per second per second. This action should be used to set the total torque on this item. If we want to apply a torque to this item, we should use the ApplyTorque actions instead. Physics must be enabled on this action before using this action.
Parameters
- number torque
Example
use Libraries.Interface.Item2D
Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetTorque(200)
SetTouchExplorationEnabled(boolean touchExplorationEnabled)
This action sets the flag to determine if touch exploration is enabled.
Parameters
- boolean touchExplorationEnabled: The flag to determine if touch exploration is enabled.
SetTransform(Libraries.Compute.Vector2 position, number angle)
This action is used internally by the physics system to set the position of this item in the physics world. This action is used internally and users users should not need to use this action.
Parameters
- Libraries.Compute.Vector2: The vector representing the position of the center of the item in physics space
- number angle: The rotation in radians of the item in physics space
SetTransform(Libraries.Game.Collision.PhysicsPosition2D transform)
This action sets the position of the item in physical space. This action is used internally and should not be used by users to set the position of this item on the screen.
Parameters
- Libraries.Game.Collision.PhysicsPosition2D: The position and angle of this item in physics space
SetTransform0(Libraries.Game.Collision.PhysicsPosition2D transform)
This action sets 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.
Parameters
- Libraries.Game.Collision.PhysicsPosition2D: The position and angle of the item in physics space in the previuos frame
SetUnfocusedSelectionBorderColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the unfocused selection border color.
Parameters
- Libraries.Game.Graphics.ColorGroup: the unfocused selection border color.
SetUnfocusedSelectionColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the unfocused selection color on the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the unfocused selection color.
SetUnfocusedSelectionFontColor(Libraries.Game.Graphics.ColorGroup value)
This action sets the unfocused selection font color on the control.
Parameters
- Libraries.Game.Graphics.ColorGroup: the unfocused selection font color.
SetUnmovable()
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.
SetUpItem(Libraries.Interface.Controls.Charts.ChartItem upItem)
Sets the Item accessed "above" (via the UP arrow) this Item in the chart selection.
Parameters
SetUpdateTransform(boolean flag)
This item is used to test whether a passed point is on the collision shape of this item.
Parameters
- boolean flag
Example
use Libraries.Interface.Drawable
use Libraries.Compute.Vector2
Drawable circle
circle:LoadFilledCircle(30)
circle:SetPosition(350, 400)
Vector2 point
point:Set(365, 410)
boolean result = circle:TestPoint(point)
SetValueOrderInstruction(text valueOrderInstruction)
This action sets the instruction text for a value order description.
Parameters
- text valueOrderInstruction: The description for value order.
SetVerticalLayoutMode(integer mode)
The GetVerticalLayoutMode 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.
Parameters
- integer mode: A layout mode constant, one of STANDARD, FILL, FILL_CONTENTS, or FIT_FONT.
SetView2D(Libraries.Interface.Views.View2D content)
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.
Parameters
SetWidth(number newWidth)
This action will set the width of the Item2D.
Parameters
- number newWidth
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetWidth(50)
SetX(number setX)
This action sets the X coordinate of the Item.
Parameters
- number setX
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetX(35.0)
SetXAxisMaximum(number max)
This action sets the X axis maximum value. Max and min point values will track the highest and lowest points and limit the axis controls to not pass that value. Atrribute: Parameter max the number for the x axis maximum.
Parameters
- number max
SetXAxisMinimum(number min)
This action sets the X axis minimum value. Max and min point values will track the highest and lowest points and limit the axis controls to not pass that value. Atrribute: Parameter min the number for the x axis minimum.
Parameters
- number min
SetXAxisNumberFormat(text format)
This action sets the X axis value format, "number" or "integer". Atrribute: Parameter format the text values "number" or "integer are valid.
Parameters
- text format
SetXAxisPaddedOffsetPercent(number percent)
This action sets the X axis padded offset percent. This allows for adjustments to the offset of the X axis of the chart. Atrribute: Parameter percent a number between 0 and 1.
Parameters
- number percent
SetXAxisTitle(text name)
This action sets the title for the X-Axis of the Chart.
Parameters
- text name: the x-axis title.
SetXAxisUsePercent(boolean bool)
This action sets whether the X axis uses percent values or not.
Parameters
- boolean bool: is true if the values are percents and false if not.
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:FlipOrientation()
chart:SetXAxisUsePercent(true)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
SetXLabelFontSize(integer size)
This action sets the x-axis label font size.
Parameters
- integer size: of the x-axis label font.
SetXLabels(Libraries.Containers.Array<Libraries.Interface.Controls.Charts.ChartLabel> newLabels)
This action is used to Set the list of X-axis labels on the X-axis component.
Parameters
- Libraries.Containers.Array: containing all of the labels to be displayed on the X-axis.
SetXTickCount(integer ticks)
This action set the number of ticks on the X axis. Atrribute: Parameter ticks the number of tick on the x axis.
Parameters
- integer ticks
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:FlipOrientation()
chart:SetXTickCount(8)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
SetXTickInterval(number set)
This action set the number between ticks on the X axis. Atrribute: Parameter set the number between ticks on the x axis.
Parameters
- number set
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:FlipOrientation()
chart:SetXTickInterval(10.5)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
SetXTickInterval(integer set)
This action set the integer distance between ticks on the X axis. Atrribute: Parameter set the integer value between x axis ticks.
Parameters
- integer set
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:FlipOrientation()
chart:SetXTickInterval(10)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
SetXTitleFontSize(integer size)
This action sets the x-axis title font size.
Parameters
- integer size: of the x-axis title font.
SetY(number setY)
This action sets the Y coordinate of the Item.
Parameters
- number setY
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetY(210.0)
SetYAxisMaximum(number max)
This action sets the Y axis maximum value. Max and min point values will track the highest and lowest points and limit the axis controls to not pass that value. Atrribute: Parameter max the number for the Y axis maximum.
Parameters
- number max
SetYAxisMinimum(number min)
This action sets the X axis minimum value. Max and min point values will track the highest and lowest points and limit the axis controls to not pass that value. Atrribute: Parameter min the number for the x axis minimum.
Parameters
- number min
SetYAxisNumberFormat(text format)
This action sets the Y axis value format, "number" or "integer". Atrribute: Parameter format the text values "number" or "integer are valid.
Parameters
- text format
SetYAxisPaddedOffsetPercent(number percent)
These actions are used to offset the start of the tick placement if the chart has added white space on either side of the chart area.
Parameters
- number percent
SetYAxisTitle(text name)
This action sets the title for the Y-Axis of the Chart.
Parameters
- text name: the y-axis title.
SetYAxisUsePercent(boolean bool)
This action sets whether the Y axis uses percent values or not.
Parameters
- boolean bool: is true if the values are percents and false if not.
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:SetYAxisUsePercent(true)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
SetYLabelFontSize(integer size)
This action sets the y-axis label font size.
Parameters
- integer size: of the y-axis label font.
SetYLabels(Libraries.Containers.Array<Libraries.Interface.Controls.Charts.ChartLabel> newLabels)
This action is used to Set the list of Y-axis labels on the Y-axis component.
Parameters
- Libraries.Containers.Array: containing all of the labels to be displayed on the Y-axis.
SetYTickCount(integer ticks)
This action set the number of ticks on the y axis. Atrribute: Parameter ticks the number of tick on the y axis.
Parameters
- integer ticks
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:SetYTickCount(8)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
SetYTickInterval(number set)
This action set the number between ticks on the Y axis. Atrribute: Parameter set the number between ticks on the y axis.
Parameters
- number set
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:SetYTickInterval(10.5)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
SetYTickInterval(integer set)
This action set the integer distance between ticks on the Y axis. Atrribute: Parameter set the integer value between y axis ticks.
Parameters
- integer set
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:SetYTickInterval(10)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
SetYTitleFontSize(integer size)
This action sets the y-axis title font size.
Parameters
- integer size: of the y-axis title font.
SetZ(number setZ)
This action sets the Z value of the Item2D. For Item2D, the z value is used during layer sorting to determine ordering, where lower z values will be placed first.
Parameters
- number setZ
Example
use Libraries.Interface.Item2D
Item2D myItem
myItem:SetZ(3)
Share(Libraries.System.File file)
This action saves this chart to disk at the position of the current file. To conduct the conversion, the file extension is used. Only Hypertext Markup Language (HTML) is currently supported, and Scalable Vector Graphics (SVG) conversion is used. This makes a file that can be opened in the browser that imports the Javascript and Cascading Stylesheets necessary to navigate the charts accessibly on the web.
Parameters
- Libraries.System.File: the location of where to save the file.
Share(text path)
This is a helper action for sharing that saves at the path relative to the current working directory.
Parameters
- text path: the path relative to the working directory.
ShouldCollide(Libraries.Interface.Item2D otherItem)
Show()
This action is used to indicate that an Item and all Items that were added to it should 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.
Example
use Libraries.Interface.Item
Item item
item:Show()
ShowAllGridLines()
This action shows all major and minor grid lines on the x-axis and y-axis.
ShowAllPoints()
Flag used to display the points of all lines.
ShowAllTicks()
This action shows the ticks on the X and Y axis.
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:ShowAllTicks()
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
ShowAllXGridLines()
This action shows all major and minor grid lines on the x-axis.
ShowAllYGridLines()
This action shows all major and minor grid lines on the y-axis.
ShowAnnotations()
Return
boolean: True if all annotations for chart drawables are showing.
ShowAnnotations(boolean show)
This action sets whether to show annotations for chart dawables.
Parameters
- boolean show: The value to set the showAnnotations flag to.
Example
use Libraries.Compute.Statistics.DataFrame
use Libraries.Interface.Controls.Charts.BarChart
DataFrame frame
frame:Load("Dogs.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:ShowAnnotations(true)
chart:Display(1500,750)
ShowFactorAnnotations(boolean show)
This action sets the visability of the factor name annotation on the points.
Parameters
- boolean show: true displays the annotation on the points.
ShowGroupBrackets(boolean flag)
This action either shows or hides group brackets in the vertical or horizontal panels.
Parameters
- boolean flag: true will show group brackets.
ShowLegend(boolean show)
This action sets the legend to visible.
Parameters
- boolean show: true if the legend should be shown.
ShowLetterCodeAnnotations(boolean show)
This action sets the visability of the letter code annotation on the points.
Parameters
- boolean show: true displays the annotation on the points.
ShowLinearRegression(boolean show)
This action shows or hides linear regression lines, if possible. Some chart types, such as PieChart, cannot support linear regression lines. Trying to show the regression lines on a chart type that does not support it will output a warning, and otherwise have no effect.
Parameters
- boolean show: True to show linear regression lines, or false to hide them.
Example
use Libraries.Compute.Statistics.DataFrame
use Libraries.Interface.Controls.Charts.ScatterPlot
DataFrame frame
frame:Load("Data/ChartTestData.csv")
frame:AddSelectedColumns("Column1")
frame:AddSelectedColumns("Column2")
frame:AddSelectedFactors("Factor1")
ScatterPlot chart = frame:ScatterPlot()
chart:SetTitle("ScatterPlot Feature Example")
chart:SetSubtitle("Two Columns - One Factor")
chart:ShowLinearRegression(true)
chart:ShowSquaresOfResiduals(true)
chart:ShowMovableRegressionLine(true)
chart:SetResidualSquareThickness(2)
chart:LockRegressionYIntercept(0)
chart:Display(1200, 1200)
ShowMajorGridLines()
This action shows all major grid lines on the x-axis and y-axis.
ShowMajorXGridLines()
This action shows all major grid lines on the x-axis.
ShowMajorYGridLines()
This action shows all major grid lines on the y-axis.
ShowMinorGridLines()
This action shows all minor grid lines on the x-axis and y-axis.
ShowMinorXGridLines()
This action shows all minor grid lines on the x-axis.
ShowMinorYGridLines()
This action shows all minor grid lines on the y-axis.
ShowMovableRegressionLine(boolean movable)
This action enables or disables movable regression lines for interactive charts. If the regression lines are movable, they can be dragged with the mouse or using the keyboard. This will have no impact on charts that are exported to SVG format.
Parameters
- boolean movable: True to make regression lines movable, or false to make them non-interactive.
Example
use Libraries.Compute.Statistics.DataFrame
use Libraries.Interface.Controls.Charts.ScatterPlot
DataFrame frame
frame:Load("Data/ChartTestData.csv")
frame:AddSelectedColumns("Column1")
frame:AddSelectedColumns("Column2")
frame:AddSelectedFactors("Factor1")
ScatterPlot chart = frame:ScatterPlot()
chart:SetTitle("ScatterPlot Feature Example")
chart:SetSubtitle("Two Columns - One Factor")
chart:ShowLinearRegression(true)
chart:ShowSquaresOfResiduals(true)
chart:ShowMovableRegressionLine(true)
chart:SetResidualSquareThickness(2)
chart:LockRegressionYIntercept(0)
chart:Display(1200, 1200)
ShowPatterns(boolean show)
Parameters
- boolean show
ShowPointAnnotations(boolean show)
This action sets the visability of the annotation on the points.
Parameters
- boolean show: true displays the annotation on the points.
ShowSubChartAreaBorders()
This action allows user to show the borders around each sub chart area. By default this setting is set to true.
Return
boolean:
ShowSubChartAreaBorders(boolean showSubChartAreaBorders)
This action allows user to show the borders around each sub chart area. By default this setting is set to true in most cases (with the exception of pie charts).
Parameters
- boolean showSubChartAreaBorders
ShowSubChartAreaTitles(boolean show)
This action checks if the sub chart titles are visible.
Parameters
- boolean show: when true the titles are visible.
ShowSubtitle(boolean show)
This action sets the visibility of the subtitle. When true the chart subtitle will be visible.
Parameters
- boolean show: true makes the subtitle visible.
ShowTitle(boolean show)
When true the chart title will be visible.
Parameters
- boolean show: when true the title is visible.
ShowVisualHighlight(boolean visualHighlight)
This action toggles the alpha value of the selection color between 0 and 1.
Parameters
- boolean visualHighlight: The flag to determine if visual highlighting is showing.
ShowXAxis(boolean show)
This action sets the x-axis to visible (true) or hidden (false).
Parameters
- boolean show: True if the axis should be shown.
ShowXAxisTitle(boolean show)
When true the x-axis title will be visible.
Parameters
- boolean show: when true the title is visible.
ShowXLabels(boolean show)
This action is used to toggle the visibility of the X-axis labels.
Parameters
- boolean show: true will display the X-axis labels.
ShowXTicks(boolean show)
This action shows or hides the ticks on the X axis. Atrribute: Parameter show when true and hide when false.
Parameters
- boolean show
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:ShowXTicks(true)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
ShowYAxis(boolean show)
This action sets the y-axis to visible (true) or hidden (false).
Parameters
- boolean show: True if the axis should be shown.
ShowYAxisTitle(boolean show)
When true the y-axis title will be visible.
Parameters
- boolean show: when true the title is visible.
ShowYLabels(boolean show)
This action is used to toggle the visibility of the Y-axis labels.
Parameters
- boolean show: true will display the y-axis labels.
ShowYTicks(boolean show)
This action shows or hides the ticks on the Y axis. Atrribute: Parameter show when true and hide when false.
Parameters
- boolean show
Example
use Libraries.Game.Game
use Libraries.Interface.Controls.Charts.Chart
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Compute.Statistics.DataFrame
class Main is Game
action Main
StartGame()
end
action CreateGame
DataFrame frame
frame:Load("/Data/Cats.csv")
frame:AddSelectedFactors("Maximum Life Span")
BarChart chart = frame:BarChart()
chart:SetTitle("Cat Lifespan")
chart:ShowYTicks(true)
chart:ShowLegend(false)
chart:SetSize(800, 600)
Add(chart)
end
end
Simulate(boolean flag)
This action sets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.
Parameters
- boolean flag
Example
use Libraries.Interface.Item2D
use Libraries.Compute.Vector2
Item2D item
Vector2 velocity
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
velocity:Set(100, 0)
item:SetLinearVelocity(velocity)
SynchronizeNodes()
This action is used to syncronize the item's position in physics space with its position in the tree used for broadphase collision. This action is used internally and users should not need to use this action.
SynchronizeTransform()
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.
TestPoint(Libraries.Compute.Vector2 point)
This item is used to test whether a passed point is on the collision shape of this item.
Parameters
- Libraries.Compute.Vector2: The vector representing the point to test
Return
boolean: True if the passed point is on the collisoin shape, false otherwise
Example
use Libraries.Interface.Drawable
use Libraries.Compute.Vector2
Drawable circle
circle:LoadFilledCircle(30)
circle:SetPosition(350, 400)
Vector2 point
point:Set(365, 410)
boolean result = circle:TestPoint(point)
UnlockRegressionYIntercepts()
This action unlocks the y-intercepts of the regression lines. It does not reset the values of the lines if they were already locked, but makes it possible to adjust them dynamically if the lines are movable.
Update(number seconds)
This action overrides the default Update action. If the tree needs to be updated, the tree is regenerated.
Parameters
- number seconds: the number of seconds since the last update.
UpdateAll(number seconds)
Update all behaviors elements.
Parameters
- number seconds
UpdatePointDescriptions(Libraries.Containers.Array<Libraries.Interface.Controls.Charts.ChartPoint> points)
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).
Parameters
UpdateTransformAngle()
This action is used internally by the physics system to set the position of this item in the physics world. This action is used internally and users users should not need to use this action.
UpdateTransformX()
This action sets the position of the item in physical space. This action is used internally and should not be used by users to set the position of this item on the screen.
UpdateTransformY()
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.
On this page
Variables TableAction Documentation- Activate()
- Activate(Libraries.Interface.Events.BehaviorEvent event)
- Add(integer index, Libraries.Interface.Item2D newItem)
- Add(Libraries.Interface.Item2D newItem)
- AddBehavior(Libraries.Interface.Behaviors.Behavior behavior)
- AddChartAreaInstructions(text description)
- AddChartItemInstructions(Libraries.Interface.Item chartItem, text description)
- AddChartLine(Libraries.Interface.Controls.Charts.ChartLine newLine)
- AddControlActivationListener(Libraries.Interface.Events.ControlActivationListener listener)
- AddFocusListener(Libraries.Interface.Events.FocusListener listener)
- AddGestureListener(Libraries.Interface.Events.GestureListener listener)
- AddGroupPanel(Libraries.Interface.Controls.Charts.GroupPanel group)
- AddGroupPanelInstructions(Libraries.Interface.Controls.Charts.Graphics.ChartDrawable groupPanel, text description)
- AddLayoutProperties(Libraries.Interface.Layouts.LayoutProperties properties)
- AddMouseListener(Libraries.Interface.Events.MouseListener listener)
- AddMouseMovementListener(Libraries.Interface.Events.MouseMovementListener listener)
- AddMouseWheelListener(Libraries.Interface.Events.MouseWheelListener listener)
- AddPoint(Libraries.Interface.Controls.Charts.ChartPoint point)
- AddPoints(Libraries.Interface.Controls.Charts.ChartItem summary, Libraries.Interface.Controls.Charts.ChartItem parentItem, Libraries.Containers.Array
points, Libraries.Interface.Controls.Charts.Series currentSeries) - AddSelectionListener(Libraries.Interface.Events.SelectionListener listener)
- AddSeries(Libraries.Interface.Controls.Charts.Series series)
- AddSubChartAreaInstructions(Libraries.Interface.Controls.Charts.ChartAreaPanel subChartArea, text description)
- AddTouchListener(Libraries.Interface.Events.TouchListener listener)
- AdjustForLegend()
- AdjustForXAxis()
- AdjustForYAxis()
- Advance(number time)
- ApplyAngularImpulse(number impulse)
- ApplyForce(Libraries.Compute.Vector2 force, Libraries.Compute.Vector2 point)
- ApplyForceToCenter(Libraries.Compute.Vector2 force)
- ApplyLinearImpulse(Libraries.Compute.Vector2 impulse, Libraries.Compute.Vector2 point)
- ApplyTorque(number torque)
- AreChildrenProcessingMouseEvents()
- BeginCollision(Libraries.Interface.Item item)
- BeginMouseOver()
- CalculateLineSegmentPhrase(Libraries.Interface.Controls.Charts.ChartPoint point1, Libraries.Interface.Controls.Charts.ChartPoint point2, integer iteration)
- CanRotate(boolean flag)
- CancelBehaviors()
- CastToPoints(Libraries.Containers.Array
chartAreaItems) - CheckPlatformInstructions()
- ClickedMouse()
- CollideWithChildren()
- Compare(Libraries.Language.Object object)
- ComputeDistance(Libraries.Compute.Vector2 point, integer childIndex, Libraries.Compute.Vector2 normalOut)
- Contains(number containsX, number containsY)
- ConvertToScalableVectorGraphics(boolean hasAccessibility)
- ConvertToScalableVectorGraphics()
- CopyAndActivateInputTable(text name)
- CreateNodes(Libraries.Game.Collision.BroadphaseCollision2D broadphase, Libraries.Game.Collision.PhysicsPosition2D transform)
- DestroyNodes(Libraries.Game.Collision.BroadphaseCollision2D broadphase)
- Display(boolean exit)
- Display(integer width, integer height)
- Display()
- Display(integer width, integer height, boolean exit)
- Dispose()
- DisposeAll()
- DisposeChildren()
- DisposeDrawables()
- DoSpecialNavigation(integer navigationType)
- Draw(Libraries.Game.Graphics.Painter2D painter)
- Empty()
- EmptyAll()
- EmptyChildren()
- EmptySelectionListeners()
- EnablePhysics(boolean flag)
- EndMouseOver()
- Equals(Libraries.Language.Object object)
- FastMoving(boolean flag)
- FinishCollision(Libraries.Interface.Item item)
- FlipOrientation()
- FlipX()
- FlipY()
- Focus()
- GainedFocus(Libraries.Interface.Events.FocusEvent event)
- GainedSelection()
- GenerateInfoTree()
- GenerateLineDescription(Libraries.Interface.Controls.Charts.ChartLine line)
- GeneratePointDescriptionX(Libraries.Interface.Controls.Charts.ChartPoint point)
- GeneratePointDescriptionY(Libraries.Interface.Controls.Charts.ChartPoint point)
- GeneratePointSummary(Libraries.Interface.Controls.Charts.ChartPoint point)
- GenerateSummary()
- GetAccentColor()
- GetAccessibilityCode()
- GetAccessibilityRoleDescription()
- GetAccessibilityType()
- GetAccessibleParent()
- GetActivationBehavior()
- GetAllLines()
- GetAngularDamping()
- GetAngularVelocity()
- GetBackground()
- GetBackgroundColor()
- GetBorderColor()
- GetBorderStyle()
- GetBorderThickness()
- GetBottomLeftPixelRounding()
- GetBottomLeftRounding()
- GetBottomMargin()
- GetBottomPadding()
- GetBottomRightPixelRounding()
- GetBottomRightRounding()
- GetBoundingBox(integer childIndex)
- GetBoundingRectangle()
- GetCenterX()
- GetCenterY()
- GetChartArea()
- GetChartAreaHeightPercent()
- GetChartAreaItem()
- GetChartAreaWidthPercent()
- GetChartItemText()
- GetChartItemsText()
- GetChartPoints()
- GetChildren()
- GetClipCoordinates(Libraries.Compute.Vector2 xCoords, Libraries.Compute.Vector2 yCoords)
- GetCollisionGroupFlag()
- GetCollisionGroupIndex()
- GetCollisionList()
- GetColorProperty(text property)
- GetContainer()
- GetContainerGridHeight()
- GetContainerGridWidth()
- GetCurrentLayoutProperties()
- GetDefaultFont()
- GetDefaultFontName()
- GetDefaultFontSize()
- GetDefaultLayoutProperties()
- GetDensity()
- GetDescription()
- GetDisplayName()
- GetDownItem()
- GetDrawableShape()
- GetEnterInstruction()
- GetEnterItem()
- GetEscapeItem()
- GetExitInstruction()
- GetFactorList()
- GetFocusBorderColor()
- GetFocusColor()
- GetFocusFontColor()
- GetFocusListeners()
- GetFont()
- GetFontColor()
- GetFontOutlineColor()
- GetFontOutlineThickness()
- GetFontSize()
- GetForce()
- GetForegroundColor()
- GetForegroundSelectionColor()
- GetFriction()
- GetGeneralInstruction()
- GetGestureListeners()
- GetGlobalX()
- GetGlobalY()
- GetGlobalZ()
- GetGlowColor()
- GetGridHeight()
- GetGridWidth()
- GetGridX()
- GetGridY()
- GetGroupPanels()
- GetGroupText()
- GetGroupsText()
- GetHashCode()
- GetHeight()
- GetHorizontalFlag()
- GetHorizontalLayoutMode()
- GetHorizontalPanel()
- GetHorizontalPanelHeightPercent()
- GetHorizontalPanelWidthPercent()
- GetIcon()
- GetIconColor()
- GetInertia()
- GetInputGroup()
- GetInputTable()
- GetInterfaceOptionsKey()
- GetInterfaceScale()
- GetInverseInertia()
- GetInverseMass()
- GetItem(integer index)
- GetItemAt(number x, number y)
- GetItemCount()
- GetItems()
- GetJointList()
- GetLabelText()
- GetLayer()
- GetLayout()
- GetLayoutProperties(number containerWidth, number containerHeight)
- GetLayoutProperties()
- GetLayoutRows()
- GetLeftItem()
- GetLeftMargin()
- GetLeftPadding()
- GetLegend()
- GetLegendIconBorderThickness()
- GetLegendTitle()
- GetLine(integer i)
- GetLineDensity()
- GetLinearDamping()
- GetLinearVelocity()
- GetLinearVelocityFromLocalPoint(Libraries.Compute.Vector2 localPoint)
- GetLinearVelocityFromWorldPoint(Libraries.Compute.Vector2 worldPoint)
- GetListOrderInstruction()
- GetLocalCenter()
- GetLocalPoint(Libraries.Compute.Vector2 worldPoint)
- GetLocalVector(Libraries.Compute.Vector2 worldVector)
- GetMass()
- GetMass(Libraries.Game.Physics.Mass2D mass)
- GetMaximumSubdivisions()
- GetMouseDownColor()
- GetMouseDownFontColor()
- GetMouseDownGlowColor()
- GetMouseListeners()
- GetMouseMovementListeners()
- GetMouseOverColor()
- GetMouseOverFontColor()
- GetMouseOverGlowColor()
- GetMouseWheelListeners()
- GetName()
- GetNextFocus()
- GetNodeCount()
- GetNodes()
- GetNumberOfChartAreas()
- GetNumberOfLines()
- GetNumberOfPoints()
- GetNumberProperty(text property)
- GetOffsetX()
- GetOffsetY()
- GetOffsetZ()
- GetOriginX()
- GetOriginY()
- GetParent()
- GetPercentageHeight()
- GetPercentageOriginX()
- GetPercentageOriginY()
- GetPercentageWidth()
- GetPercentageX()
- GetPercentageY()
- GetPhysicsProperties()
- GetPixelHeight()
- GetPixelWidth()
- GetPixelX()
- GetPixelY()
- GetPointBorderThickness()
- GetPointDensity()
- GetPointsFlag()
- GetPopupMenu()
- GetPreviousFocus()
- GetPropertiesSize()
- GetProperty(text key)
- GetPropertyKeyIterator()
- GetQuadrantThreshold()
- GetRawInertia()
- GetRegions()
- GetRegressionLineColor()
- GetRegressionLineDensity()
- GetResponsiveness()
- GetRestitution()
- GetRightItem()
- GetRightMargin()
- GetRightPadding()
- GetRotation()
- GetRotationInRadians()
- GetRotationOverride()
- GetScaleX()
- GetScaleY()
- GetScreenX()
- GetScreenY()
- GetScriptFilepath()
- GetSelection()
- GetSelectionBorderColor()
- GetSelectionColor()
- GetSelectionFontColor()
- GetSelectionListeners()
- GetSeriesList()
- GetSeriesText()
- GetShadowColor()
- GetShadowEdgeFade()
- GetShadowHeight()
- GetShadowWidth()
- GetShadowX()
- GetShadowY()
- GetShape()
- GetShapeType()
- GetSleepTime()
- GetStyleFilepath()
- GetSubChartAreas()
- GetSubHorizontalPanels()
- GetSubVerticalPanels()
- GetSubtitle()
- GetSubtitleAreaHeightPercent()
- GetSubtitleLabel()
- GetSweep()
- GetTitle()
- GetTitleAreaHeightPercent()
- GetTitleLabel()
- GetTopLeftPixelRounding()
- GetTopLeftRounding()
- GetTopMargin()
- GetTopPadding()
- GetTopRightPixelRounding()
- GetTopRightRounding()
- GetTorque()
- GetTouchExplorationEnabled()
- GetTouchListeners()
- GetTransform()
- GetTransform0()
- GetUnfocusedSelectionBorderColor()
- GetUnfocusedSelectionColor()
- GetUnfocusedSelectionFontColor()
- GetUpItem()
- GetValueOrderInstruction()
- GetVerticalFlag()
- GetVerticalLayoutMode()
- GetVerticalPanel()
- GetVerticalPanelHeightPercent()
- GetVerticalPanelWidthPercent()
- GetView2D()
- GetVisibleItemAt(number x, number y)
- GetWidth()
- GetWorldCenter()
- GetWorldPoint(Libraries.Compute.Vector2 localPoint)
- GetWorldVector(Libraries.Compute.Vector2 localVector)
- GetX()
- GetXAxisMaximum()
- GetXAxisMinimum()
- GetXAxisTitle()
- GetXAxisUsePercent()
- GetXLabels()
- GetXLabelsRotation()
- GetY()
- GetYAxisMaximum()
- GetYAxisMinimum()
- GetYAxisTitle()
- GetYAxisUsePercent()
- GetYLabels()
- GetZ()
- HasAccessibility()
- HasBorderThickness()
- HasBottomBorder()
- HasBottomLeftPixelRounding()
- HasBottomLeftRounding()
- HasBottomRightPixelRounding()
- HasBottomRightRounding()
- HasColorPropertyOverride(text property)
- HasFactorAnnotations()
- HasFontOutlineThickness()
- HasGroups()
- HasLeftBorder()
- HasMovableRegressionLine()
- HasMoved()
- HasNumberPropertyOverride(text property)
- HasProperties()
- HasProperty(text key)
- HasRightBorder()
- HasShadowEdgeFade()
- HasShadowHeight()
- HasShadowWidth()
- HasShadowX()
- HasShadowY()
- HasSpecialNavigation(integer navigationType)
- HasTopBorder()
- HasTopLeftPixelRounding()
- HasTopLeftRounding()
- HasTopRightPixelRounding()
- HasTopRightRounding()
- Hide()
- HideAllGridLines()
- HideAllPoints()
- HideAllTicks()
- HideAllXGridLines()
- HideAllYGridLines()
- HideMajorGridLines()
- HideMajorXGridLines()
- HideMajorYGridLines()
- HideMinorGridLines()
- HideMinorXGridLines()
- HideMinorYGridLines()
- IsAcceptingMouseInput()
- IsAccessibleParent()
- IsClipping()
- IsCollidable()
- IsCustomDrawing()
- IsEmpty()
- IsEscapingToLastItem()
- IsFastMoving()
- IsFlippedX()
- IsFlippedY()
- IsFocusable()
- IsFocused()
- IsLockingRegressionYIntercepts()
- IsNonResponsive()
- IsOnLayer()
- IsPassingThroughSelection()
- IsPhysicsEnabled()
- IsRenderingFocus()
- IsRenderingMouseDown()
- IsRenderingMouseOver()
- IsRenderingSelection()
- IsResponsive()
- IsRotationAllowed()
- IsSeparated()
- IsSeparatedByFactor()
- IsSeparatedBySeries()
- IsShowing()
- IsShowingLegend()
- IsShowingLinearRegression()
- IsShowingMajorXGridLines()
- IsShowingMajorYGridLines()
- IsShowingMinorXGridLines()
- IsShowingMinorYGridLines()
- IsShowingPatterns()
- IsShowingSubChartAreaTitles()
- IsShowingSubtitle()
- IsShowingTitle()
- IsShowingXAxis()
- IsShowingXAxisTitle()
- IsShowingYAxis()
- IsShowingYAxisTitle()
- IsSimulated()
- IsSimulationRequired()
- IsUnmovable()
- LoadChartAreaItems()
- LoadGraphics(Libraries.Interface.Layouts.LayoutProperties properties)
- LockRegressionYIntercept(number intercept)
- LostFocus(Libraries.Interface.Events.FocusEvent event)
- LostSelection()
- LostSelection(Libraries.Interface.Controls.Charts.ChartItem ci)
- Move(Libraries.Compute.Vector2 movement)
- Move(number xAmount, number yAmount)
- MoveX(number xAmount)
- MoveY(number yAmount)
- MoveZ(number zAmount)
- NeedsLayout()
- NeedsTreeUpdate()
- NotifyControlActivationListeners(Libraries.Interface.Events.ControlActivationEvent event)
- NotifySelectionListeners(Libraries.Interface.Events.SelectionEvent event)
- OnSelectionChange(Libraries.Interface.Controls.Charts.ChartItem ci)
- OrientationChanged()
- OverrideXLabelsWithText(Libraries.Containers.Array
labels) - OverrideYLabelsWithText(Libraries.Containers.Array
labels) - PrepareVertices()
- ProcessGestureEvent(Libraries.Interface.Events.GestureEvent event)
- ProcessMouseEvent(Libraries.Interface.Events.MouseEvent event)
- ProcessTouchEvent(Libraries.Interface.Events.TouchEvent event)
- QueueForDrawing(Libraries.Game.Graphics.Painter2D painter)
- ReleasedMouse()
- Remove(Libraries.Interface.Item2D item)
- Remove(integer index)
- RemoveControlActivationListener(Libraries.Interface.Events.ControlActivationListener listener)
- RemoveFocusListener(Libraries.Interface.Events.FocusListener listener)
- RemoveGestureListener(Libraries.Interface.Events.GestureListener listener)
- RemoveLayoutProperties(Libraries.Interface.Layouts.LayoutProperties properties)
- RemoveMouseListener(Libraries.Interface.Events.MouseListener listener)
- RemoveMouseMovementListener(Libraries.Interface.Events.MouseMovementListener listener)
- RemoveMouseWheelListener(Libraries.Interface.Events.MouseWheelListener listener)
- RemoveSelectionListener(Libraries.Interface.Events.SelectionListener listener)
- RemoveTouchListener(Libraries.Interface.Events.TouchListener listener)
- RequestLayout()
- RequestReloadGraphics()
- RequestVerticesUpdate()
- RequireSimulation(boolean flag)
- ResetLayoutFlag()
- ResetMass()
- Resize()
- Rotate(number degrees)
- RotateXLabels(integer degrees)
- Save(text path)
- Save(Libraries.System.File file)
- Scale(number xAmount, number yAmount)
- Scale(number amount)
- ScaleFromCenter(number amount)
- ScaleFromCenter(number xAmount, number yAmount)
- Select(Libraries.Interface.Controls.Charts.ChartItem item)
- SelectByFirstLetters(text firstLetter)
- SelectionDown()
- SelectionEnter()
- SelectionEscape()
- SelectionLeft()
- SelectionNextFocus()
- SelectionPreviousFocus()
- SelectionRight()
- SelectionUp()
- SeparateByFactor()
- SeparateByFactor(boolean flag)
- SeparateByFactor(integer requestedColumns)
- SeparateBySeries()
- SeparateBySeries(integer requestedColumns)
- SeparateBySeries(boolean flag)
- SetAccentColor(Libraries.Game.Graphics.ColorGroup value)
- SetAcceptsMouseInput(boolean accepts)
- SetAccessibilityCode(integer newAccessibilityCode)
- SetAccessibilityFlag(boolean hasAccessibility)
- SetAccessibilityRoleDescription(text newRoleDescription)
- SetAngularDamping(number angularDamping)
- SetAngularVelocity(number angularVelocity)
- SetAnnotationFontSize(integer size)
- SetBackground(Libraries.Game.Graphics.Drawable background)
- SetBackgroundColor(Libraries.Game.Graphics.ColorGroup value)
- SetBorderColor(Libraries.Game.Graphics.ColorGroup value)
- SetBorderStyle(integer style)
- SetBorderThickness(number value)
- SetBottomLeftPixelRounding(number value)
- SetBottomLeftRounding(number value)
- SetBottomMargin(number padding)
- SetBottomPadding(number padding)
- SetBottomRightPixelRounding(number value)
- SetBottomRightRounding(number value)
- SetBoundingBox(number newX, number newY, number newWidth, number newHeight)
- SetCenter(number setX, number setY)
- SetCenterX(number setX)
- SetCenterY(number setY)
- SetChildrenProcessingMouseEvents(boolean shouldProcess)
- SetClipCoordinates(Libraries.Game.Graphics.Painter2D painter)
- SetClipping(boolean clip)
- SetCollidable(boolean flag)
- SetCollideWithChildren(boolean flag)
- SetCollisionGroupFlag(boolean flag)
- SetCollisionGroupIndex(integer index)
- SetCollisionList(Libraries.Game.Collision.CollisionEdge2D edge)
- SetColorPalette(Libraries.Game.Graphics.Color colorA, Libraries.Game.Graphics.Color colorB, Libraries.Game.Graphics.Color colorC)
- SetColorPalette(Libraries.Game.Graphics.Color color)
- SetColorPalette(Libraries.Game.Graphics.Color colorA, Libraries.Game.Graphics.Color colorB)
- SetColorPalette(Libraries.Containers.Array
palette) - SetColorPaletteToCalm()
- SetColorPaletteToColorgorical()
- SetColorPaletteToCoolScale()
- SetColorPaletteToDisturbing()
- SetColorPaletteToExciting()
- SetColorPaletteToMagma()
- SetColorPaletteToNegative()
- SetColorPaletteToPlayful()
- SetColorPaletteToPositive()
- SetColorPaletteToSerious()
- SetColorPaletteToTrustworthy()
- SetColorPaletteToWarmScale()
- SetColorProperty(text property, Libraries.Game.Graphics.ColorGroup value)
- SetContainer(Libraries.Interface.Controls.Charts.Chart container)
- SetContainerGridHeight(integer containerGridHeight)
- SetContainerGridWidth(integer containerGridWidth)
- SetCornerPixelRounding(number bottomLeft, number bottomRight, number topLeft, number topRight)
- SetCornerRounding(number bottomLeft, number bottomRight, number topLeft, number topRight)
- SetCurrentPaletteToGrayScale()
- SetCustomDrawing(boolean isCustom)
- SetDensity(number density)
- SetDescription(text newDescription)
- SetDisplayName(text info)
- SetDownItem(Libraries.Interface.Controls.Charts.ChartItem downItem)
- SetEnterInstruction(text enterInstruction)
- SetEnterItem(Libraries.Interface.Controls.Charts.ChartItem enterItem)
- SetEscapeItem(Libraries.Interface.Controls.Charts.ChartItem escapeItem)
- SetEscapeToLastItem(boolean escape)
- SetExitInstruction(text exitInstruction)
- SetFactorList(Libraries.Containers.Array
factorList) - SetFlipX(boolean flip)
- SetFlipY(boolean flip)
- SetFocusBorderColor(Libraries.Game.Graphics.ColorGroup value)
- SetFocusColor(Libraries.Game.Graphics.ColorGroup value)
- SetFocusFontColor(Libraries.Game.Graphics.ColorGroup value)
- SetFocusable(boolean focus)
- SetFont(Libraries.Game.Graphics.Font font)
- SetFontColor(Libraries.Game.Graphics.ColorGroup value)
- SetFontOutlineColor(Libraries.Game.Graphics.ColorGroup value)
- SetFontOutlineThickness(number value)
- SetFontSize(integer size)
- SetForce(Libraries.Compute.Vector2 force)
- SetForegroundColor(Libraries.Game.Graphics.ColorGroup value)
- SetForegroundSelectionColor(Libraries.Game.Graphics.ColorGroup value)
- SetFriction(number friction)
- SetGeneralInstruction(text generalInstruction)
- SetGlowColor(Libraries.Game.Graphics.ColorGroup value)
- SetGridHeight(integer gridHeight)
- SetGridPosition(integer gridX, integer gridY)
- SetGridSize(integer gridWidth, integer gridHeight)
- SetGridWidth(integer gridWidth)
- SetGridX(integer gridX)
- SetGridY(integer gridY)
- SetHasMoved(boolean flag)
- SetHeight(number newHeight)
- SetHighlightColor(Libraries.Game.Graphics.Color color)
- SetHorizontalLayoutMode(integer mode)
- SetIcon(Libraries.Game.Graphics.TextureRegion icon)
- SetIconColor(Libraries.Game.Graphics.ColorGroup value)
- SetInputGroup(text group)
- SetInterfaceOptionsKey(text key)
- SetInterfaceScale(number scale)
- SetItem(integer index, Libraries.Interface.Item2D newItem)
- SetJointList(Libraries.Game.Physics.Joints.JointEdge2D edge)
- SetLabelText(text labelText)
- SetLayer(Libraries.Game.Layer2D parentLayer)
- SetLayout(Libraries.Interface.Layouts.Layout layout)
- SetLayoutRows(number layoutRows)
- SetLeftItem(Libraries.Interface.Controls.Charts.ChartItem leftItem)
- SetLeftMargin(number padding)
- SetLeftPadding(number padding)
- SetLegend(Libraries.Interface.Controls.Charts.Legend legend)
- SetLegendIconBorderThickness(number thickness)
- SetLegendLabelFontSize(integer size)
- SetLegendLocationToBottom()
- SetLegendLocationToLeft()
- SetLegendLocationToRight()
- SetLegendLocationToTop()
- SetLegendTitle(text name)
- SetLegendTitleFontSize(integer size)
- SetLineDensity(integer density)
- SetLinearDamping(number linearDamping)
- SetLinearVelocity(Libraries.Compute.Vector2 linearVelocity)
- SetLinearVelocityX(number linearVelocityX)
- SetLinearVelocityY(number linearVelocityY)
- SetListOrderInstruction(text listOrderInstruction)
- SetMass(number mass)
- SetMass(Libraries.Game.Physics.Mass2D mass)
- SetMaximumSubdivisons(integer subdivisions)
- SetMinorXGridlineCount(integer count)
- SetMinorYGridlineCount(integer count)
- SetMouseDownColor(Libraries.Game.Graphics.ColorGroup value)
- SetMouseDownFontColor(Libraries.Game.Graphics.ColorGroup value)
- SetMouseDownGlowColor(Libraries.Game.Graphics.ColorGroup value)
- SetMouseOverColor(Libraries.Game.Graphics.ColorGroup value)
- SetMouseOverFontColor(Libraries.Game.Graphics.ColorGroup value)
- SetMouseOverGlowColor(Libraries.Game.Graphics.ColorGroup value)
- SetName(text newName)
- SetNeedsUpdate(boolean update)
- SetNextFocus(Libraries.Interface.Item next)
- SetNonResponsive()
- SetNumberProperty(text property, number value)
- SetOffset(number xAmount, number yAmount)
- SetOffset(number xAmount, number yAmount, number zAmount)
- SetOffsetX(number xAmount)
- SetOffsetY(number yAmount)
- SetOffsetZ(number zAmount)
- SetOrientationToHorizontal()
- SetOrientationToVertical()
- SetOrigin(number setX, number setY)
- SetOriginCenter()
- SetParent(Libraries.Interface.Item2D newItem)
- SetPassThroughSelection(boolean passThroughSelection)
- SetPercentageHeight(number height)
- SetPercentageOriginX(number x)
- SetPercentageOriginY(number y)
- SetPercentageWidth(number width)
- SetPercentageX(number x)
- SetPercentageY(number y)
- SetPhysicsProperties(Libraries.Game.Physics.PhysicsProperties2D properties)
- SetPixelHeight(number height)
- SetPixelWidth(number width)
- SetPixelX(number x)
- SetPixelY(number y)
- SetPointBorderThickness(number pointBorderThickness)
- SetPointDensity(integer radius)
- SetPopupMenu(Libraries.Interface.Controls.PopupMenu menu)
- SetPosition(number setX, number setY)
- SetPosition(number setX, number setY, number setZ)
- SetPreviousFocus(Libraries.Interface.Item previous)
- SetProperty(text key, Libraries.Data.Formats.JavaScriptObjectNotation value)
- SetQuadrantThreshold(integer threshold)
- SetRegressionLineColor(Libraries.Game.Graphics.Color color)
- SetRegressionLineDensity(integer density)
- SetResponsive()
- SetResponsiveness(integer type)
- SetRestitution(number restitution)
- SetRightItem(Libraries.Interface.Controls.Charts.ChartItem rightItem)
- SetRightMargin(number padding)
- SetRightPadding(number padding)
- SetRotation(number degrees)
- SetRotationOverride(boolean flag)
- SetScale(number scale)
- SetScale(number newX, number newY)
- SetScaleFromCenter(number newX, number newY)
- SetScaleFromCenter(number scale)
- SetScaleX(number scaleX)
- SetScaleY(number scaleY)
- SetScreenPositionFromPhysicsPosition()
- SetScriptFilepath(text scriptFilepath)
- SetSelectionBorderColor(Libraries.Game.Graphics.ColorGroup value)
- SetSelectionColor(Libraries.Game.Graphics.ColorGroup value)
- SetSelectionFontColor(Libraries.Game.Graphics.ColorGroup value)
- SetSeriesList(Libraries.Containers.Array
series) - SetShadowColor(Libraries.Game.Graphics.ColorGroup value)
- SetShadowEdgeFade(number value)
- SetShadowHeight(number value)
- SetShadowWidth(number value)
- SetShadowX(number value)
- SetShadowY(number value)
- SetShape(Libraries.Game.Collision.Shapes.CollisionShape2D shape)
- SetSize(number newWidth, number newHeight)
- SetSleepTime(number time)
- SetStyleFilepath(text styleFilepath)
- SetSubtitle(text name)
- SetSubtitleFontSize(integer size)
- SetTitle(text name)
- SetTitleFontSize(integer size)
- SetToDefaultFontSize()
- SetToHugeFont()
- SetToLargeFont()
- SetToMediumFont()
- SetToSmallFont()
- SetToTinyFont()
- SetTopLeftPixelRounding(number value)
- SetTopLeftRounding(number value)
- SetTopMargin(number padding)
- SetTopPadding(number padding)
- SetTopRightPixelRounding(number value)
- SetTopRightRounding(number value)
- SetTorque(number torque)
- SetTouchExplorationEnabled(boolean touchExplorationEnabled)
- SetTransform(Libraries.Compute.Vector2 position, number angle)
- SetTransform(Libraries.Game.Collision.PhysicsPosition2D transform)
- SetTransform0(Libraries.Game.Collision.PhysicsPosition2D transform)
- SetUnfocusedSelectionBorderColor(Libraries.Game.Graphics.ColorGroup value)
- SetUnfocusedSelectionColor(Libraries.Game.Graphics.ColorGroup value)
- SetUnfocusedSelectionFontColor(Libraries.Game.Graphics.ColorGroup value)
- SetUnmovable()
- SetUpItem(Libraries.Interface.Controls.Charts.ChartItem upItem)
- SetUpdateTransform(boolean flag)
- SetValueOrderInstruction(text valueOrderInstruction)
- SetVerticalLayoutMode(integer mode)
- SetView2D(Libraries.Interface.Views.View2D content)
- SetWidth(number newWidth)
- SetX(number setX)
- SetXAxisMaximum(number max)
- SetXAxisMinimum(number min)
- SetXAxisNumberFormat(text format)
- SetXAxisPaddedOffsetPercent(number percent)
- SetXAxisTitle(text name)
- SetXAxisUsePercent(boolean bool)
- SetXLabelFontSize(integer size)
- SetXLabels(Libraries.Containers.Array
newLabels) - SetXTickCount(integer ticks)
- SetXTickInterval(number set)
- SetXTickInterval(integer set)
- SetXTitleFontSize(integer size)
- SetY(number setY)
- SetYAxisMaximum(number max)
- SetYAxisMinimum(number min)
- SetYAxisNumberFormat(text format)
- SetYAxisPaddedOffsetPercent(number percent)
- SetYAxisTitle(text name)
- SetYAxisUsePercent(boolean bool)
- SetYLabelFontSize(integer size)
- SetYLabels(Libraries.Containers.Array
newLabels) - SetYTickCount(integer ticks)
- SetYTickInterval(number set)
- SetYTickInterval(integer set)
- SetYTitleFontSize(integer size)
- SetZ(number setZ)
- Share(Libraries.System.File file)
- Share(text path)
- ShouldCollide(Libraries.Interface.Item2D otherItem)
- Show()
- ShowAllGridLines()
- ShowAllPoints()
- ShowAllTicks()
- ShowAllXGridLines()
- ShowAllYGridLines()
- ShowAnnotations()
- ShowAnnotations(boolean show)
- ShowFactorAnnotations(boolean show)
- ShowGroupBrackets(boolean flag)
- ShowLegend(boolean show)
- ShowLetterCodeAnnotations(boolean show)
- ShowLinearRegression(boolean show)
- ShowMajorGridLines()
- ShowMajorXGridLines()
- ShowMajorYGridLines()
- ShowMinorGridLines()
- ShowMinorXGridLines()
- ShowMinorYGridLines()
- ShowMovableRegressionLine(boolean movable)
- ShowPatterns(boolean show)
- ShowPointAnnotations(boolean show)
- ShowSubChartAreaBorders()
- ShowSubChartAreaBorders(boolean showSubChartAreaBorders)
- ShowSubChartAreaTitles(boolean show)
- ShowSubtitle(boolean show)
- ShowTitle(boolean show)
- ShowVisualHighlight(boolean visualHighlight)
- ShowXAxis(boolean show)
- ShowXAxisTitle(boolean show)
- ShowXLabels(boolean show)
- ShowXTicks(boolean show)
- ShowYAxis(boolean show)
- ShowYAxisTitle(boolean show)
- ShowYLabels(boolean show)
- ShowYTicks(boolean show)
- Simulate(boolean flag)
- SynchronizeNodes()
- SynchronizeTransform()
- TestPoint(Libraries.Compute.Vector2 point)
- UnlockRegressionYIntercepts()
- Update(number seconds)
- UpdateAll(number seconds)
- UpdatePointDescriptions(Libraries.Containers.Array
points) - UpdateTransformAngle()
- UpdateTransformX()
- UpdateTransformY()