> ## 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:heatmap

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.geoHeatmap

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

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

<LwTemplate />

## Description

The heatmap directive

## Usage

as element:

```xml wrap  theme={"dark"}
<geo:heatmap
       response="{string}"
       facet-name="{string}"
       [height="{string}"]
       [width="{string}"]
       [scroll-to-zoom="{boolean}"]
       [options="{object}"]>
</geo:heatmap>
```

### Directive info

* This directive creates new scope.

#### Parameters

| Param                        | Type        | Details                                                                                                                                          |
| ---------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| response                     | **string**  | Name of the response.                                                                                                                            |
| facet-name                   | **string**  | Facet containing the data.                                                                                                                       |
| height  *(optional)*         | **string**  | The height of the map container. Default is 400px.                                                                                               |
| width  *(optional)*          | **string**  | The width of the map container. Default is 100%.                                                                                                 |
| scroll-to-zoom  *(optional)* | **boolean** | Whether the scroll wheel should control the map zoom. Disabled by default.                                                                       |
| options  *(optional)*        | **object**  | Extend the current options for the Google Map [(Options Here)](https://developers.google.com/maps/documentation/javascript/reference#MapOptions) |