How To
Documentation
    Learn More

      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}"]>
      </geo:highmaps>

      Parameters

      ParamTypeDetails
      responsestring

      Name of the response object to get the facet from.

      facet-namestring

      Name of the facet to retrieve the data from.

      mapstring

      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.

      Example

      Source