Monitor
Объект, отслеживающий изменения определенных полей данных на заданном менеджере данных. Также может использоваться для отслеживания изменений опций.
Конструктор
Monitor(dataManager)
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
dataManager * | — | Тип: IDataManager|IOptionManager Менеджер данных. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
dataManager * | — | Тип: IDataManager|IOptionManager Менеджер данных. |
* Обязательный параметр/опция.
Пример:
// Отслеживание изменений опции метки.
var placemark = new ymaps.Placemark([0, 0]),
optionMonitor = new ymaps.Monitor(placemark.options);
optionMonitor.add("cursor", function (newValue) {
alert("cursor: " + newValue);
});
myMap.geoObjects.add(placemark);
// Выведет строку "cursor: arrow".
myMap.options.set({
geoObjectCursor: "arrow"
});
Методы
Имя | Возвращает | Описание |
---|---|---|
add(name, changeCallback[, context[, params]]) | Включает наблюдение за определенным полем, либо группой полей данных. | |
forceChange() | Инициирует проверку изменения значений наблюдаемых полей данных. | |
get(name) | Object | Returns текущее значение одного из наблюдаемых полей данных. |
remove(name) | Отключает наблюдение за определенным полем, либо группой полей данных. | |
removeAll() | Отключает наблюдение для всех полей данных. |
Имя | Возвращает | Описание |
---|---|---|
add(name, changeCallback[, context[, params]]) | Включает наблюдение за определенным полем, либо группой полей данных. | |
forceChange() | Инициирует проверку изменения значений наблюдаемых полей данных. | |
get(name) | Object | Returns текущее значение одного из наблюдаемых полей данных. |
remove(name) | Отключает наблюдение за определенным полем, либо группой полей данных. | |
removeAll() | Отключает наблюдение для всех полей данных. |
Описание методов
add
{Monitor} add(name, changeCallback[, context[, params]])
Включает наблюдение за определенным полем, либо группой полей данных.
Returns ссылку на себя.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
name * | — | Тип: String|String[] Имя, либо массив имен полей данных, за которыми устанавливается наблюдение. |
changeCallback * | — | Тип: Function Обработчик изменения поля данных, либо одного из полей данных группы. |
context | — | Тип: Object Контекст исполнения обработчика изменений данных, а также опциональных обработчиков. |
params | — | Тип: Object Опциональные параметры. |
params.compareCallback | — | Тип: Function Обработчик сравнивающий старое и новое значения поля данных. Принимает два аргумента: старое значение, новое значение. Менее приоритетен по отношению к обработчикам заданным с помощью параметра compareCallbacks. |
params.compareCallbacks | — | Тип: Object Хэш вида {имя поля данных: ссылка на обработчик}. Данный параметр позволяет задать индивидуальные обработчики сравнения значений для различных полей данных в группе. |
params.defaultValue | — | Тип: Object Значение по умолчанию, используемое в том случае, если поле данных не определено. |
params.defaultValues | — | Тип: Object Хэш вида {имя поля данных: значение по умолчанию}. Данный параметр позволяет задать индивидуальные значения по умолчанию для различных полей данных в группе. |
params.resolveCallback | — | Тип: Function Обработчик разрешающий значение поля данных. Принимает два аргумента: имя поля данных, ссылку на менеджер данных. Менее приоритетен по отношению к обработчикам заданным с помощью параметра resolveCallbacks. |
params.resolveCallbacks | — | Тип: Object Хэш вида {имя поля данных: ссылка на обработчик}. Данный параметр позволяет задать индивидуальные обработчики разрешения значений для различных полей данных в группе. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
name * | — | Тип: String|String[] Имя, либо массив имен полей данных, за которыми устанавливается наблюдение. |
changeCallback * | — | Тип: Function Обработчик изменения поля данных, либо одного из полей данных группы. |
context | — | Тип: Object Контекст исполнения обработчика изменений данных, а также опциональных обработчиков. |
params | — | Тип: Object Опциональные параметры. |
params.compareCallback | — | Тип: Function Обработчик сравнивающий старое и новое значения поля данных. Принимает два аргумента: старое значение, новое значение. Менее приоритетен по отношению к обработчикам заданным с помощью параметра compareCallbacks. |
params.compareCallbacks | — | Тип: Object Хэш вида {имя поля данных: ссылка на обработчик}. Данный параметр позволяет задать индивидуальные обработчики сравнения значений для различных полей данных в группе. |
params.defaultValue | — | Тип: Object Значение по умолчанию, используемое в том случае, если поле данных не определено. |
params.defaultValues | — | Тип: Object Хэш вида {имя поля данных: значение по умолчанию}. Данный параметр позволяет задать индивидуальные значения по умолчанию для различных полей данных в группе. |
params.resolveCallback | — | Тип: Function Обработчик разрешающий значение поля данных. Принимает два аргумента: имя поля данных, ссылку на менеджер данных. Менее приоритетен по отношению к обработчикам заданным с помощью параметра resolveCallbacks. |
params.resolveCallbacks | — | Тип: Object Хэш вида {имя поля данных: ссылка на обработчик}. Данный параметр позволяет задать индивидуальные обработчики разрешения значений для различных полей данных в группе. |
* Обязательный параметр/опция.
forceChange
{Monitor} forceChange()
Инициирует проверку изменения значений наблюдаемых полей данных.
Returns ссылку на себя.
get
{Object} get(name)
Returns текущее значение одного из наблюдаемых полей данных.
Параметры:
* Обязательный параметр/опция.
remove
Отключает наблюдение за определенным полем, либо группой полей данных.
Returns ссылку на себя.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
name * | — | Тип: String|String[] Имя, либо массив имен полей данных, для которых отключается наблюдение. |
* Обязательный параметр/опция.
removeAll
{Monitor} removeAll()
Отключает наблюдение для всех полей данных.
Returns ссылку на себя.