YMaps.CoordPath

Множество вершин контура графического объекта с возможностью их распределения по коэффициентам масштабирования карты.

Конструктор

Имя Описание
YMaps.CoordPath(vertices) Создает объект для управления множеством вершин контура графического объекта.

Методы

Имя Возвращает Описание
getIndexesByZoom(zoom) Integer[] Возвращает массив индексов вершин, которые должны отображаться при заданном коэффициенте масштабирования карты.
getNumVertices() Integer Возвращает число вершин в контуре графического объекта.
getVertex(index) YMaps.CoordVertex Возвращает вершину контура графического объекта по ее индексу.
getVertices() YMaps.CoordVertex[] Возвращает копию массива вершин контура графического объекта.
setVertices(vertices) Устанавливает вершины контура графического объекта.
spliceVertices(index, number) YMaps.CoordVertex[]

Удаляет вершины из контура графического объекта. Если необходимо, вставляет на их место другие вершины.

Подробное описание конструктора

YMaps.CoordPath(vertices)

Создает объект для управления множеством вершин контура графического объекта.

Параметры:

Имя Тип Описание
vertices YMaps.CoordVertex[] Массив вершин контура графического объекта.

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

getIndexesByZoom

{Integer[]} getIndexesByZoom(zoom)

Возвращает массив индексов вершин, которые должны отображаться при заданном коэффициенте масштабирования карты.

Параметры:

Имя Тип Описание
zoom Integer Значение коэффициента масштабирования карты, для которого производится выборка индексов.

Возвращает:

Тип Описание
Integer[] Массив индексов видимых вершин контура.

getNumVertices

{Integer} getNumVertices()

Возвращает число вершин в контуре графического объекта.

Возвращает:

Тип Описание
Integer Число вершин в контуре графического объекта.

getVertex

{YMaps.CoordVertex} getVertex(index)

Возвращает вершину контура графического объекта по ее индексу.

Параметры:

Имя Тип Описание
index Integer Индекс вершины контура графического объекта.

Возвращает:

Тип Описание
YMaps.CoordVertex Ссылка на вершину.

getVertices

{YMaps.CoordVertex[]} getVertices()

Возвращает копию массива вершин контура графического объекта.

Возвращает:

Тип Описание
YMaps.CoordVertex[] Массив вершин контура графического объекта.

setVertices

setVertices(vertices)

Устанавливает вершины контура графического объекта.

Параметры:

Имя Тип Описание
vertices YMaps.CoordVertex[] Массив вершин.

spliceVertices

{YMaps.CoordVertex[]} spliceVertices(index, number)

Удаляет вершины из контура графического объекта. Если необходимо, вставляет на их место другие вершины.

Вершины, которые будут вставлены вместо удаленных, передаются как дополнительные параметры после параметра number.

Параметры:

Имя Тип Описание
index Integer Индекс первой удаляемой вершины.
number Integer Количество удаляемых вершин.

Возвращает:

Тип Описание
YMaps.CoordVertex[] Массив удаленных вершин.