| Maptitude GISDK Help |
Gets a list of the available area measurement units.
Added to Version 2018.
area_units = GetAreaUnitNames(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. |
An array of strings listing available area measurement units.
With the "Display" format types, GetMapUnitNames() returns the corresponding "Display" version that was set up with SetDisplayUnits().
m1 = GetAreaUnitNames("Plural") // m1 is {"Square Miles", "Square Kilometers", ...}
m2 = GetAreaUnitNames("Singular") // m2 is {"Square Mile", "Square Kilometer", ...}
m3 = GetAreaUnitNames("Abbreviation") // m3 is {"sq mi", "sq km", ...}
| Error Type | Meaning |
|---|---|
| Error | format_type is incorrectly specified |
| Function | Summary |
|---|---|
| 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 |
| 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 |