Libraries.Data.Formats.ScalableVectorGraphics.Rectangle Documentation

The Rectangle class is an implementation of the rectangle shape in the SVG standard. Like other ScalableVectorGraphicsObjects the rectangle class inherits global attributes but it also has its own attributes such as the position, width, and height.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

    // make an svg rectangle
    Rectangle rectangle

    rectangle:SetPosition(50, 50)
    rectangle:SetSize(75,75)
    rectangle:SetFill("red")

Inherits from: Libraries.Language.Object, Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphicsObject

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetAriaDescribedBy()This action will give a aria-describedby attribute to the SVG element.
GetAriaDescription()This action will give a aria-description attribute to the SVG element.
GetAriaLabel()This action will give a aria-label attribute to the SVG element.
GetAriaLabelledBy()This action will give a aria-labelledby attribute to the SVG element.
GetAriaRoleDescription()This action will give a aria-roledescription attribute to the SVG element.
GetCloseTag(text name, boolean container)This is an interal action that allows the ScalableVectorGraphicsObject generate the correct closing tag.
GetColor()This action returns the color of the object.
GetDescription()This action will return the currently set description to a ScalableVectorGraphicsObject.
GetFill()This action returns the fill of the object.
GetHashCode()This action gets the hash code for an object.
GetHeight()This action gets the height of the rectangle along with a unit.
GetID()This action returns the id of the object.
GetPositionX()This action returns the x position of the rectangle with the unit appended.
GetPositionY()This action returns the y position of the rectangle with the unit appended.
GetRole()This action will give a role attribute to the SVG element.
GetStroke()This action returns the stroke of the object.
GetStrokeWidth()This action returns the stroke width of the object.
GetStyle()This action returns the style information of the object.
GetStyleClass()This action will give a class attribute to the SVG element.
GetTabIndex()This action returns the tab index of the object.
GetTitle()This action will return the currently set title of the object.
GetWidth()This action gets the width of the rectangle along with a unit.
GlobalAttributesToText()This is an interal action that allows the ScalableVectorGraphicsObject to write out its global attributes.
IsContainer()This action is used internally by the system to designate whether the SVG element is a single tag or contains more objects within it.
SetAriaDescribedBy(text ariaDescribedBy)This action will give a aria-describedby attribute to the SVG element.
SetAriaDescription(text ariaDescription)This action will give a aria-description attribute to the SVG element.
SetAriaLabel(text ariaLabel)This action will give a aria-label attribute to the SVG element.
SetAriaLabelledBy(text ariaLabelledBy)This action will give a aria-labelledby attribute to the SVG element.
SetAriaRoleDescription(text ariaRoleDescription)This action will give a aria-roledescription attribute to the SVG element.
SetColor(text color)This action will give a color attribute to the SVG element.
SetDescription(text description)This action will give a description to a ScalableVectorGraphicsObject.
SetFill(Libraries.Game.Graphics.Color fill)This action will give a fill attribute to the SVG element.
SetFill(text fill)This action will give a fill attribute to the SVG element.
SetHeight(number height, text unit)This action sets the height of the rectangle along with a unit.
SetHeight(number height)This action sets the height of the rectangle.
SetHorizontalCornerRadius(number rx, text unit)This action sets the corner radius of the rectangle.
SetHorizontalCornerRadius(number rx)This action sets the corner radius of the rectangle.
SetID(text id)This action will give an ID attribute to the SVG element.
SetIsContainer(boolean isContainer)This action is used internally by the system to designate whether the SVG element is a single tag or contains more objects within it.
SetPosition(number x, number y, text unit)This action sets the position of the rectangle.
SetPosition(number x, number y)This action sets the position of the rectangle.
SetPositionX(number x, text unit)This action sets the x position of the rectangle.
SetPositionX(number x)This action sets the x position of the rectangle.
SetPositionY(number y)This action sets the y position of the rectangle.
SetPositionY(number y, text unit)This action sets the y position of the rectangle.
SetRole(text role)This action will give a role attribute to the SVG element.
SetSize(number width, number height)This action sets the width and height of the rectangle.
SetSize(number width, number height, text unit)This action sets the width and height of the rectangle along with a unit.
SetStroke(text stroke)This action will give a stroke attribute to the SVG element.
SetStroke(Libraries.Game.Graphics.Color stroke)This action will give a stroke attribute to the SVG element.
SetStrokeWidth(number strokeWidth)This action sets the width of the stroke of the SVG element.
SetStrokeWidth(number strokeWidth, text unit)This action sets the width of the stroke of the SVG element along with which unit to use.
SetStyle(text style)This action will give a style attribute to the SVG element.
SetStyleClass(text styleClass)This action will give a class attribute to the SVG element.
SetTabIndex(integer tabIndex)This action will give the ScalableVectorGraphicsObject a tab index.
SetTitle(text title)This action will give a title to a ScalableVectorGraphicsObject.
SetVerticalCornerRadius(number ry)This action sets the corner radius of the rectangle.
SetVerticalCornerRadius(number ry, text unit)This action sets the corner radius of the rectangle.
SetWidth(number width, text unit)This action sets the width of the rectangle along with a unit.
SetWidth(number width)This action sets the width of the rectangle.
ToText()This action writes out all of the necessary tags and attributes that make up this ellipse.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

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

