For the complete documentation index, see llms.txt. This page is also available as Markdown.

AX - Map

Overview

AX - Map is a Lightning App Builder component that displays your Salesforce records as interactive location markers on a map on record pages, app pages, and home pages.

Use it to visualize any records with location data—whether stored as addresses or latitude/longitude coordinates. Users can click markers to view record details, search and filter locations, and navigate directly to records on the map.

Perfect for territory planning, customer proximity views, asset tracking, service areas, or any scenario where geographic context helps users understand their data.

Getting Started

Use this simple tutorial to learn the basics of the Map component and start building your use cases.

spinner

Key features

  • Data Integration: Retrieves records from any Salesforce object as map markers.

  • Flexible Locations: Uses addresses or coordinates for marker placement.

  • Interactivity: Supports clickable markers, filters, search, and restricted map controls.

  • Customization: Dynamic titles, descriptions, and styled headers.

  • Dynamic Bindings: Leverages {{Record.FieldApiName}} for context-aware displays.

  • Visual Options: Card-style display and UI control toggles for tailored UX.

Component Comparison

Use Cases

  • Account Page: Map related Contacts, offices, or site visits.

  • Opportunity Page: Visualize store or partner locations for deals.

  • Custom Object Page: Display service locations, delivery points, or project sites.

  • Sales Territory Dashboard: Show active Accounts or Leads by region with filters.

  • Service Operations Overview: Plot technician routes or case locations.

  • Event Planning View: Map event venues or marketing zones.


Configuration

Add the Map component to a Lightning Record Page in App Builder and configure via the Properties Panel.

Properties

Label
Type
Default
Required
Description

Object Api Name

String

API name of the Salesforce object used to retrieve records displayed as map markers. Examples: Account, Lead, Custom_Object__c.

Filter

String

SOQL WHERE clause used to filter which records are shown on the map. Example: Status = 'Active' or Region__c = 'West'.

Order By

String

Field API name used to sort the records before display. Example: Name or LastModifiedDate.

Maximum Number of Records

Integer

The maximum number of records to retrieve and display as markers on the map. Helps manage performance and avoid clutter.

Title Field Name

String

Field API name used as the title for each marker. Examples: Name, Subject, or Title__c.

Description Field Name

String

Field API name used as the description for each marker. Examples: Description, Summary__c, Details__c.

Street Field Name

String

Field API name for the street address of a record. Example: BillingStreet, ShippingStreet.

City Field Name

String

Field API name for the city portion of the address. Example: BillingCity, ShippingCity.

Postal Code Field Name

String

Field API name for the postal or ZIP code. Example: BillingPostalCode, MailingPostalCode.

State Field Name

String

Field API name for the state or province. Example: BillingState, ShippingState.

Country Field Name

String

Field API name for the country. Example: BillingCountry, ShippingCountry.

Latitude Field Name

String

Field API name for the latitude coordinate (used when address fields are not provided). Example: Latitude__c.

Longitude Field Name

String

Field API name for the longitude coordinate (used when address fields are not provided). Example: Longitude__c.

Filter Fields

String

Comma-separated list of field API names displayed in the filter panel for user-driven filtering. Examples: Region__c,OwnerId,Type.

Metric Aggregation Fields

String

Show Search

Boolean

false

If true, displays a search bar above the map for keyword search on supported fields.

Disable Default UI

Boolean

false

If true, hides default map UI controls such as zoom buttons and street view toggle.

Disable Double Click Zoom

Boolean

false

If true, disables zooming via double-click.

Disable Dragging

Boolean

false

If true, disables the ability to move the map by dragging.

Disable Scrollwheel Zooming

Boolean

false

If true, disables zooming with the mouse scroll wheel.

Header - Title

String

Text displayed as the main title in the component header. Example: “Service Locations” or “Customer Map.”

Header - Caption

String

Subheading text displayed below the header title to provide context. Example: “Showing active accounts” or “Filtered by Territory.”

Header - Icon Name

String

SLDS icon name (e.g., standard:address) displayed beside the header title. Example: utility:map for geographic views.

Header - Show Number of Records

Boolean

false

If true, displays the total number of items in the map at the top of the component.

Action - Show More Details Panel

Boolean

false

If true, enables a side panel that displays additional record details when a row is selected, providing deeper context without leaving the page.

Action - Full Screen

Boolean

false

If true, displays a button that allows users to expand the data table to full screen, improving visibility for large datasets or detailed analysis.

Action - Enable Record Create

Boolean

false

If true, displays a button that allows users to create a new record in the map.

Display as Card

Boolean

true

If true, displays the map inside a styled card container for better visual presentation in dashboards or record pages.

Use Case Examples

Example 1: Account Contacts Map

spinner

Scenario: Display a geographic view of all contacts related to an account, showing their mailing addresses on an interactive map with role-based filtering for territory management.

