---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/template.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.Template

Расширяет [YMaps.ITemplate](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/itemplate.md).

Шаблон для построения макетов на основе текста. 
Строка HTML-кода может содержать элементы вида `$[имя_поля|значение_по_умолчанию]`. При разборе шаблона такие элементы заменяются данными из объекта-контекста, который передается в метод build в качестве аргумента.

Если объект не содержит данных, путь к которым указан в элементе, то элемент будет заменен пустой строкой или значением по умолчанию, если таковое указано. Значение по умолчанию указывается сразу же после символа `|`.

В Internet Explorer 6 все картинки заменяются на элементы div с фильтром для поддержки полупрозрачности png-изображений.

**См.:** [Метка](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/how-to-add-placemark.md)

## Конструктор

Имя | Описание
----- | -----
[YMaps.Template](template.md#constructor)(text) | Создает шаблон - заготовку для создания макетов на основе текста.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[build](template.md#build)(context, map) | [YMaps.ILayout](ilayout.md) | Возвращает макет, созданный по заданному шаблону.


## Подробное описание конструктора {#constructor}

```javascript
YMaps.Template(text)
```

Создает шаблон - заготовку для создания макетов на основе текста.  	

**См.:** [Метка](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/how-to-add-placemark.md)

**Пример:**

```javascript
// Создает HTML-элемент DIV, содержащий текст "пробный текст".
template = new YMaps.Template("<div>$[customText|текст по умолчанию]</div>");
YMaps.Templates.add("example#template", template);
var layout = template.build({customText: "пробный текст"});
layout.onAddToParent(document.body);
```

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`text` | String | HTML-код шаблона. Помимо HTML-разметки код шаблона содержит специальные переменные, которые при разборе шаблона подменяются указанными данными.

## Подробное описание методов {#method_detail}

### build {#build}

```javascript
{YMaps.ILayout} build(context, map)
```

Возвращает макет, созданный по заданному шаблону.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`context` | Object | Контекст - это объект, из которого берутся данные для подстановки в макет.
`map` | [YMaps.Map](map.md) | Карта.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ILayout](ilayout.md) | Результирующий макет.