---
metadata:
  - name: generator
    content: Diplodoc Platform v5.55.2
alternate:
  - https://yandex.com/support/metrica/en/objects/clickmap.md
  - https://yandex.com/support/metrica/es/objects/clickmap.md
  - https://yandex.com/support/metrica/pt/objects/clickmap.md
  - https://yandex.com/support/metrica/ru/objects/clickmap.md
  - https://yandex.com/support/metrica/tr/objects/clickmap.md
  - https://yandex.com/support/metrica/zh/objects/clickmap.md
  - href: en/objects/clickmap.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/support/metrica/en/llms.txt

# clickmap


{% note alert %}

Outdated method. Supported for backward compatibility, but may be deprecated at any time. We strongly discourage its use.

To manage collection of click data, use the [clickmap](https://yandex.com/support/metrica/en/code/counter-initialize.md#param-clickmap) parameter during tag initialization.

{% endnote %}


Managing collection of information for generating [click maps](https://yandex.com/support/metrica/en/behavior/click-map.md).

```javascript
ym(XXXXXXXX, 'clickmap', properties);
```


#|
||
**Parameter**
|
**Default value**
|
**Type**
|
**Description**
||
||
`properties`[*](*Параметр)
|
—
|
Boolean | Object
|
By default, information is collected about all clicks on the page.

You can disable click tracking by setting the parameter to `false`.
```javascript ym(XXXXXXXX, 'clickmap', false);```
The specified click tracking parameters (“Object” type) are remembered. So if click tracking was disabled, calling `clickmap(true)` will start tracking clicks again using the parameters that were specified earlier.
||
||
Fields of the `properties` object
||
||
`properties.filter`
|
—
|
Function
|
Click filtration for specific DOM elements
||
||
`properties.ignoreTags`
|
—
|
String[]
|
A list of HTML tags to not track clicks for
||
||
`properties.quota`
|
—
|
Number
|
Maximum number of tracked clicks on a page
||
|#

<sup >*</sup> Required parameter.

> # Example
> 
> ```javascript
> ym(XXXXXXXX, 'init', {});
> ym(XXXXXXXX, 'clickmap', {
>     mode: 'default',
>     quota: 1,
>     delay: 10,
>     ingoreTags: ['input', 'textarea'],
>     filter: function(domElement) {
>         if (
>                domElement.className == 'menu-item'
>                ||
>                domElement.id == 'footer'
>            ) {
>             return false; // Click ignoring
>         }
>         return true;
>     }
> });
> ```
> 
> You can also disable click tracking using the [ym-disable-clickmap](https://yandex.com/support/metrica/en/code/html-markup.md#class-ym-disable-clickmap) class.

<!-- source: en/_includes/buttons/chat-button.md -->
[Chat with us](https://yandex.com/chat/#/user/036e6a02-3620-9cdc-4c5e-a34667a7379e?utm_source=spravka){.button}

<!-- source: en/_includes/styles/href-to-button.md -->

<!-- endsource: en/_includes/styles/href-to-button.md -->
<!-- endsource: en/_includes/buttons/chat-button.md -->

<!-- source: en/_includes/buttons/support-button.md -->
<div class="cut-button">

{% cut "Write an email" %}

<!-- source: en/_includes/popup/id-popup/wrong-sup.md -->
Please note: Our support team will never initiate a call to you. Do not follow any instructions of people who call you and introduce themselves as the Yandex Metrica support team.
<!-- endsource: en/_includes/popup/id-popup/wrong-sup.md -->

<div style="padding: 15px;
     margin: 10px 0;
     background: #FFFFFF;
     border-radius: 10px;
     border: 1px solid var(--g-color-line-generic);">
  <iframe style="background: #FFFFFF;"
        height="700"
        width="100%"
        frameborder="0"
        src="https://forms.yandex.com/surveys/1706/?&iframe=1&lang=en">
  </iframe>
</div>

{% endcut %}

</div>

<!-- source: en/_includes/styles/cut-button.md -->

<!-- endsource: en/_includes/styles/cut-button.md -->
<!-- endsource: en/_includes/buttons/support-button.md -->


<!-- source: en/_includes/styles/href-to-button.md -->

<!-- endsource: en/_includes/styles/href-to-button.md -->

<!-- source: en/_includes/styles/cut-button.md -->

<!-- endsource: en/_includes/styles/cut-button.md -->

<!-- source: en/_includes/footer-links.md -->
- - -

<div class="borderless-table">

#|
||
Useful links

- [Demo tag](https://metrica.yandex.com/r/dashboard?)
- [Add a tag](https://metrica.yandex.com/add/)
- [Free tag setup](https://yandex.com/promo/freeservice/metrica?utm_source=help_metrica_en&utm_medium=cpc&utm_campaign=1)
- [Yandex Metrica API](https://tech.yandex.com/metrika/)
- [Suggest your idea](https://yandex.com/support/metrica/troubleshooting/idea.html)
- [Discuss in Telegram](https://t.me/yandexmetrika)
|
Online training

- [Get a Yandex Metrica certificate](https://yandex.ru/adv/expert/exam/metrika/?utm_source=metrika_help&utm_medium=web&utm_campaign=static&utm_content=useful_links)


- [Take a training course](https://yandex.com/adv/edu/online/metrika?utm_source=metrika_help&utm_medium=web&utm_campaign=static&utm_content=useful_links)

||
|#

</div>

<!-- source: en/_includes/styles/table-style.md -->

<!-- endsource: en/_includes/styles/table-style.md -->
<!-- endsource: en/_includes/footer-links.md -->

[*Параметр]: <sup >*</sup> Required parameter.