Equals(Libraries.Language.Object object)

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

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

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

GetAriaDescribedBy()

This action will give a aria-describedby attribute to the SVG element. This aria-describedby can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaDescribedBy("This is a blue circle with a radius of 5.0")

Return

text:

GetAriaDescription()

This action will give a aria-description attribute to the SVG element. This aria-description can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaDescription("This is a blue circle with a radius of 5.0")

Return

text:

GetAriaLabel()

This action will give a aria-label attribute to the SVG element. This aria-label can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaLabel("My Circle")

Return

text:

GetAriaLabelledBy()

This action will give a aria-labelledby attribute to the SVG element. This aria-labelledby can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaLabelledBy("id")

Return

text:

GetAriaRoleDescription()

This action will give a aria-roledescription attribute to the SVG element. This aria-roledescription can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaRoleDescription("This is a blue circle with a radius of 5.0")

Return

text:

GetCloseTag(text name, boolean container)

This is an interal action that allows the ScalableVectorGraphicsObject generate the correct closing tag.

Parameters

Return

text:

GetColor()

This action returns the color of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetColor("navy")
        output circle:GetColor()

Return

text: the color of the object.

GetDescription()

This action will return the currently set description to a ScalableVectorGraphicsObject.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetDescription("This is my circle and it will be blue")
        text myDescpription = circle:GetDescription()

Return

text: The current text description of the object.

GetFill()

This action returns the fill of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetFill("navy")
        output circle:GetFill()

Return

text: the fill of the object.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetHeight()

This action gets the height of the rectangle along with a unit.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        Text height
        height = rectangle:GetHeight()

Return

text:

GetID()

This action returns the id of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetID("My Circle")
        output circle:GetID()

Return

text: the id of the object.

GetPositionX()

This action returns the x position of the rectangle with the unit appended.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        rectangle rectangle
        output rectangle:GetPositionX()

Return

text: the x position of the rectangle.

GetPositionY()

This action returns the y position of the rectangle with the unit appended.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        rectangle rectangle
        output rectangle:GetPositionY()

Return

text: the y position of the rectangle.

GetRole()

This action will give a role attribute to the SVG element. This role can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetRole("region")

Return

text:

GetStroke()

This action returns the stroke of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStroke("navy")
        output circle:GetStroke()

Return

text: the stroke of the object.

GetStrokeWidth()

This action returns the stroke width of the object. Since lengths can have varying units in SVG the unit will be appended to the returned length

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStrokeWidth(5, "%")
        text strokeWidth = circle:GetStrokeWidth()

Return

text: the stroke width with the unit appended if one was given.

GetStyle()

This action returns the style information of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStyle("fill: skyblue; stroke: navy;")
        output circle:GetStyle()

Return

text: the style information of the object.

GetStyleClass()

This action will give a class attribute to the SVG element. This class can be for gerneral use by a web browser or for when using a styling sheet on the SVG file.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStyleClass("circleClass")

