Libraries.Data.Formats.ScalableVectorGraphics.Label

The Label class is an implementation of text in the SVG standard. Like other ScalableVectorGraphicsObjects the Label class inherits global attributes but it also has its own attributes.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

    // make text
    Label label

    label:SetPosition(50, 50)
    label:SetText("words words words")
    label:SetTextAnchor("middle")
    label:SetFontSize("12pt")

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)

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)

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")

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")

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")

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")

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")

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

This action returns the color of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

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

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()

This action returns the fill of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

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

This action returns the current font-family to the list of fonts give (can list multiple with comma-delimited list).

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetFontFamily("Arial")
        myLabel:SetFontFamily("Arial, Halvetica, sans-serif")

        output myLabel:GetFontSize()

This action returns the current font size with the unit appended.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetFontSize("12pt")

        output myLabel:GetFontSize()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

This action returns the shift the text on the x axis from its position with the unit appended.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:GetHorizontalShift(12)

        output myLabel:GetHorizontalShift()

This action returns the id of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

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

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")

This action returns how much each individual glyph of the text is being rotated.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetRotation(270)

        output myLabel:GetRotation()

This action returns the stroke of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

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

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()

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()

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")

This action returns the tab index of the object.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

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

This action returns the text that this object would show.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetText("Words Words and more words")

        output myLabel:GetText()

This action returns where the text anchor is set.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:GetTextAnchor("middle")

        output myLabel:GetTextAnchor()

This action returns the width that the text of the label will be scaled to fit with the unit appended.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetTextLength(50)

        output myLabel:GetTextLength()

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()

This action returns the current transform applied on the element

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetTransfrom("rotate(270,100,100)")

        output myLabel:GetTransform()

This action returns the shift the text on the y axis from its position with the unit appended.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:GetVerticalShift(12)

        output myLabel:GetVerticalShift()

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

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

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")

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")

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")

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")

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")

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")

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")

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)

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")

This action sets the current font-family to the list of fonts give (can list multiple with comma-delimited list).

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetFontFamily("Arial")
        myLabel:SetFontFamily("Arial, Halvetica, sans-serif")

        output myLabel:GetFontSize()

This action sets the current font size with the unit appended.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetFontSize("12pt")

        output myLabel:GetFontSize()

This action sets how much to shift the text on the x axis from its position.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetHorizontalShift(50, "%")

This action sets how much to shift the text on the x axis from its position.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetHorizontalShift(12)

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")

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

This action sets the position of the label. Note that text in SVG is positioned based where the text anchor is.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetPosition(50,50, "em")

This action sets the position of the label. Note that text in SVG is positioned based where the text anchor is.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetPosition(60,60)

This action sets the x position of the label. Note that text in SVG is positioned based where the text anchor is.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetPositionX(12,"em")

This action sets the x position of the label. Note that text in SVG is positioned based where the text anchor is.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetPositionX(60)

This action sets the y position of the label. Note that text in SVG is positioned based where the text anchor is.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetPositionY(60)

This action sets the y position of the label. Note that text in SVG is positioned based where the text anchor is.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetPositionY(12,"em")

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")

This action sets how much to rotate each individual glyph of the text.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetRotation(270)

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")

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)

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)

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, "%")

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;")

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")

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)

This action sets the text that this element will render.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetText("Words Words and more words")

This action sets where the text anchor is. The text anchor affects how a text chunk is aligned to the point that is the label's position. Possible values are start, middle, and end. By default a label will use start.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetTextAnchor("middle")

This action sets the width that the text of the label will be scaled to fit.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetTextLength(10,"%")

This action sets the width that the text of the label will be scaled to fit.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetTextLength(50)

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")

This action sets a transform on the current element.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetTransform("rotate(270,100,100)")

This action sets how much to shift the text on the y axis from its position.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetVerticalShift(50, "%")

This action sets how much to shift the text on the y axis from its position.

Example Code

Libraries.Data.Formats.ScalableVectorGraphics.all

        Label myLabel
        myLabel:SetVerticalShift(12)

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