wmpolygon

(To be removed) Display geographic polygon on web map

The wmpolygon function will be removed in a future release. Use a geographic axes object, a geopolyshape object, and the geoplot function instead. For information on updating your code, see Version History.

Syntax

wmpolygon(lat,lon)

wmpolygon(P)

wmpolygon(wm,___)

wmpolygon(___,Name,Value)

h = wmpolygon(___)

Description

wmpolygon(lat,lon) displays the polygon overlay defined by the vertices in lat and lon on the current web map. If there is no current web map, wmpolygon creates one. wmpolygon centers and scales the map so that all the vector overlays displayed in the web map are visible.

wmpolygon(P) displays a polygon overlay based on the vector geographic features stored in P. The overlay contains one polygon feature for each element of P.

wmpolygon(wm,___) displays the overlay in the web map specified by the web map handle, wm.

wmpolygon(___,Name,Value) specifies name-value pairs that set additional display properties.

h = wmpolygon(___) returns a handle to the overlay.

Examples

Display Polygon on Web Map

Load the latitude and longitude coordinates of world coastlines from a MAT file. Display the coordinates using a polygon on a web map.

load coastlines
wmpolygon(coastlat,coastlon)

Input Arguments

lat — Latitude vertices

matrix in the range [-90, 90]

Latitude vertices, specified as matrix in the range [-90, 90].

Data Types: single | double

lon — Longitude vertices

matrix

Longitude of vertices, specified as a matrix.

Data Types: single | double

P — Geographic features

geospatial table | geoshape vector

Geographic features, specified as one of the following:

• A geospatial table containing geopolyshape objects. For more information about geospatial tables, see Create Geospatial Tables.

• A geoshape vector with polygon geometry.

wm — Web map

handle to a web map

Web map, specified as a handle to a web map.¹

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: wmpolygon(lat,lon,'Autofit',true)

Autofit — Overlay visibility

true (default) | false

Overlay visibility, specified as the comma-separated pair consisting of 'Autofit' and the scalar logical or numeric value true (1) or false (0).

• If true, wmpolygon adjusts the spatial extent of the map to ensure that all the vector overlays on the map are visible.

• If false, wmpolygon does not adjust the spatial extent of the map when this vector layer is added to the map.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

Description — Description of feature

empty character vector (default) | character vector | cell array of character vectors | scalar structure

Description of feature, specified as the comma-separated pair consisting of 'Description' and a character vector, cell array of character vectors, or a scalar structure.

• If you specify a character vector, the text defines the content displayed in the description balloon, which appears when you click the feature in the web map. Description elements can be either plain text or marked up with HTML markup.

• If you specify a cell array, it must be either a scalar or the same length as P, and specifies the description for each polygon.

• If the value is a structure (attribute specification), wmpolygon displays the attribute fields of P in the balloon, modified according to the specification.

Data Types: char | struct | cell

OverlayName — Name of overlay layer

'Polygon Overlay N', (default) | character vector

Name of overlay layer, specified as the comma-separated pair consisting of 'OverlayName' and a character vector. wmpolygon inserts the name in the Layer Manager under the "Overlays" item. The Layer Manager is the tool that appears on the right side of the web map. The default name is 'Polygon Overlay N' where N is the number assigned to this overlay.

Data Types: char

FeatureName — Name of feature

'OverlayName: Line K' (default) | character vector | cell array of character vectors

Name of feature, specified as the comma-separated pair consisting of 'FeatureName' and character vector or cell array of character vectors. The name appears in the balloon when you click the feature in the web map. The default value is 'OverlayName: Polygon K', where OverlayName is the name of the overlay and K is the number assigned to the particular polygon.

• If the value is a character vector, it applies to all features.

• If the value is a cell array of character vectors, it must be either a scalar or the same length as P.

Data Types: char | cell

FaceColor — Color of polygon faces

'black' (default) | color name | RGB triplet | cell array of color names | string vector of color names | matrix of RGB triplets | 'none'

