Main Content

getm

Query properties of axesm-based map

collapse all in page

    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.

    example

    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

    collapse all

    Open Live Script

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

    axesm("mercator")

    Figure contains an axes object. The axes object is empty.

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

    Input Arguments

    collapse all

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

    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.

    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

    collapse all

    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.

    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

    expand all

    See Also

    Functions

    Properties