Libraries.Interface.Layouts.BarChartLayout Documentation

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

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.
GetHashCode()This action gets the hash code for an object.
Layout(Libraries.Interface.Controls.Control container, Libraries.Containers.Array<Libraries.Interface.Item2D> items, number containerWidth, number containerHeight)
LayoutChartContent(Libraries.Interface.Controls.Charts.Chart control, Libraries.Interface.Controls.Control chartAreaContainer)This action will calculate the size and placement of the elements (bars) within the chart based on the size of the display screen.
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.
LayoutLegend(Libraries.Interface.Controls.Charts.Chart chart, Libraries.Interface.Controls.Charts.Legend legendContainer)This line is in the chart area.
LayoutVerticalAxis(Libraries.Interface.Controls.Charts.Chart chart, Libraries.Interface.Controls.Charts.VerticalAxisPanel verticalContainer)Layout the sub chart areas

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.

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.

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 will calculate the size and placement of the elements (bars) within the chart based on the size of the display screen.

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)

Layout the sub chart areas

Parameters