Libraries.Interface.Controls.Charts.ChartOptions Documentation

This class represents the default options any chart will use when displaying information in a chart. These options can be overriden on a per chart basis, but this provides a way to manage defaults across the board.

Example Code

use Libraries.Controls.Charts.ChartOptions

    ChartOptions options
    Color color = options:GetBarColor()
    output "We have obtained the default bar color on the system

Inherits from: Libraries.Language.Object

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.
GetBarColor()This action obtains the default bar color on the system.
GetColorFromPalette(integer index)This action obtains the default bar color on the system.
GetHashCode()This action gets the hash code for an object.
GetSelectionColor()This action obtains the default bar color on the system.
GetTickDigits()This obtains how many significant digits are used when representing ticks.
SetBarColor(Libraries.Game.Graphics.Color barColor)This action sets the default color for all charts with bars on the system.
SetPalette(Libraries.Containers.Array<Libraries.Game.Graphics.Color> colorPalette)Default colors will be filled with a 10-color color-blind-friendly palette See the website below for more information https://analyticsdemystified.
SetPaletteToGrayScale()This action uses the weighted RBG grayscale method based on the wavelength GRAYSCALE = 0.
SetSelectionColor(Libraries.Game.Graphics.Color selectionColor)This action sets the default selection color for all charts with bars on the system.
SetTickDigits(integer tickDigits)This changes how many significant digits are used when representing ticks.

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

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(

Parameters

Return

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

GetBarColor()

This action obtains the default bar color on the system. It is Navy Blue by default.

Return

Libraries.Game.Graphics.Color: returns the default bar color, which is Navy Blue unless change

GetColorFromPalette(integer index)

This action obtains the default bar color on the system. It is Navy Blue by default.

Parameters

Return

Libraries.Game.Graphics.Color: returns the default bar color, which is Navy Blue unless change

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.

GetSelectionColor()

This action obtains the default bar color on the system. It is light Blue by default.

Return

Libraries.Game.Graphics.Color: returns the default bar color, which is light Blue unless change

GetTickDigits()

This obtains how many significant digits are used when representing ticks.

Return

integer: the number of significant digits to use for tic

SetBarColor(Libraries.Game.Graphics.Color barColor)

This action sets the default color for all charts with bars on the system. If a chart is already created, changing this does not necessarily change its defaults, as these are set when graphics are first loaded.

Parameters

SetPalette(Libraries.Containers.Array<Libraries.Game.Graphics.Color> colorPalette)

Default colors will be filled with a 10-color color-blind-friendly palette See the website below for more information https://analyticsdemystified.com/excel-tips/data-visualization-that-is-color-blind-friendly-excel-200

Parameters

SetPaletteToGrayScale()

This action uses the weighted RBG grayscale method based on the wavelength GRAYSCALE = 0.299R + 0.587G + 0.11

SetSelectionColor(Libraries.Game.Graphics.Color selectionColor)

This action sets the default selection color for all charts with bars on the system. If a chart is already created, changing this does not necessarily change its defaults, as these are set when graphics are first loaded.

Parameters

SetTickDigits(integer tickDigits)

This changes how many significant digits are used when representing ticks.

Parameters