ILinearRingGeometryAccess

Расширяет IFreezable.

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

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

Конструктор

ILinearRingGeometryAccess()

Поля

Имя

Тип

Описание

events

IEventManager

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

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

События

Имя

Описание

change

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

  • oldCoordinates — старые координаты;
  • newCoordinates - новые координаты;
  • oldFillRule - старый алгоритм заливки;
  • newFillRule - новые алгоритм заливки.

Методы

Имя

Возвращает

Описание

contains(position)

Boolean

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

freeze()

IFreezable

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

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

get(index)

Number[]

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

getChildGeometry(index)

IPointGeometryAccess

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

getClosest(anchorPosition)

Object

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

getCoordinates()

Number[][]

Возвращает массив координат геометрии.

getFillRule()

String

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

getLength()

Integer

Возвращает количество точек в геометрии.

insert(index, coordinates)

ILinearRingGeometryAccess

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

isFrozen()

Boolean

Возвращает 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)

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

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

Параметры:

Параметр

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

Описание

position*

—

Тип: Number[]

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

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

get

{Number[]} get(index)

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

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

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

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

getChildGeometry

{IPointGeometryAccess} getChildGeometry(index)

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

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

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

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

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

getClosest

{Object} getClosest(anchorPosition)

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

Возвращает объект со следующими полями:

  • position - точка на контуре ближайшая к anchorPosition;
  • distance - расстояние от anchorPosition до position;
  • closestPointIndex - индекс вершины, ближайшей к position;
  • nextPointIndex - индекс вершины, следующей за position;
  • prevPointIndex - индекс вершины, предшествующей position.
    Поля nextPointIndex, prevPointIndex могут отсутствовать, если position совпадает с одной из вершин контура.

Параметры:

Параметр

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

Описание

anchorPosition*

—

Тип: Number[]

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

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

getCoordinates

{Number[][]} getCoordinates()

Возвращает массив координат геометрии.

getFillRule

{String} getFillRule()

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

getLength

{Integer} getLength()

Возвращает количество точек в геометрии.

insert

{ILinearRingGeometryAccess} insert(index, coordinates)

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

Возвращает ссылку на себя.

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

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

coordinates*

—

Тип: Number[]

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

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

remove

{Number[]} remove(index)

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

Возвращает координаты удаленной точки.

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

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

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

set

{ILinearRingGeometryAccess} set(index, coordinates)

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

Возвращает ссылку на себя.

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

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

coordinates*

—

Тип: Number[]

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

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

setCoordinates

{ILinearRingGeometryAccess} setCoordinates(coordinates)

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

Возвращает ссылку на себя.

Параметры:

Параметр

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

Описание

coordinates*

—

Тип: Number[][]

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

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

setFillRule

{ILinearRingGeometryAccess} setFillRule(fillRule)

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

Возвращает ссылку на себя.

Параметры:

Параметр

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

Описание

fillRule*

—

Тип: String

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

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

splice

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

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

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

Параметры:

Параметр

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

Описание

index*

—

Тип: Integer

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

number*

—

Тип: Integer

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

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

Предыдущая
ILayout
Следующая
ILineStringGeometry