geo:highmaps
Description
Highmaps directive for mapping data onto a map.
In order to use this directive you need to include the map you wish to use, they can be found here
For example if you want to use this
map
of the UK you need to include the following script tag
<script src="https://code.highcharts.com/mapdata/countries/gb/gb-all.js"></script>
and put countries/gb/gb-all
on the chart highmaps map attribute. eg.
<chart:highmaps response="response" facet-name="facet" map="countries/gb/gb-all"></chart:highmaps>
Usage
as element:
<geo:highmaps
response="{string}"
facet-name="{string}"
map="{string}"
[key="{string}"]
[title="{string}"]
[subtitle="{string}"]
[series-name="{string}"]
[query="{string}"]
[options="{object}"]
[select="{string}"]>
</geo:highmaps>
Parameters
Param | Type | Details |
---|---|---|
response |
string |
Name of the response object to get the facet from. |
facet-name |
string |
Name of the facet to retrieve the data from. |
map |
string |
The map to use to render the data on. |
key (optional) |
string |
The property for joining the data. (Default: 'hc-key') More details here |
title (optional) |
string |
Title for the chart. |
subtitle (optional) |
string |
Subtitle for the chart. |
series-name (optional) |
string |
Name of the series. (Default: Name from the facet) |
query (optional) |
string |
Name of the query to apply filters to. |
options (optional) |
object |
Extend the current options. Options can be found here. |
select (optional) |
string |
How the data should be filtered when clicking on a part of the chart, a valid query must be present. + Valid values:-
User selects a filter by clicking the value; (default) * multiselect Supports selecting multiple filters that get combined with an 'OR'. * multiselect-instant Supports selecting multiple filters that get combined with an 'OR', filters will be applied automatically. |