data.Manager

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

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

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

Конструктор

data.Manager(data)

Параметры:

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

Тип: Object

Данные.

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

Поля

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

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

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

События

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

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

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

Методы

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

IFreezable

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

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

get(path[, defaultValue])

Object

Returns значение поля данных с заданным именем.

getAll()

Object

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

isFrozen()

Boolean

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

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

set(path[, value])

data.Manager

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

IFreezable

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

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

unset(path)

data.Manager

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

unsetAll()

data.Manager

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

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

get

{Object} get(path[, defaultValue])

Returns значение поля данных с заданным именем.

Параметры:

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

Тип: String

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

defaultValue

Тип: Object

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

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

getAll

{Object} getAll()

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

set

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

Returns ссылку на себя.

Параметры:

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

Тип: Object|String

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

value

Тип: Object

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

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

Пример:

var balloonData = new ymaps.data.Manager({
     balloonContentHeader: 'Заголовок балуна'
});
balloonData.set({
    balloonContentBody: 'Содержимое балуна',
    balloonContentFooter: '<a href="//ya.ru">test</a>'
});

unset

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

Returns ссылку на себя.

Параметры:

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

Тип: String|String[]

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

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

unsetAll

{data.Manager} unsetAll()

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

Returns ссылку на себя.