Maptitude GISDK Help

GetAreaUnits()

Summary

Gets the current area measurement units.

 

Changes

Added to Version 2018.

 

Syntax

units = GetAreaUnits(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 area measurement unit.

 

Notes

Example

m1 = GetAreaUnits("Plural")

// m1 is "Square Miles"

m2 = GetAreaUnits("Singular")

// m2 is "Square Mile"

m3 = GetAreaUnits("Abbreviation")

// m3 is "sq 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

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