Return

text:

GetTabIndex()

This action returns the tab index of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetTabIndex(5)
        output circle:GetTabIndex()

Return

integer: the tab index of the object.

GetTitle()

This action will return the currently set title of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetTitle("My Circle")
        text myTitle = circle:GetTitle()

Return

text: The current title of the object.

GetWidth()

This action gets the width of the rectangle along with a unit.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        Text width
        width = rectangle:GetWidth()

Return

text:

GlobalAttributesToText()

This is an interal action that allows the ScalableVectorGraphicsObject to write out its global attributes.

Return

text:

IsContainer()

This action is used internally by the system to designate whether the SVG element is a single tag or contains more objects within it.

Return

boolean:

SetAriaDescribedBy(text ariaDescribedBy)

This action will give a aria-describedby attribute to the SVG element. This aria-describedby can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaDescribedBy("This is a blue circle with a radius of 5.0")

Parameters

SetAriaDescription(text ariaDescription)

This action will give a aria-description attribute to the SVG element. This aria-description can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaDescription("This is a blue circle with a radius of 5.0")

Parameters

SetAriaLabel(text ariaLabel)

This action will give a aria-label attribute to the SVG element. This aria-label can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaLabel("My Circle")

Parameters

SetAriaLabelledBy(text ariaLabelledBy)

This action will give a aria-labelledby attribute to the SVG element. This aria-labelledby can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaLabelledBy("id")

Parameters

SetAriaRoleDescription(text ariaRoleDescription)

This action will give a aria-roledescription attribute to the SVG element. This aria-roledescription can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetAriaRoleDescription("This is a blue circle with a radius of 5.0")

Parameters

SetColor(text color)

This action will give a color attribute to the SVG element. This attribute does not directly change an objects color. It provides a color for other attriubtes, such as fill and stroke that may not have a defined color, to inherit a color.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetColor("green")

Parameters

SetDescription(text description)

This action will give a description to a ScalableVectorGraphicsObject. When an object has a non-empty description a description tag will be generated when the whole object is written out. A description in SVG functions similarly to the description of an image in HTML.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetDescription("This is my circle and it will be blue")

Parameters

SetFill(Libraries.Game.Graphics.Color fill)

This action will give a fill attribute to the SVG element. This attribute may do different things depending on the type of SVG element. For shapes and text it will define the color used to paint the object

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        use Libraries.Game.Graphics.Color

        Color blue
        blue:SetColor(0, 0, 1, 1)

        Circle circle
        circle:SetFill(blue)

Parameters

SetFill(text fill)

This action will give a fill attribute to the SVG element. This attribute may do different things depending on the type of SVG element. For shapes and text it will define the color used to paint the object

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetFill("green")

Parameters

SetHeight(number height, text unit)

This action sets the height of the rectangle along with a unit.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetHeight(50,"%")

Parameters

SetHeight(number height)

This action sets the height of the rectangle.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetHeight(75)

Parameters

SetHorizontalCornerRadius(number rx, text unit)

This action sets the corner radius of the rectangle. This will give the rectangle rounded edges.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetHorizontalCornerRadius(15, "%")

Parameters

SetHorizontalCornerRadius(number rx)

This action sets the corner radius of the rectangle. This will give the rectangle rounded edges.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetHorizontalCornerRadius(15)

Parameters

SetID(text id)

This action will give an ID attribute to the SVG element. This is useful in contexts where you need to reference an SVG element by a name such as when using a styling sheet with the SVG file.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetID("circle1")

Parameters

SetIsContainer(boolean isContainer)

This action is used internally by the system to designate whether the SVG element is a single tag or contains more objects within it.

Parameters

SetPosition(number x, number y, text unit)

This action sets the position of the rectangle. Note that rectangles in SVG are positioned based on the top left vertex.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetPosition(15, 15, "%")

Parameters

SetPosition(number x, number y)

This action sets the position of the rectangle. Note that rectangles in SVG are positioned based on the top left vertex.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetPosition(75,75)

Parameters

SetPositionX(number x, text unit)

This action sets the x position of the rectangle. Note that rectangles in SVG are positioned based on the top left vertex.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetPositionX(75, "%")

