IPolygonGeometry

Расширяет IGeometry, IPolygonGeometryAccess.

Интерфейс геометрии "Многоугольник".

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

Конструктор

IPolygonGeometry()

Поля

Имя Тип Описание
events IEventManager

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

Унаследовано от IEventEmitter.
options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.
Имя Тип Описание
events IEventManager

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

Унаследовано от IEventEmitter.
options IOptionManager

Менеджер опций.

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

События

Имя Описание
change
Изменение координат. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldCoordinates - старые координаты;
  • newCoordinates - новые координаты;
  • oldFillRule - старый алгоритм заливки;
  • newFillRule - новые алгоритм заливки.

Унаследовано от IPolygonGeometryAccess.
mapchange
Сменилась карта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IGeometry.
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.
pixelgeometrychange
Изменилась пиксельная геометрия. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldPixelGeometry - старая пиксельная геометрия IPixelGeometry;
  • newPixelGeometry - новая пиксельная геометрия IPixelGeometry.

Унаследовано от IGeometry.
Имя Описание
change
Изменение координат. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldCoordinates - старые координаты;
  • newCoordinates - новые координаты;
  • oldFillRule - старый алгоритм заливки;
  • newFillRule - новые алгоритм заливки.

Унаследовано от IPolygonGeometryAccess.
mapchange
Сменилась карта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IGeometry.
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.
pixelgeometrychange
Изменилась пиксельная геометрия. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • oldPixelGeometry - старая пиксельная геометрия IPixelGeometry;
  • newPixelGeometry - новая пиксельная геометрия IPixelGeometry.

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

Методы

Имя Возвращает Описание
contains(position)

Boolean

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

Унаследован от IPolygonGeometryAccess.
freeze()

IFreezable

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

Унаследован от IFreezable.
get(index)

Number[][]

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

Унаследован от IPolygonGeometryAccess.
getBounds()

Number[][]|null

Returns координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - юго-западный угол области; второй элемент - северо-восточный угол соответственно.

Унаследован от IGeometry.
getChildGeometry(index)

ILinearRingGeometryAccess

Создает и возвращает объект ILinearRingGeometryAccess для заданного контура.

Унаследован от IPolygonGeometryAccess.
getClosest(anchorPosition)

Object

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

Унаследован от IPolygonGeometryAccess.
getCoordinates()

Number[][][]

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

Унаследован от IPolygonGeometryAccess.
getFillRule()

String

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

Унаследован от IPolygonGeometryAccess.
getLength()

Integer

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

Унаследован от IPolygonGeometryAccess.
getMap()

Map|null

Returns текущую карту.

Унаследован от IGeometry.
getPixelGeometry([options])

IPixelGeometry

Returns пиксельную геометрию, соответствующую данной геометрии, ее опциям и состоянию карты.

Унаследован от IGeometry.
getType()

String

Returns строку "Polygon".
insert(index, path)

IPolygonGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
isFrozen()

Boolean

Returns true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от IFreezable.
remove(index)

ILinearRingGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
set(index, path)

IPolygonGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
setCoordinates(coordinates)

IPolygonGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
setFillRule(fillRule)

IPolygonGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
setMap(map)

Задает карту.

Унаследован от IGeometry.
splice(index, number)

ILinearRingGeometryAccess[]

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

Унаследован от IPolygonGeometryAccess.
unfreeze()

IFreezable

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

Унаследован от IFreezable.
Имя Возвращает Описание
contains(position)

Boolean

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

Унаследован от IPolygonGeometryAccess.
freeze()

IFreezable

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

Унаследован от IFreezable.
get(index)

Number[][]

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

Унаследован от IPolygonGeometryAccess.
getBounds()

Number[][]|null

Returns координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - юго-западный угол области; второй элемент - северо-восточный угол соответственно.

Унаследован от IGeometry.
getChildGeometry(index)

ILinearRingGeometryAccess

Создает и возвращает объект ILinearRingGeometryAccess для заданного контура.

Унаследован от IPolygonGeometryAccess.
getClosest(anchorPosition)

Object

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

Унаследован от IPolygonGeometryAccess.
getCoordinates()

Number[][][]

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

Унаследован от IPolygonGeometryAccess.
getFillRule()

String

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

Унаследован от IPolygonGeometryAccess.
getLength()

Integer

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

Унаследован от IPolygonGeometryAccess.
getMap()

Map|null

Returns текущую карту.

Унаследован от IGeometry.
getPixelGeometry([options])

IPixelGeometry

Returns пиксельную геометрию, соответствующую данной геометрии, ее опциям и состоянию карты.

Унаследован от IGeometry.
getType()

String

Returns строку "Polygon".
insert(index, path)

IPolygonGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
isFrozen()

Boolean

Returns true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от IFreezable.
remove(index)

ILinearRingGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
set(index, path)

IPolygonGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
setCoordinates(coordinates)

IPolygonGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
setFillRule(fillRule)

IPolygonGeometryAccess

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

Унаследован от IPolygonGeometryAccess.
setMap(map)

Задает карту.

Унаследован от IGeometry.
splice(index, number)

ILinearRingGeometryAccess[]

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

Унаследован от IPolygonGeometryAccess.
unfreeze()

IFreezable

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

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

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

getType

{String} getType()

Returns строку "Polygon".