# Heat Map Chart

## Heat Map

{% embed url="<https://stackblitz.com/edit/swimlane-heat-map-chart?embed=1&file=app/app.component.ts>" %}

## Inputs

| Property            | Type                | Default Value | Description                                                                                                      |
| ------------------- | ------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- |
| view                | number\[]           |               | the dimensions of the chart \[width, height]. If left undefined, the chart will fit to the parent container size |
| results             | object\[]           |               | the chart data                                                                                                   |
| scheme              | object              |               | the color scheme of the chart                                                                                    |
| animations          | boolean             | true          | enable animations                                                                                                |
| legend              | boolean             | false         | show or hide the legend                                                                                          |
| legendTitle         | string              | 'Legend'      | the legend title                                                                                                 |
| legendPosition      | string              | 'right'       | the legend position \['right', 'below']                                                                          |
| xAxis               | boolean             | false         | show or hide the x axis                                                                                          |
| yAxis               | boolean             | false         | show or hide the y axis                                                                                          |
| showXAxisLabel      | boolean             | false         | show or hide the x axis label                                                                                    |
| showYAxisLabel      | boolean             | false         | show or hide the y axis label                                                                                    |
| xAxisLabel          | string              |               | the x axis label text                                                                                            |
| yAxisLabel          | string              |               | the y axis label text                                                                                            |
| trimXAxisTicks      | boolean             | true          | trim or not ticks on the x axis                                                                                  |
| trimYAxisTicks      | boolean             | true          | trim or not ticks on the Y axis                                                                                  |
| rotateXAxisTicks    | boolean             | true          | enable automic rotation of x-axis ticks to prevent overlaps                                                      |
| maxXAxisTickLength  | number              | 16            | max length of the ticks. If `trimXAxisTicks` is `true`, ticks over this length will be trimmed                   |
| maxYAxisTickLength  | number              | 16            | max length of the ticks. If `trimYAxisTicks` is `true`, ticks over this length will be trimmed                   |
| xAxisTickFormatting | function            |               | the x axis tick formatting                                                                                       |
| yAxisTickFormatting | function            |               | the y axis tick formatting                                                                                       |
| xAxisTicks          | any\[]              |               | predefined list of x axis tick values                                                                            |
| yAxisTicks          | any\[]              |               | predefined list of y axis tick values                                                                            |
| gradient            | boolean             | false         | fill elements with a gradient instead of a solid color                                                           |
| innerPadding        | number or number\[] | 8             | the inner padding in px                                                                                          |
| tooltipDisabled     | boolean             | false         | show or hide the tooltip                                                                                         |
| tooltipText         | function            | (see source)  | the HTML text to display in the tooltip                                                                          |
| tooltipTemplate     | TemplateRef         |               | a custom ng-template to be displayed inside the tooltip                                                          |
| wrapTicks           | boolean             | false         | axis tick labels will wrap based on available space                                                              |

## Outputs

| Property | Description |
| -------- | ----------- |
| select   | click event |

## Data Format

The data format is multi series:

```
[
  {
    "name": "Germany",
    "series": [
      {
        "name": "2010",
        "value": 7300000
      },
      {
        "name": "2011",
        "value": 8940000
      }
    ]
  },

  {
    "name": "USA",
    "series": [
      {
        "name": "2010",
        "value": 7870000
      },
      {
        "name": "2011",
        "value": 8270000
      }
    ]
  }
]
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://swimlane.gitbook.io/ngx-charts/examples/heat-map-chart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.