Maptitude GISDK Help

SetDisplayUnits()

Summary

Set the display names for units, to be used in drop-down lists and legends.

 

Changes

Added to Version 2016.

 

Syntax

SetDisplayUnits(array mapping)

 

Argument Contents
mapping An array of unit names in your language, where each element is a two-element array in the form {UnitName, {Singular, Plural, Abbrev}}

 

Element Type Contents
1 String The Caliper unit name (in singular US English), e.g., "Meter"
2 Array Strings containing the desired display name in singular form (e.g. "Metre"), plural form (e.g. "Metres"), and abbreviated (e.g. "m")

Notes

Example

SetDisplayUnits({{"Meter", {"Metre", "Metres", "m"}},{"Kilometer", {"Kilometre",

"Kilometres", "km"}}})

SetMapUnits("Kilometers") // SetMapUnits takes US unit names

x = GetMapUnits("display plural") // returns "Kilometres"

 

Error Codes

Error Type Meaning
Error The specification array is invalid

 

See Also

Function Summary
GetAreaUnitNames() Gets a list of the available area measurement units
GetAreaUnits() Gets the current area measurement units
GetMapUnitNames() Gets a list of the available map measurement units
GetMapUnits() Gets the current map measurement units
GetPaperUnitNames() Gets a list of the available paper measurement units
GetPaperUnits() Gets the current paper measurement unit
SetAreaUnits() Sets the current area measurement units
SetMapUnits() Sets the current map measurement units
SetPaperUnits() Sets the current paper measurement unit

 

 

©2025 Caliper Corporation www.caliper.com