There is so much more functionality to ApricotMaps than meets the eye! By modifying your embed code you can tweak the behavior of your directory to better fit your needs.
Simply add the parameter you need to the end of the URL that is your widget code. The parameter you add should start with a “?” and any additontal parameters should start with “&”.
For example, if your embed code is: <script src=”https://app.apricotmaps.com/widget/1234“></script> and you want to add two parameters, your embed code would look like this: <script src=”https://app.apricotmaps.com/widget/1234?param1=true¶m2=false“></script>
Feel free to contact us if you need help!
Use levels to filter the map/listing to specific membership levels. By default, all membership levels you have selected in your setup are shown. By providing one or more level IDs, you can show only those members. This can be useful if you want to have muliple directories, each including different membership levels. Multiple IDs can be separated with commas.
Example: ?levels=123,234,345
Use level_order to sort members my levels in a specific order, useful for if you want to show higher tier members first. Provide a comma-separated list of level IDs in the exact order you want them to appear. The listing will then be grouped by level in that order. Within each level group, the default order or any specified sort (see sort below) will apply. If a level is omitted from this list, it will appear after the specified ones (in default order).
Example: ?level_order=4567,9876
The sort parameter determines how the member list is sorted. Using sort, you can order the results alphabetically by last name or by organization name. Acceptable values are:
lastname – to sort members alphabetically by last name (A–Z).
organization – to sort alphabetically by organization name.
If you have multiple levels and want to keep level groups together while sorting, you can prefix with level_:
level_lastname – groups by level (using your level_order if provided) and sorts by last name within each group.
level_organization – groups by level and sorts by organization within each group.
Example: ?sort=lastname
Use width to set the width of the widget’s map area in pixels. By default, the widget will stretch to 100% of the container it’s placed in (which usually means it’s fluid and responsive to your page layout). However, if you want to set a specific width (e.g. 800px), you can specify a number. You can pair this with the height parameter if needed.
If using a static map (see type=static) this parameter directly sets the image width in pixels. In an interactive map, the width is typically handled by your page layout, so you might not need to set this in most cases.
Example: ?width=800&height=200
Use height to set the height of the map portion of the widget in pixels. The default height, if not specified, is about 400px for the map area. You can pair this with the width parameter if needed.
If using a static map (see type=static) this parameter directly sets the image width in pixels. In an interactive map, the width is typically handled by your page layout, so you might not need to set this in most cases.
Example: ?height=200&width=800
By default, the interactive map will cluster nearby markers into a single combined marker when zoomed out (showing a number representing how many are in that cluster). Clustering helps prevent marker overcrowding. If you prefer to show all markers individually regardless of proximity, set no_cluster=true to disable this clustering feature. With clustering off, every marker will be placed on the map; be aware that too many overlapping markers can make the map harder to read.
Example: ?no_cluster=true
When multiple markers share the exact same location (or are extremely close), the widget normally separates them slightly so you can see each one – this is called “spiderfying” the markers. If you set no_spider=true, you disable this spiderfying behavior. That means if several members have the same address, their markers will overlap one another on the map (appearing as one marker). By default, spiderfying is enabled (so overlapping markers fan out in a small circle). Disable it only if you prefer exact positioning over visibility of each marker.
Example: ?no_spider=true
Use this parameter to hide the search box and filters on the widget. By default, the widget includes a search bar (to enter location) and an “Advanced Filters” panel for any custom fields. Setting no_search_fields=true will remove the entire search and filter UI, leaving just the map and/or the listing of all entries. This is useful if you want a simple directory display with no user interaction for searching or filtering.
Example: ?no_search_fields=true
The directory listing in the widget is split into pages by default (10 results per page). Normally, the map shows all markers for all results, even those not on the current page. Enabling paginate_markers synchronizes the map with the visible page of results: the map will update to show only the markers for the members on the current page. In other words, paginate_markers=true means as you go to page 2 of the listings, the map will only show markers for page 2’s entries (and not all entries).
Example: ?paginate_markers=true
Parameter type allows you to choose a different widget display mode. By default (if you don’t specify type), the widget is the standard interactive map and/or listing. You can set type to other values for alternative widget formats:
carousel – Instead of a map and list, the widget will show a scrolling carousel of member logos/images. This is great for showcasing member logos or sponsors in a marquee style. It scrolls continuously and does not include a map or directory list. (Only members with avatar images or logos will appear in the carousel.)
static – This will display a static map image with markers. It’s a non-interactive image of the map with the member locations marked. No listing or search functionality is shown in this mode.
If you use carousel or static, note that some other parameters may not apply (e.g. search fields, clustering, etc., since those are features of the interactive map). The widget’s code checks for these types and loads the appropriate format.
Example:
To get the carousel of logos: ?type=carousel
To get a static map image: ?type=static
If type is not set or is any other value, the widget defaults to the interactive map directory.
This only applies to the static map (type=static). This set s the size of the markers shown on the map. There are three sizes available:
Example: ?type=static&smarker_size=tiny
This parameter applies only to the carousel (type=carousel). speed controls how fast the logos scroll by. It’s a numeric value interpreted such that higher numbers make the carousel move faster, and lower numbers make it move slower. The default speed is 60. You can experiment with this value to get a comfortable scroll speed for your site. For example, doubling the number roughly doubles the speed of the scroll.
Example: ?type=carousel&speed=30
This parameter is used with type=static. If you set download=true along with a static map, the widget will automatically prompt the user to download the map image file. Essentially, as soon as the static map loads, it initiates a file download of that map PNG. This can be useful if you want to allow visitors to save or print the map. If download is false or not included, the static map will simply display on the page without downloading. (This setting has no effect on the interactive map or carousel types.)
Example: ?type=static&download=true
By default, the radius options for location search is 5, 10, 25, and 50 – in whichever unit of measurement your directory is set to. Use radius to pass a comma separated list of values to replace the default options.
Example: ?radius=3,5,10
Use radius_default to set the default selection for the radius field.
Example: ?radius_default=5