Parameters

SetPositionX(number x)

This action sets the x position of the rectangle. Note that rectangles in SVG are positioned based on the top left vertex.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetXPosition(75)

Parameters

SetPositionY(number y)

This action sets the y position of the rectangle. Note that rectangles in SVG are positioned based on the top left vertex.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetPositionY(75)

Parameters

SetPositionY(number y, text unit)

This action sets the y position of the rectangle. Note that rectangles in SVG are positioned based on the top left vertex.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetPositionY(75, "%")

Parameters

SetRole(text role)

This action will give a role attribute to the SVG element. This role can be for general use by a web browser.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetRole("region")

Parameters

SetSize(number width, number height)

This action sets the width and height of the rectangle.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetSize(75,75)

Parameters

SetSize(number width, number height, text unit)

This action sets the width and height of the rectangle along with a unit.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetSize(75,75)

Parameters

SetStroke(text stroke)

This action will give a stroke attribute to the SVG element. This attribute defines the color used to paint the outline of a shape. For shapes like lines that have no fill a stroke must be set so that the line will be visible.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStroke("navy")

Parameters

SetStroke(Libraries.Game.Graphics.Color stroke)

This action will give a stroke attribute to the SVG element. This attribute defines the color used to paint the outline of a shape. For shapes like lines that have no fill a stroke must be set so that the line will be visible.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all
        
        use Libraries.Game.Graphics.Color

        Color blue
        blue:SetColor(0, 0, 1, 1)

        Circle circle
        circle:SetStroke(blue)

Parameters

SetStrokeWidth(number strokeWidth)

This action sets the width of the stroke of the SVG element. Shapes with an outline have a stroke width.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStrokeWidth(5)

Parameters

SetStrokeWidth(number strokeWidth, text unit)

This action sets the width of the stroke of the SVG element along with which unit to use. Shapes with an outline have a stroke width. In SVG, units are defined by unit identifiers giving by the CSS specification along with percentages.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStrokeWidth(5, "%")

Parameters

SetStyle(text style)

This action will give a style attribute to the SVG element. This attribute also for embedding CSS declarations inline with the SVG element. Use of this attribute requires knowledge of CSS.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStyle("fill: skyblue; stroke: navy;")

Parameters

SetStyleClass(text styleClass)

This action will give a class attribute to the SVG element. This class can be for gerneral use by a web browser or for when using a styling sheet on the SVG file.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetStyleClass("circleClass")

Parameters

SetTabIndex(integer tabIndex)

This action will give the ScalableVectorGraphicsObject a tab index. A non-negative tab index attribute will allow the element to be focusable and it can define the relative order for sequential navigation with the tab key. If two objects have the same tab index then whichever was added first is first in the naviagation. Default is 0 which means the item is focusable.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle1
        Circle circle2
        Circle circle3
        circle1:SetTabIndex(1)
        circle2:SetTabIndex(2)
        circle3:SetTabIndex(3)

Parameters

SetTitle(text title)

This action will give a title to a ScalableVectorGraphicsObject. When an object has a non-empty title a title tag will be generated when the whole object is written out which will show the title as a popup box when hovering over the object in the final SVG file.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Circle circle
        circle:SetTitle("My Circle")

Parameters

SetVerticalCornerRadius(number ry)

This action sets the corner radius of the rectangle. This will give the rectangle rounded edges.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetVerticalCornerRadius(15)

Parameters

SetVerticalCornerRadius(number ry, text unit)

This action sets the corner radius of the rectangle. This will give the rectangle rounded edges.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetVerticalCornerRadius(15, "%")

Parameters

SetWidth(number width, text unit)

This action sets the width of the rectangle along with a unit.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetWidth(50,"%")

Parameters

SetWidth(number width)

This action sets the width of the rectangle.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Rectangle rectangle
        rectangle:SetWidth(75)

Parameters

ToText()

This action writes out all of the necessary tags and attributes that make up this ellipse. This action will be called automatically by the parent ScalableVectorGraphics, as such this action does not need to be used directly by the user.

Return

text: the formatted string of all tags and attributes for this shape