Libraries.Interface.Layouts.BoxPlotLayout Documentation

This class determines the visual layout for the chart.

Example Code

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Charts.BoxPlotCreator
use Libraries.Interface.Controls.Charts.BoxPlot
use Libraries.Game.Game

class Main is Game
    action Main
        StartGame()
    end

    action CreateGame
        DataFrame frame
        frame:Load("Data/Data.csv")
        BoxPlotCreator creator
        creator:AddColumn(2)
    
        BoxPlot chart = cast(BoxPlot,frame:CreateChart(creator))
        chart:SetPercentageWidth(1)
        chart:SetPercentageHeight(1)
        chart:SetTitle("Sample Title")
        chart:SetXAxisTitle("X-axis Variable")
        chart:SetYAxisTitle("Y-axis Variable")
        Add(chart)
    end
end

Inherits from: Libraries.Language.Object, Libraries.Interface.Layouts.Layout, Libraries.Interface.Layouts.ChartLayout

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.

Parameters

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)

Equals(Libraries.Language.Object object)

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

Parameters

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)

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

Layout(Libraries.Interface.Controls.Control container, Libraries.Containers.Array<Libraries.Interface.Item2D> items, number containerWidth, number containerHeight)

Parameters

LayoutChartContent(Libraries.Interface.Controls.Charts.Chart control, Libraries.Interface.Controls.Control chartAreaContainer)

This action determines the layout of the chart area

Parameters

LayoutHorizontalAxis(Libraries.Interface.Controls.Charts.Chart chart, Libraries.Interface.Controls.Charts.HorizontalAxisPanel horizontalContainer)

Chart layouts do not have a way to determine the ticks of a subclass because charts are very different in style. As such, every chart needs to override this with ticks relevant for its own chart type.

Parameters

LayoutLegend(Libraries.Interface.Controls.Charts.Chart chart, Libraries.Interface.Controls.Charts.Legend legendContainer)

This line is in the chart area. So the placement is less than 0

Parameters

LayoutVerticalAxis(Libraries.Interface.Controls.Charts.Chart chart, Libraries.Interface.Controls.Charts.VerticalAxisPanel verticalContainer)

This way they can be uniformly sized.

Parameters