Maptitude GISDK Help

GetMapUnitNames()

Summary

Gets a list of the available map measurement units.

 

Changes

In Version 2018 added the format types "Display Abbreviation", "Display Singular", and "Display Plural".

 

Syntax

map_units = GetMapUnitNames(string format_type)

 

Argument Contents
format_type Format of the measurement unit: "Abbrev", "Singular", "Plural, "Display Abbrev", "Display Singular", or "Display Plural" . If null, Plural is the default.

 

Returns

An array of strings listing available map measurement units.

 

Notes

Example

m1 = GetMapUnitNames("Plural") // m1 is {"Miles", "Kilometers", ...}

m2 = GetMapUnitNames("Singular") // m2 is {"Mile", "Kilometer", ...}

m3 = GetMapUnitNames("Abbreviation") // m3 is {"mi", "km", ...}

 

Error Codes

Error Type Meaning
Error format_type is incorrectly specified

 

See Also

Function Summary
GetAreaUnitNames() Gets a list of the available area measurement units
GetAreaUnits() Gets the current area 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
SetDisplayUnits() Set the display names for units, to be used in drop-down lists and legends
SetMapUnits() Sets the current map measurement units
SetPaperUnits() Sets the current paper measurement unit

 

 

©2025 Caliper Corporation www.caliper.com