> For the complete documentation index, see [llms.txt](https://docs.gridmate.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gridmate.io/package-reference/components-library/gm-map-list.md). # GM - Map List (gmpkg:mapListLWC) ## **Documentation** **GM - Map List** component enables users to conveniently map multiple records for any object (Standard or Custom). This component offers a unique blend of map view and list view, facilitating record filtering and action-taking capabilities. **Use case:** Display list of Accounts on Google Maps and filter Accounts by Billing Country. See [GM - Map List](/product-tour/map-list.md). ## **Specification** {% hint style="info" %} The **GM - Map List** component requires either a street set of fields (Street, City, Postal Code, State, Country) or a geolocation (Latitude, Longitude) to map a given object. {% endhint %} {% hint style="warning" %} If the map provider is OSM only geolocations (Latitude, Longitude) are supported. {% endhint %}
PropertyTypeDescription
Map ProviderStringThe map provider: google | osm. The default value is osm.
Object Name *StringThe API name of the object to map. Don’t forget __c for custom objects.
Custom LabelStringSet a specific label for the component.
FilterStringJSON string to define filter criteria. Don’t forget __c for custom fields. See GM - RelatedList Grid filter property for more details.
Row LimitIntegerThe maximum number of records to fetch. The default value is 5000.
Street FieldStringThe API name of the street field. Ex BillingStreet.
City FieldStringThe API name of the city field. Ex BillingCity.
Postal Code FieldStringThe API name of the postal code field. Ex BillingPostalCode.
State FieldStringThe API name of the state field. Ex BillingState.
Country FieldStringThe API name of the country field. Ex BillingCountry.
Latitude FieldStringThe API name of the latitude field. Ex BillingLatitude.
Longitude FieldStringThe API name of the longitude field. Ex BillingLongitude.
Title Field *StringThe field displayed as the title of each record. Records are sorted by this field.
Popover FieldsStringThe field displayed as the record description and in the marker popover. When empty, the Detail Fields are used for the popover.
Detail FieldsString',' separated list of fields to display in the record details.
Search FieldsString',' separated list of fields used by the search box.
Enable FilteringBooleanCheck this option to allow the end-user to filter the records.
Marker IconStringThe icon used for the map markers. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/
List IconStringThe icon used for the items of the list.
Show BorderBooleanCheck this option to display a border around the component.
Map HeightIntegerThe height of the map. The default value is 750.
Marker ColoringStringJSON configuration to define the marker colors and the corresponding conditions.
Search AroundStringJSON configuration to search records around a location. See Map List Search Around.
ActionsStringJSON string to initialize the list of available actions. See the actions configuration example.
Record ActionsStringJSON string to initialize the list of available record actions.
Show ClustersBooleanCheck this option to group nearby markers into clusters. See Map List Marker Clusters.
## **API Reference** {% tabs fullWidth="true" %} {% tab title="mapListLWC.js-meta.xml" %} ```xml 65.0 GM - Map List true lightning__RecordPage lightning__AppPage lightning__HomePage lightningCommunity__Page lightningCommunity__Default ``` {% endtab %} {% endtabs %}