Libraries.Interface.Controls.Charts.MapReader Documentation

This class is used to reads a csv that describes the map region boundaries. This reader also finds the min/max for the map. It stores the result in a text array of the region names, and a hashtable with an entry for each region. The delimiters can be set manually for the csv being read in. An example of the csv accepted with the default delimiters: e.g. ID,Name,Coordinates NV,Nevada,956 153|-3 -1;0 2;

Example Code

use Libraries.Interface.Controls.Charts.MapReader

MapReader mapReader
mapReader:Read(mapDataFilePath)

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
text xyDelimitercsv separator
text boundaryDelimiterseparates (x,y) pairs
text vertexDelimiterseparates x and y coords
text entryDelimiterparse options

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

GetMaxXValue()

Split()

Return

number:

GetMaxYValue()

should be size 2

Return

number:

GetMinXValue()

Split()

Return

number:

GetMinYValue()

parse coords

Return

number:

GetRegionNames()

end GetRegionTable()

Return

Libraries.Containers.Array:

GetRegionTable()

csv separator

Return

Libraries.Containers.HashTable:

Read(text filePath)

once this is called successfully, can GetRegionTable or GetRegionsArray

Parameters

  • text filePath