Maptitude 2024 GISDK Help

Click here to see this page in full context

Maptitude GISDK Help

GetMapUnits()

Summary

Gets the current map measurement units.

Changes

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

Syntax

units = GetMapUnits(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

A string indicating the current map measurement unit.

Notes

With the "Display" format types, GetMapUnits() returns the corresponding "Display" version that was set up with SetDisplayUnits().

Example

m1 = GetMapUnits("Plural")	// m1 is "Miles"
m2 = GetMapUnits("Singular")	// m2 is "Mile"
m3 = GetMapUnits("Abbreviation")	// m3 is "mi"

Error Codes

Error Type	Meaning
Error	format_type was incorrectly specified

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