getm

Query properties of axesm-based map

Syntax

mstruct = getm(abm)

propval = getm(obj,propname)

getm("MapProjection")

getm("axes")

getm("units")

Description

mstruct = getm(abm) returns the map projection structure of the axesm-based map abm.

propval = getm(obj,propname) returns the value of the property propname that is stored in the map graphics object obj.

getm("MapProjection") displays a list of available map projections. For each projection, the list includes the class, the English name, and the standard projection identifier.

getm("axes") displays a list of axesm-based map properties by property name. For a full list of axesm-based map property names and valid values, see axesm-Based Map Properties.

getm("units") displays a list of valid length units. For a full list of valid length units, see the unit argument for the validateLengthUnit reference page.

Examples

Query Properties of axesm-Based Map

Create a default axesm-based map, and query a property value.

axesm("mercator")

abm = gca;
getm(abm,"MapParallels")

ans = 
0

Input Arguments

abm — axesm-based map

map created using axesm, worldmap, or usamap

axesm-based map, specified as a map created using the axesm, worldmap, or usamap function.

obj — Map graphics objects

array of graphic objects

Map graphics objects, specified as an array of graphics objects. Each object must be an axesm-based map or a child of an axesm-based map.

propname — Property name

character vector | string scalar

Property name, specified as a character vector or a string scalar. For a full list of axesm-based map property names and valid values, see axesm-Based Map Properties. For a full list of graphic scale property names and valid values, see scaleruler.

Data Types: char | string

Output Arguments

mstruct — Map projection structure

structure

Map projection structure, returned as a structure with fields identical to the properties of an axesm-based map. Examples of map projection structure fields include the projection name, angle unit, origin, aspect, false easting, and false northing. For more information about the properties of axesm-based maps, see axesm-Based Map Properties.

propval — Property value

array

Property value, returned as an array. For a full list of axesm-based map property names and valid values, see axesm-Based Map Properties. For a full list of graphic scale property names and valid values, see scaleruler.

Version History

Introduced before R2006a

R2024a: Default colors values have changed

When you query the map projection structure of an axesm-based map, the default value of the FEdgeColor, GColor, and FontColor fields is 'default'. In previous releases, the default values were RGB triplets.

When you query the FEdgeColor, GColor, or FontColor property of an axesm-based map, the function reports an RGB triplet instead of 'default'.