Color of polygon faces, specified as the comma-separated pair consisting of 'FaceColor' and one of these options.

• A color name such as 'red' or a short name such as 'r'.

• An RGB triplet, which is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1]; for example, [0.4 0.6 0.7].

• A cell array of color names such as {'red','green','blue'} or {'r','g','b'}.

• A string vector of color names such as ["red" "green" "blue"] or ["r" "g" "b"].

• A matrix of RGB triplets, which is a three-column matrix in which each row is an RGB triplet.

The way you specify the color depends on the desired color scheme.

• To apply the same face color to all polygons in P, specify a single color name or RGB triplet.

• To apply a different color to each polygon in P, specify a cell array of color names, a string vector of color names, or a matrix of RGB triplets. The number of colors and RGB triplets must match the length of P.

• To create polygons with no fill, specify 'none'.

This table contains the color names and equivalent RGB triplets for some common colors.

Color Name	Short Name	RGB Triplet	Appearance
"red"	"r"	[1 0 0]
"green"	"g"	[0 1 0]
"blue"	"b"	[0 0 1]
"cyan"	"c"	[0 1 1]
"magenta"	"m"	[1 0 1]
"yellow"	"y"	[1 1 0]
"black"	"k"	[0 0 0]
"white"	"w"	[1 1 1]

Data Types: char | string | cell | double

FaceAlpha — Transparency of polygon faces

1 (default) | numeric scalar or vector in the range [0, 1]

Transparency of polygon faces, specified as the comma-separated pair consisting of 'FaceAlpha' and a numeric scalar or vector in the range [0, 1]. The default value, 1, means that the polygon is fully opaque.

• If the value is a scalar, it applies to all polygon faces.

• If the value is a vector, it must be the same length as P.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

EdgeColor — Color of polygon edges

'none' (default) | color name | RGB triplet | cell array of color names | string vector of color names | matrix of RGB triplets | 'none'

Color of polygon edges, specified as the comma-separated pair consisting of 'EdgeColor' and one of these options.

• A color name such as 'red' or a short name such as 'r'.

• An RGB triplet, which is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1]; for example, [0.4 0.6 0.7].

• A cell array of color names such as {'red','green','blue'} or {'r','g','b'}.

• A string vector of color names such as ["red" "green" "blue"] or ["r" "g" "b"].

• A matrix of RGB triplets, which is a three-column matrix in which each row is an RGB triplet.

The way you specify the color depends on the desired color scheme.

• To apply the same edge color to all polygons in P, specify a single color name or RGB triplet.

• To apply a different edge color to each polygon in P, specify a cell array of color names, a string vector of color names, or a matrix of RGB triplets. The number of colors and RGB triplets must match the length of P.

• To create polygons with no edge color, specify 'none'.

This table contains the color names and equivalent RGB triplets for some common colors.

Color Name	Short Name	RGB Triplet	Appearance
"red"	"r"	[1 0 0]
"green"	"g"	[0 1 0]
"blue"	"b"	[0 0 1]
"cyan"	"c"	[0 1 1]
"magenta"	"m"	[1 0 1]
"yellow"	"y"	[1 1 0]
"black"	"k"	[0 0 0]
"white"	"w"	[1 1 1]

Data Types: char | string | cell | double

EdgeAlpha — Transparency of polygon edges

1 (default) | numeric scalar or vector in the range [0, 1]

Transparency of polygon edges, specified the comma-separated pair consisting of 'EdgeAlpha' and as a numeric scalar or vector in the range [0, 1].

• If the value is a scalar, it applies to all polygon faces.

• If the value is a vector, it must be the same length as P.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

LineWidth — Width of polygon edges

1 (default) | positive numeric scalar or vector

Width of polygon edges, specified as the comma-separated pair consisting of 'LineWidth' and a positive numeric scalar or vector.

• If the value is a scalar, it applies to all polygon faces.

• If the value is a vector, it must be the same length as P.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Output Arguments

h — Polygon overlay

handle to polygon overlay

