Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

data.Manager

Расширяет IDataManager, IFreezable.

Менеджер произвольных данных.

Конструктор | Поля | События | Методы

Конструктор

data.Manager(data)

Параметры:

ПараметрЗначение по умолчаниюОписание
data *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Object

Данные.

* Обязательный параметр/опция.

Поля

ИмяТипОписание
events IEventManager

Менеджер событий объекта.

Унаследовано от IFreezable.

События

ИмяОписание
change

Изменение внутреннего состояния объекта.

Унаследовано от IFreezable.

Методы

ИмяВозвращаетОписание
freeze()

IFreezable

Переводит объект в "замороженный" режим.

Унаследован от IFreezable.

get(path[, defaultValue])

Object

Возвращает значение поля данных с заданным именем.

getAll()

Object

Возвращает объект, содержащий все поля данных.

isFrozen()

Boolean

Возвращает true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от IFreezable.

set(path[, value])

data.Manager

Устанавливает значения для указанных полей. Поддерживаются две сигнатуры:

  • один аргумент, представляющий собой объект вида {"имя": "значение"};
  • два аргумента, первый из которых — имя поля, второй — значение.
Имя может адресовать вложенные поля, т.е. содержать '.'.

setAll()

data.Manager

Полностью перезаписывает все поля данных. Равносильно последовательному вызову методов unsetAll и set, но обеспечивает большую производительность.

unfreeze()

IFreezable

Переводит объект в активный режим.

Унаследован от IFreezable.

unset(path)

data.Manager

Очищает заданные поля данных.

unsetAll()

data.Manager

Очищает все поля данных.

Описание методов

get

{Object} get(path[, defaultValue])

Возвращает значение поля данных с заданным именем.

Параметры:

ПараметрЗначение по умолчаниюОписание
path *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: String

Строка с именем поля данных. Имя может адресовать вложенные поля, т.е. содержать '.'.

defaultValue

Тип: Object

Значение по умолчанию.

* Обязательный параметр/опция.

getAll

{Object} getAll()

Возвращает объект, содержащий все поля данных.

set

Устанавливает значения для указанных полей. Поддерживаются две сигнатуры:

  • один аргумент, представляющий собой объект вида {"имя": "значение"};
  • два аргумента, первый из которых — имя поля, второй — значение.
Имя может адресовать вложенные поля, т.е. содержать '.'.

Возвращает cсылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
path *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Object|String

Строка, содержащая имя поля данных, либо объект вида {"имя поля": "значение"}.

value

Тип: Object

Значение, если в качестве первого аргумента передается строка, содержащая имя поля.

* Обязательный параметр/опция.

Пример:

var balloonData = new ymaps.data.Manager({
     balloonContentHeader: 'Заголовок балуна'
});
balloonData.set({
    balloonContentBody: 'Balloon content',
    balloonContentFooter: '<a href=&quot;//ya.ru&quot;>тест</a>'
});

setAll

{data.Manager} setAll()

Полностью перезаписывает все поля данных. Равносильно последовательному вызову методов unsetAll и set, но обеспечивает большую производительность.

Возвращает cсылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
data *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип:

* Обязательный параметр/опция.

unset

Очищает заданные поля данных.

Возвращает cсылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
path *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: String|String[]

Имя поля, либо массив имён.

* Обязательный параметр/опция.

unsetAll

{data.Manager} unsetAll()

Очищает все поля данных.

Возвращает cсылку на себя.