Libraries.Interface.Controls.Charts.PatternPalette Documentation

Inherits from: Libraries.Language.Object

Actions Documentation

BuildPalette()

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

GetPattern(integer index)

This action returns the distance between the beginning of a pattern "tile" and the beginning of the next "tile". Patterns are rendered as tiled squares that are repeated across the surface of the chart element. This value is measured in pixels, not including any scaling performed by interface scaling. The default value is 12 pixels.

Parameters

  • integer index

Return

integer: The number of pixels between each tile of any pattern.

GetPatternDistanceFromPalette(integer index)

This action returns the distance between the beginning of a pattern "tile" and the beginning of the next "tile". Patterns are rendered as tiled squares that are repeated across the surface of the chart element. This value is measured in pixels, not including any scaling performed by interface scaling. The default value is 12 pixels.

Parameters

  • integer index

Return

number: The number of pixels between each tile of any pattern.