ILinearRingGeometryAccess

Расширяет IFreezable.

Интерфейс доступа к геометрии "Замкнутый контур".

Конструктор

ILinearRingGeometryAccess()

Поля

Имя

Тип

Описание

events

IEventManager

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

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

События

Имя

Описание

change

Изменение координат. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

• oldCoordinates - старые координаты;

• newCoordinates - новые координаты;

• oldFillRule - старый алгоритм заливки;

• newFillRule - новые алгоритм заливки.

Методы

Имя	Возвращает	Описание
contains(position)	Boolean	Проверяет, лежит ли переданная точка внутри контура.
freeze()	IFreezable	Переводит объект в "замороженный" режим. Унаследован от IFreezable.
get(index)	Number[]	Returns координаты точки с заданным индексом.
getChildGeometry(index)	IPointGeometryAccess	Создает и возвращает объект IPointGeometryAccess для заданной вершины контура.
getClosest(anchorPosition)	Object	Ищет на контуре точку, ближайшую к anchorPosition.
getCoordinates()	Number[][]	Returns массив координат геометрии.
getFillRule()	String	Returns идентификатор алгоритма заливки.
getLength()	Integer	Returns количество точек в геометрии.
insert(index, coordinates)	ILinearRingGeometryAccess	Добавляет новую точку с заданным индексом.
isFrozen()	Boolean	Returns true, если объект находится в "замороженном" режиме, иначе false. Унаследован от IFreezable.
remove(index)	Number[]	Удаляет точку с заданным индексом.
set(index, coordinates)	ILinearRingGeometryAccess	Задает координаты точки c заданным индексом.
setCoordinates(coordinates)	ILinearRingGeometryAccess	Задает массив координат геометрии.
setFillRule(fillRule)	ILinearRingGeometryAccess	Задает алгоритм заливки контура.
splice(index, number)	Number[][]	Удаляет определенное число точек начиная с заданного индекса. При этом на место удаляемых точек могут быть добавлены новые. Координаты новых точек можно передавать дополнительными аргументами после параметра number.
unfreeze()	IFreezable	Переводит объект в активный режим. Унаследован от IFreezable.

Описание событий

change

Изменение координат. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

• oldCoordinates - старые координаты;

• newCoordinates - новые координаты;

• oldFillRule - старый алгоритм заливки;

• newFillRule - новые алгоритм заливки.

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

contains

{Boolean} contains(position)

Проверяет, лежит ли переданная точка внутри контура.

Returns признак принадлежности точки контуру.

Параметры:

Параметр

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

Описание

position*

—

Тип: Number[]

Координаты точки.

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

get

{Number[]} get(index)

Returns координаты точки с заданным индексом.

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

Индекс точки.

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

getChildGeometry

{IPointGeometryAccess} getChildGeometry(index)

Создает и возвращает объект IPointGeometryAccess для заданной вершины контура.

Returns объект геометрии "Точка", соответствующий заданной вершине.

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

Индекс вершины контура.

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

getClosest

{Object} getClosest(anchorPosition)

Ищет на контуре точку, ближайшую к anchorPosition.

Returns объект со следующими полями:

• position - точка на контуре ближайшая к anchorPosition;

• distance - расстояние от anchorPosition до position;

• closestPointIndex - индекс вершины, ближайшей к position;

• nextPointIndex - индекс вершины, следующей за position;

• prevPointIndex - индекс вершины, предшествующей position.

Поля nextPointIndex, prevPointIndex могут отсутствовать, если position совпадает с одной из вершин контура.

Параметры:

Параметр

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

Описание

anchorPosition*

—

Тип: Number[]

Координаты точки, для которой расчитывается ближайшая точка на контуре.

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

getCoordinates

{Number[][]} getCoordinates()

Returns массив координат геометрии.

getFillRule

{String} getFillRule()

Returns идентификатор алгоритма заливки.

getLength

{Integer} getLength()

Returns количество точек в геометрии.

insert

{ILinearRingGeometryAccess} insert(index, coordinates)

Добавляет новую точку с заданным индексом.

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

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

Индекс точки.

coordinates*

—

Тип: Number[]

Координаты точки.

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

remove

{Number[]} remove(index)

Удаляет точку с заданным индексом.

Returns координаты удаленной точки.

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

Индекс точки.

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

set

{ILinearRingGeometryAccess} set(index, coordinates)

Задает координаты точки c заданным индексом.

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

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

Индекс точки.

coordinates*

—

Тип: Number[]

Координаты точки.

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

setCoordinates

{ILinearRingGeometryAccess} setCoordinates(coordinates)

Задает массив координат геометрии.

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

Параметры:

Параметр

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

Описание

coordinates*

—

Тип: Number[][]

Координаты геометрии.

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

setFillRule

{ILinearRingGeometryAccess} setFillRule(fillRule)

Задает алгоритм заливки контура.

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

Параметры:

Параметр

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

Описание

fillRule*

—

Тип: String

Идентификатор алгоритма заливки.

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

splice

{Number[][]} splice(index, number)

Удаляет определенное число точек начиная с заданного индекса. При этом на место удаляемых точек могут быть добавлены новые. Координаты новых точек можно передавать дополнительными аргументами после параметра number.

Returns массив координат удаленных точек.

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

Индекс, начиная с которого производится удаление и добавление точек.

number*

—

Тип: Integer

Количество удаляемых точек.

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

Была ли статья полезна?

ILayout

ILineStringGeometry