MGMapLayerGroup Introduction

MGMapLayerGroup Object

The MGMapLayerGroup object represents a map layer group.

Java Development for Autodesk MapGuide Viewer Plug-In: For Autodesk MapGuide Viewer Plug-In, the Java class MGMapLayerGroup extends java.lang.Object and can be found in the mapguide package, located in the npmapv32.zip file in the Netscape Plugins folder.

Java Development for Autodesk MapGuide Viewer, Java Edition: For Autodesk MapGuide Viewer, Java Edition, MGMapLayerGroup is a Java interface that resides in the com.autodesk.mgjava package, which is located in the mgjava.cab file (for Windows systems only) and the mgjava.jar file (for all platforms).

Methods

addMapLayer	Adds an existing map layer to the group. A map layer can only belong to one group at any time.
collapse	Collapses the list of map layers under a group so that only the group name heading is visible in the legend.
expand	Expands the list of map layers under a group in the legend so that all potentially visible map layers appear under the group name heading.
getLegendLabel	Gets the string used to label the map layer group in the legend.
getMapLayer	Gets the specified map layer from the group.
getMapLayers	Gets an MGCollection object containing all map layers in the group.
getName	Gets the name of the map layer group.
getShowInLegend	Returns boolean value indicating whether or not the map layer group should be displayed in the legend.
getVisibility	Returns a boolean value indicating if the map layers in this group are potentially visible.
isCollapsed	Determines whether the map layer group is collapsed or expanded.
removeMapLayer	Removes a single map layer from the group.
setLegendLabel	Sets the label used by the map layer group in the legend.
setMapLayers	Clears the contents of a map layer group and adds the specified map layers.
setName	Sets name of the map layer group.
setShowInLegend	Sets a flag indicating whether or not the map layer group should be displayed in the legend.
setVisibility	Sets a flag that affects the visibility of all map layers in the group.

Properties

Note that direct access to properties is only available in Autodesk MapGuide Viewer ActiveX Control. In Autodesk MapGuide Viewer Plug-In and Autodesk MapGuide Viewer, Java Edition APIs, get/set methods provide access to an object's properties. For compatibility, the ActiveX Control API supports the same get/set methods as the Autodesk MapGuide Viewer Plug-In and the Autodesk MapGuide Viewer, Java Edition APIs.

Collapsed	Gets the state of the map layer group, telling whether it is collapsed or expanded.
LegendLabel	Gets or sets the legend label used by the map layer group.
MapLayers	Gets or sets an MGCollection containing all the map layers defined in the group.
Name	Gets or sets the name of the map layer group.
ShowInLegend	Specifies whether or not the map layer group should be shown in the legend.
Visibility	Specifies whether or not map layers in the group are potentially visible.