> ## Documentation Index
> Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# geo:highmaps

export const LwTemplate = ({title = "Key questions to get you started", icon = "sparkles", cta = "Powered by Agent Studio", linkHref = "https://lucidworks.com/demo/?utm_source=docs&utm_medium=referral&utm_campaign=docs_cta_ai"}) => {
  const [isLoaded, setIsLoaded] = useState(false);
  useEffect(() => {
    const timer = setTimeout(() => {
      setIsLoaded(true);
    }, 500);
    return () => clearTimeout(timer);
  }, []);
  return <div className="lw-template-container">
      <Card title={title} icon={icon}>
        {isLoaded && <span dangerouslySetInnerHTML={{
    __html: `<lw-template id="a029c1a9-28be-427e-b0e1-5d918920246a"></lw-template
            >`
  }} />}
        <Link href={linkHref} className="agent-studio-link text-left text-gray-600 gap-2 dark:text-gray-400 text-sm font-medium flex flex-row items-center hover:text-primary dark:hover:text-primary-light group-hover:text-primary group-hover:dark:text-primary-light">Powered by Lucidworks Agent Studio</Link>
      </Card>
    </div>;
};

[localhost link]: http://localhost:3000/docs/4/app-studio/reference/tags/lightning.directive.geoHighmaps

[mintlify link]: https://doc.lucidworks.com/docs/4/app-studio/reference/tags/lightning.directive.geoHighmaps

[old doc.lw link]: https://doc.lucidworks.com/app-studio/4.2/1059

<LwTemplate />

## 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](http://code.highcharts.com/mapdata/)

For example if you want to use this
[map of the UK](http://jsfiddle.net/gh/get/jquery/1.11.0/highslide-software/highcharts.com/tree/master/samples/mapdata/countries/gb/gb-all) 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:

```xml wrap  theme={"dark"}
<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](http://www.highcharts.com/docs/maps/map-collection)                                                                                                                                                                                                                                                                                                                           |
| 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.](http://api.highcharts.com/highmaps/)                                                                                                                                                                                                                                                                                                                                                            |
| select  *(optional)*      | **string** | How the data should be filtered when clicking on a part of the chart, a valid query must be present.  <br />Valid values:<br />  <br />● **click**  User selects a filter by clicking the value;  **(default)** <br />● **multiselect**  Supports selecting multiple filters that get combined with an 'OR'. <br />● **multiselect-instant**  Supports selecting multiple filters that get combined with an 'OR', filters will be applied automatically. |