ol/Feature~Feature

import Feature from 'ol/Feature.js';

Векторный объект географических объектов с геометрией и другими свойствами атрибутов, аналогичный объектам в форматах векторных файлов, таких как GeoJSON.

Объекты можно стилизовать индивидуально с помощью setStyle; в противном случае они используют стиль своего векторного слоя.

Обратите внимание, что свойства атрибутов задаются как BaseObject свойства объекта Feature, поэтому они наблюдаемы и имеют методы доступа get/set.

Обычно у объекта Feature есть одно свойство геометрии. Вы можете задать геометрию с помощью метода setGeometry и получить её с помощью метода getGeometry. Можно хранить более одной геометрии в объекте Feature, используя свойства атрибутов. По умолчанию геометрия, используемая для отображения, определяется свойством geometry. Если вы хотите использовать другое свойство геометрии для отображения, используйте метод setGeometryName для изменения свойства атрибута, связанного с геометрией объекта Feature. Например:

import Feature from 'ol/Feature.js';
import Polygon from 'ol/geom/Polygon.js';
import Point from 'ol/geom/Point.js';

const feature = new Feature({
  geometry: new Polygon(polyCoords),
  labelPoint: new Point(labelCoords),
  name: 'My Polygon',
});

// get the polygon geometry
const poly = feature.getGeometry();

// Render the feature as a point using the coordinates from labelPoint
feature.setGeometryName('labelPoint');

// get the point geometry
const point = feature.getGeometry();

new Feature(geometryOrProperties) Feature.js, строка 75

Имя	Тип	Описание
`geometryOrProperties`	Geometry \| ObjectWithGeometry.<Geometry> \| undefined	Вы можете передать непосредственно объект Geometry или объект с свойствами. Если вы передаёте объект с свойствами, вы можете включить геометрию, связанную с `geometry` ключом.

События:

change (BaseEvent) - Общее событие изменения. Срабатывает при увеличении счётчика ревизии.
change:geometry (ObjectEvent)
error (BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки.
propertychange (ObjectEvent) - Срабатывает при изменении свойства.

Расширяет

BaseObject

Наблюдаемые свойства

Имя	Тип	Устанавливаемое	ObjectEvent тип	Описание
`geometry`	Geometry \| undefined	да	`change:geometry`	Геометрия по умолчанию для объекта.

Методы

changed() унаследованное Observable.js, строка 68

Увеличивает счётчик ревизий и отправляет событие 'change'.

clone(){Feature<Geometry>} Feature.js, строка 155

Клонирует этот объект Feature. Если у исходного объекта Feature есть геометрия, она также клонируется. Идентификатор Feature в клоне не устанавливается.

Возвращает:

Клон.

dispatchEvent(event){boolean | undefined} унаследованное events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, слушающие события этого типа. Параметр события может быть либо строкой, либо объектом с свойством type.

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращает:

false, если кто-то вызвал preventDefault на объекте события или любой из обработчиков вернул false.

get(key){*} унаследованное Object.js, строка 135

Получает значение.

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращает:

Значение.

getGeometry(){Geometry | undefined} Feature.js, строка 179

Получение стандартной геометрии объекта Feature. Объект Feature может иметь любое количество геометрий с именами. "Стандартная" геометрия (которая отображается по умолчанию) устанавливается при вызове setGeometry.

Возвращает:

Стандартную геометрию объекта Feature.

getGeometryName(){string} Feature.js, строка 201

Получение имени стандартной геометрии объекта Feature. По умолчанию, стандартная геометрия имеет имя geometry.

Возвращает:

Имя свойства, связанного со стандартной геометрией для данного объекта Feature.

getId(){number | string | undefined} Feature.js, строка 190

Получение идентификатора объекта Feature. Это стабильный идентификатор для объекта Feature и устанавливается при чтении данных из удалённого источника или явно при вызове setId.

Возвращает:

Идентификатор.

getKeys(){Array.<string>} унаследованное Object.js, строка 148

Получение списка имён свойств объекта.

Возвращает:

Список имён свойств.

getProperties(){Object.<string, *>} унаследованное Object.js, строка 157

Получение объекта со всеми именами свойств и их значениями.

Возвращает:

Объект.

getRevision(){number} унаследованное Observable.js, строка 79

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

Возвращает:

Номер ревизии.

getStyle(){StyleLike | undefined} Feature.js, строка 211

Получение стиля объекта Feature. Вернёт то, что было передано в метод setStyle.

Возвращает:

Стиль объекта Feature.

getStyleFunction(){StyleFunction | undefined} Feature.js, строка 221

Получение функции стиля объекта Feature.

Возвращает:

Функция, представляющая текущий стиль этого объекта Feature.

on(type, listener){EventsKey | Array<EventsKey>} унаследованное Observable.js, строка 152

Прослушивание событий определенного типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованное Observable.js, строка 164

Прослушайте один раз определенный тип события.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

Возвращаемое значение:

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

set(key, value, silent) унаследованный Object.js, строка 215

Устанавливает значение.

Имя	Тип	Описание
`key`	string	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновление без срабатывания события.

setGeometry(geometry) Feature.js, строка 259

Устанавливает геометрию по умолчанию для объекта. Это обновит свойство с именем, возвращаемым getGeometryName.

Имя	Тип	Описание
`geometry`	Geometry \| undefined	Новая геометрия.

setGeometryName(name) Feature.js, строка 299

Устанавливает имя свойства, используемого при получении геометрии объекта по умолчанию. При вызове getGeometry будет возвращено значение свойства с этим именем.

Имя	Тип	Описание
`name`	string	Имя свойства геометрии по умолчанию.

setId(id) Feature.js, строка 287

Устанавливает идентификатор объекта. Идентификатор объекта считается стабильным и может использоваться при запросе объектов или сравнении идентификаторов, возвращаемых из удаленного источника. Идентификатор объекта может использоваться с методом getFeatureById.

Имя	Тип	Описание
`id`	number \| string \| undefined	Идентификатор объекта.

Срабатывает:

change (BaseEvent) - Общее событие изменения. Срабатывает при увеличении счетчика ревизий.

setProperties(values, silent) унаследованный Object.js, строка 235

Устанавливает коллекцию пар ключ-значение. Обратите внимание, что это изменяет любые существующие свойства и добавляет новые (это не удаляет какие-либо существующие свойства).

Имя	Тип	Описание
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновление без срабатывания события.

setStyle(style) Feature.js, строка 272

Устанавливает стиль для объекта, чтобы переопределить стиль слоя. Это может быть один объект стиля, массив стилей или функция, которая принимает разрешение и возвращает массив стилей. Чтобы сбросить стиль объекта, вызовите setStyle() без аргументов или ложное значение.

Имя	Тип	Описание
`style`	StyleLike \| undefined	Стиль для этого объекта.

Срабатывает:

change (BaseEvent) - Общее событие изменения. Срабатывает при увеличении счетчика ревизий.

un(type, listener) унаследованный Observable.js, строка 173

Отменить прослушивание определенного типа события.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

unset(key, silent) унаследованный Object.js, строка 259

Удаляет свойство.

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Удаление без срабатывания события.