Steps

1

Edit your Account record page

2

Drag the AX - Map component onto your page layout

3

Configure Data Source

  • Set Object Api Name to Contact

  • Set Filter to AccountId = {{Record.Id}} (shows contacts related to current account)

4

Configure Marker Information

  • Set Title Field Name to Name (displays contact names on map markers)

  • Set Description Field Name to Title (shows job titles in marker details)

5

Configure Address Fields

  • Set Street Field Name to MailingStreet

  • Set City Field Name to MailingCity

  • Set Postal Code to MailingPostalCode

  • Set Country Field Name to MailingCountry

6

Enable Search and Filtering

  • Check Show Search for keyword searching

  • Set Filterable Fields to Title (allows filtering by contact roles)

7

Customize Header

  • Set Header Title to Contacts for {{Record.Name}} (dynamic header with account name)

  • Set Header Icon Name to standard:contact

  • Check Disable Dragging to prevent accidental map movement

8

Save & review

Result: An interactive map showing contact locations with role-based filtering and clickable markers that provide contact details, perfect for territory planning and relationship management

Example 2: Accounts Map Overview

spinner

Scenario: Empower your sales team with a geographical overview of your company's accounts.

1

Edit your Account record page

2

Drag the AX - Map component onto your page layout

3

Configure Data Source

  • Set Object Api Name to Account

4

Configure Marker Information

  • Set Title Field Name to Name (displays contact names on map markers)

  • Set Description Field Name to Title (shows job titles in marker details)

5

Configure Address Fields

  • Set Street Field Name to BillingStreet

  • Set City Field Name to BillingCity

  • Set Postal Code to BillingPostalCode

  • Set Country Field Name to BillingCountry

6

Enable Search and Filtering

  • Check Show Search for keyword searching

  • Set Filterable Fields to Industry (allows filtering by account industry)

7

Customize Header

  • Set Header Title to Accounts Overview

  • Set Header Caption to World map

  • Set Header Icon Name to standard:account

  • Check Disable Dragging to prevent accidental map movement

  • Check Show more details panel to activate a side panel when users click on a record

  • Check Enable record create to let your users create accounts directly from the map

8

Save & review

Example 3: Service Locations Dashboard

Scenario: Create a comprehensive dashboard view of active service locations using GPS coordinates, with regional filtering and search capabilities for operational management.

Prerequisites: This example assumes you have created a custom Service Location object (Service_Location__c) with custom fields including Status__c (picklist for Active/Inactive), Latitude__c and Longitude__c (number fields for GPS coordinates), and Region__c (picklist or text field for geographic regions).

Steps

1

Edit your Service Dashboard page

2

Drag the AX - Map component onto your page layout

3

Configure Data Source

  • Set sObjectApiName to Service_Location__c (or your custom object name)

  • Set filter to Status__c = 'Active' (shows only active service locations)

4

Configure Location Information

  • Set titleFieldName to Name (displays location names on map markers)

  • Set latitudeFieldName to Latitude__c (uses stored GPS latitude coordinates)

  • Set longitudeFieldName to Longitude__c (uses stored GPS longitude coordinates)

5

Configure Dashboard Display

  • Check displayAsCard for professional container styling

  • Leave disableDefaultUi unchecked to keep standard map controls (zoom, street view)

6

Enable Search and Filtering

  • Check showSearch for keyword searching across location names

  • Set filterableFields to Region__c (allows filtering by geographic regions)

7

Configure Marker Interaction

Set markers to display location details when clicked

8

Save and test the dashboard functionality

Result: A professional dashboard map showing active service locations with regional filtering, search capabilities, and detailed location information accessible through interactive markers


Key Considerations

  • Location Fields: Use address fields for geocoding or lat/long for precision; ensure at least one set is mapped.

  • Dynamic Bindings: Leverage {{Record.FieldApiName}} for filters/headers on Record Pages.

  • Performance: Set limit for large datasets; test filters to avoid overload.

  • Map Controls: Disable dragging/zooming for static views; keep UI for interactive dashboards.

  • Interactions: Bind marker data (e.g., ID via titleFieldName) for navigations or flows.

  • Accessibility: Ensure clear titles/captions; test marker clickability with keyboards.


Troubleshooting Common Issues

  • No Markers Shown: Verify sObjectApiName, filter, and location fields (address or lat/long); check permissions.

  • Bindings Fail: Confirm {{Record.FieldApiName}} context; test in Record Page preview.

  • Filters/Search Missing: Enable showSearch/filterableFields; map relevant fields.

  • Map Not Interactive: Check disableDragging/disableDefaultUi are Off; test permissions.

  • Marker Overlap: Use limit to reduce markers; consider clustering in Screen Flows.

  • Layout Issues: Adjust Style Panel for size/margins; test card display on mobile.


Need More Advanced Features?

Last updated

Was this helpful?