YMaps.Utils

Пространство имен служебных функций.

Методы

Имя Статический Возвращает Описание
boundaryRestrict(value, min, max) Number Ограничивает числовое значение на входе заданными минимальным и максимальным пределами.
callMethod(objects, methodName) Вызывает заданный метод для каждого объекта из множества объектов.
cycleRestrict(value, min, max) Number

Приводит числовое значение к заданному диапазону.

extend(child, parent) Object Реализует наследование прототипа без исполнения конструктора родителя.
normalizeContent(content) ILayout

Возвращает макет на основе переданных данных.

Подробное описание методов

boundaryRestrict

{Number} boundaryRestrict(value, min, max)

Ограничивает числовое значение на входе заданными минимальным и максимальным пределами.

Пример:

// Возвращает -180
YMaps.Utils.boundaryRestrict(-250, -180, 180)

Параметры:

Имя Тип Описание
value Number Ограничиваемое значение.
min Number Минимальный предел.
max Number Максимальный предел.

Возвращает:

Тип Описание
Number Ограниченное значение.

callMethod

callMethod(objects, methodName)

Вызывает заданный метод для каждого объекта из множества объектов. Аргументы, начиная с третьего, передаются на вход вызываемому методу.

Пример:

var points = [new YMaps.Point(10, 20), new YMaps.Point(20, 30)];
YMaps.Utils.callMethod(points, "moveBy", new YMaps.Point(10, 10));

Параметры:

Имя Тип Описание
objects Object[] Массив объектов, для которых будет вызываться метод.
methodName String Имя метода, вызываемого у каждого из объектов.

cycleRestrict

{Number} cycleRestrict(value, min, max)

Приводит числовое значение к заданному диапазону.

Считается, что диапазон значений замкнут в кольцо. Если значение выходит за одну из границ диапазона, то излишек отсчитывается по кругу со стороны другой границы.

Как правило, данный метод используется для работы с неограниченными геоточками.

См.: Преобразование координат

Пример:

// Возвращает 110
YMaps.Utils.cycleRestrict(-250, -180, 180);
// Возвращает 60
YMaps.Utils.cycleRestrict(-300, -180, 180);
// Возвращает -170
YMaps.Utils.cycleRestrict(190, -180, 180);

Параметры:

Имя Тип Описание
value Number Ограничиваемое значение.
min Number Минимальный предел.
max Number Максимальный предел.

Возвращает:

Тип Описание
Number Ограниченное значение.

extend

{Object} extend(child, parent)

Реализует наследование прототипа без исполнения конструктора родителя.

Пример:

// Родительский класс
function ParentClass(){}
ParentClass.prototype.parentMethod = function() {
    alert('Parent');
};
// Дочерний класс
function ChildClass(){
    ParentClass.call(this);
}
YMaps.Utils.extend(ChildClass, ParentClass);
var childObject = new ChildClass();
childObject.parentMethod(); // Parent

Параметры:

Имя Тип Описание
child Function Класс-потомок.
parent Function Родительский класс.

Возвращает:

Тип Описание
Object Указатель на прототип класса-потомка.

normalizeContent

{ILayout} normalizeContent(content)

Возвращает макет на основе переданных данных.

Если передана пустая строка, null или undefined, то метод возвращает null.

Пример:

map.openBalloon(map.getCenter(), YMaps.Utils.normalizeContent('<p>Центр карты</p>'));

Параметры:

Имя Тип Описание
content String|HTMLElement|ILayout Нормализуемое содержимое.

Возвращает:

Тип Описание
ILayout Макет.