Polygon overlay, returned as a handle to the polygon overlay.

Tips

• When you move the cursor over the polygons you define on an image and click, wmpolygon displays a description balloon and disables panning. If you move the cursor off the polygon, you can still click and pan the image. You can also use the arrow keys to pan the image.

Version History

Introduced in R2016a

R2025a: To be removed

Web maps will be removed in a future release, including the wmpolygon function. Use a geographic axes object, a geopolyshape object, and the geoplot function instead.

Unlike web maps, geographic axes enable you to:

• Display data using additional plot types, including density plots and bubble charts.

• Customize your maps using MATLAB^® graphics functions.

• Build apps using App Designer.

This table shows some typical uses of the wmpolygon function and how to update your code to use a geographic axes object, a geopolyshape object, and the geoplot function.

To Be Removed	Recommended
Display a polygon using the specified latitude and longitude coordinates. wmpolygon(lat,lon)	Create a polygon shape from the latitude and longitude coordinates. Use the polygon shape as input to geoplot. pshape = geopolyshape(lat,lon); geoplot(pshape)
Display a polygon using the polygon shapes stored in the geospatial table GT. wmpolygon(GT)	Display a polygon using the polygon shapes stored in the geospatial table GT. geoplot(GT)
Display a polygon using the coordinates stored in the geoshape vector P. wmpolygon(P)	Extract the latitude and longitude coordinates from the geoshape vector. Create a polygon shape from the coordinates. Then, use the polygon shape as input to geoplot. lat = P.Latitude; lon = P.Longitude; pshape = geopolyshape(lat,lon); geoplot(pshape)
Specify the polygon face color by using the FaceColor name-value argument. wmpolygon(GT,FaceColor=colorValue)	Specify the polygon face color by using the FaceColor name-value argument. The function uses the same color for each polygon face. geoplot(GT,FaceColor=colorValue) To use a different face color for each polygon, display the polygons using a loop. This code shows how to display each polygon in a geospatial table GT using the colors in the vector of strings colorValue. geobasemap streets-light hold on for k = 1:height(GT) row = GT(k,:); geoplot(row,FaceColor=colorValue(k)) end
Specify the polygon face transparency by using the FaceAlpha name-value argument. wmpolygon(GT,FaceAlpha=alphaValue)	Specify the polygon face transparency by using the FaceAlpha name-value argument. The function uses the same transparency for each polygon face. geoplot(GT,FaceAlpha=alphaValue)
Specify the polygon edge color by using the EdgeColor name-value argument. wmpolygon(GT,EdgeColor=colorValue)	Specify the polygon edge color by using the EdgeColor name-value argument. The function uses the same color for each polygon edge. geoplot(GT,EdgeColor=colorValue)
Specify the polygon edge transparency by using the EdgeAlpha name-value argument. wmpolygon(GT,EdgeAlpha=alphaValue)	Specify the polygon edge transparency by using the EdgeAlpha name-value argument. The function uses the same transparency for each polygon edge. geoplot(GT,EdgeAlpha=alphaValue)
Specify the width of the polygon edges by using the LineWidth name-value argument. wmline(GT,LineWidth=widthValue)	Specify the width of the polygon edges by using the LineWidth name-value argument. The function uses the same width for each polygon edge. geoplot(GT,LineWidth=widthValue)
Specify information about the feature, for use in information balloons, by using the FeatureName and Description name-value arguments. wmline(GT,FeatureName=fn,Description=d)	Display information about the icon data by using custom data tips. For an example that shows how to create custom data tips, see Add Data Tips to Point, Line, and Polygon Shapes.

When you specify polygon data as input to the geoplot function, the function creates a Polygon object. For information about the properties of Polygon objects, see Polygon Properties.

To display multiple data sets using the same geographic axes object, set the hold state to on by using the hold function.

For more information about migrating your web maps to geographic axes, see Web Map Migration Strategies.

R2021b: Display data from geospatial tables

The wmpolygon function accepts geospatial tables as input.