Forums, Knowledge Base and FAQs/Knowledge Base/Widgets

Mapping

Gareth Wilson
posted this on June 28, 2012 11:54

About our Geckoboard Map Custom Widget

The custom map widgets provide a way to visualise anything with a geographic element, for example the location of current site visitors or dispatch addresses for recent orders, on your dashboard. This opens up the possibility to connect to the increasing number of location aware web services with APIs and see location data side-by-side with your key business metrics. Here's a live example of a custom map widget.

Our Map Widget accepts:

* Lat, long coordinates
* IP addresses
* Host names

It renders the location of each point on a map. There's more details about this in our developer documentation, but you can add the size (1=tiny 10=large) and colour attributes in addition to geo data for each point or, or for greater control over appearance you can add a CSS class to each map point and upload a CSS file with the required attributes for that class to define the point's colour and opacity.

 

Our Map Custom Widget allows you to:

  • Display geographical points on a World, USA, Europe or individual European country map.
 Screen_Shot_2012-08-29_at_16.10.10.png

How to use the Geckoboard Map Custom Widget

Developer documentation for our Custom Widgets API, includes a section on this Mapping widget.

Adding the widget to your dashboard

1. From the 'Add Widget' option, select the 'Custom Widgets' category and select the 'Mapping' widget.

Configuring the Map Custom Widget

1. Set the method, either Polling or Push. Choose polling if you expose your data through an API and push if you push data to the Geckoboard API (see here for more details).

For Polling:

2. Provide the URL to your data feed. This is the location of an XML or JSON output that drives your custom widget. You can find out more about the syntax of this JSON/XML output in our Map widget documentation.

3. Select the map. There are three options to choose from, which indicate which map region this widget will display:
* World map
* USA
* Europe

4. If you selected Europe, then you can also set the 'Sub region', which is a specific European country map. Leave on 'All' to display a map for the whole of Europe.

5. Provide your API key (optional). Use this if your script uses an authentication key. Geckoboard will submit this field to your script in the HTTP header as a  username (basic HTTP authentification). You can find more information this authentication on the polling documentation page.

6. Select the widget type: either Custom or YQL (Yahoo! query language).

7. Choose the feed format: XML or JSON. This is the output format of your script, which you specified in Step 2, providing the data feed URL.

8. Select the request type: either GET or POST. This specifies whether Geckoboard sends a GET or POST request type for the data.

9. Specify the reload time (in minutes). This is how often Geckoboard will poll your script for data.

10. Specify a label. This is the label that gets displayed at the top of the widget and has a 30 character maximum.

11. Choose the widget size: 2x2, 3x3, 4x2, 4x3 or 4x4.

For Push:

2. Push URL. This field is automatically pre-populated with a unique URL to push data to this widget. See the Push API documentation for more information.

3. Widget Key. This field is automatically pre-populated with a unique key for this widget.

4. Select the map. There are three options to choose from, which indicate which map region this widget will display:
* World map
* USA
* Europe

5. If you selected Europe, then you can also set the 'Sub region', which is a specific European country map. Leave on 'All' to display a map for the whole of Europe.

6. Specify a label. This is the label that gets displayed at the top of the widget. 30 character maximum.

7. Choose the widget size: 2x2, 3x3, 4x2, 4x3 or 4x4

 

Example map of current website visitors displayed on a world map:

Screen_Shot_2012-08-29_at_16.10.10.png

Example map of delivery sites, with dots colour coded by order type and size, displayed on a world map:

Screen_Shot_2012-08-29_at_16.09.48.png

 
Topic is closed for comments