{module_webappsresultsmap}

Description

Displays the webapp search results as pointers on a Google map. This module can be used together with {module_webappsresults}

Syntax

{module_webappsresultsmap render="items|collection" googleKey="" width="400" height="400" resultsPerPage=500" sortType="Default” collection="my_custom_collection_name" template=""}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet.

Parameters

  • render - optional parameter, indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • googleKey - enter the Google Maps key here. To get a key please follow the steps described in this article.
  • width - the width in pixels of the Google Maps canvas
  • height - the height in pixels of the Google Maps canvas
  • resultsPerPage - total number of items that will be rendered, enter "-1" to render all the items
  • sortType
    • ALPHABETICAL (default) - items are sorted in alphabetical order form A-Z
    • DATE - items are sorted from newest to oldest. The most recent item is displayed first.
    • DATEREVERSE - will display the web app items oldest to newest
    • WEIGHTREVERSE - allows you to display the web apps by weight but in reverse, that is the item with the smallest weight is displayed first.
  • collection - use this if you need to access the module's Liquid output tags
  • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

This module is rendered:

  • using a Google map - the webapp items are plotted as pins on a Google map, for example:
  • Liquid collections - here are the Liquid output tags you can use:

Warning: if you need to access a liquid tag that has a space in its name, for example tag_large image_value use this syntax: {{cars1.items[0].["large image_value"]}} - Liquid does not allow for the name of its output tags to contain spaces. In this case the tag that contains a space needs to be wrapped in square brackets and quotes and preceded by the name of the collection (in this case cars1).

Liquid tag Description
{{address1}} Address1
{{address2}} Address2
{{city}} City
{{country}} Country
{{latitude}} Latitutde of web app item address
{{longitude}} Longitude of web app item address
{{state}} State
{{postalCode}} ZIP code
{{counter}} Incremental count of the item on the page
Creates a link that allows current customer to delete a web app item they have previously submitted (only available if customer logged in to a secure zone)
{{description}} Description of item (editor content). On the "List Layout (Backup)" you can use {tag_description,10} to display the first 10 characters of the webapp item's description.

Examples

  • {module_webappsresultsmap googleKey="ABCDEGHHIJKLMNOPQ" width="400" height="400" resultsPerPage="-1" sortType="default"} - displays all the search result webapp items ordered alphabetically on a 400px x 400px Google map
  • {module_webappsresultsmap googleKey="ABCDEGHHIJKLMNOPQ" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.

Syntax

{module_webappsresultsmap,Google key,width,height,resultsPerPage,sortType}

Parameters

  • Google key - enter the Google Maps key here. To get a key please follow the steps described in this article.
  • width - the width in pixels of the Google Maps canvas
  • height - the height in pixels of the Google Maps canvas
  • resultsPerPage - total number of items that will be rendered, enter "-1" to render all the items
  • sortType
    • ALPHABETICAL (default) - items are sorted in alphabetical order form A-Z
    • DATE - items are sorted from newest to oldest. The most recent item is displayed first.
    • DATEREVERSE - will display the web app items oldest to newest
    • weightreverse - allows you to display the web apps by weight but in reverse, that is the item with the smallest weight is displayed first.

This module is rendered with these layouts

  • This module does not use any layouts. The webapp search result items are plotted as pins on a Google map, for example:

Examples

  • {module_webappsresultsmap,MY_GOOGLE_MAPS_KEY,400,400,-1,default} - displays all the search result webapp items ordered alphabetically on a 400px x 400px Google map