Spec-Zone.ru › OpenLayers

ol/source/Source~Источник


import Source from 'ol/source/Source.js';

Абстрактный базовый класс; обычно используется только для создания подклассов и не создается в приложениях. Базовый класс для Layer источников.

Общее событие change срабатывает при изменении состояния источника.

новый Источник(options)

source/Source.js, строка 51
Имя Тип Описание
attributions AttributionLike | undefined

Подписи.

attributionsCollapsible boolean (по умолчанию true)

Подписи сворачиваются.

projection ProjectionLike | undefined

Проекция. По умолчанию — проекция вида.

state State (по умолчанию 'ready')

Состояние.

wrapX boolean (по умолчанию false)

WrapX.

interpolate boolean (по умолчанию false)

Использовать интерполированные значения при ресемплировании. По умолчанию используется ближайший сосед при ресемплировании.

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

Подклассы

  • ImageSource
  • TileSource
  • VectorSource

Расширяет

  • BaseObject

Методы

changed() унаследованный

Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследованный

events/Target.js, строка 85

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

Имя Тип Описание
event BaseEvent | строка

Объект события.

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

get(key){*} унаследованный

Object.js, строка 135

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

Имя Тип Описание
key строка

Имя ключа.

Возвращает:
Значение.

getAttributions(){Attribution}

source/Source.js, строка 129

Получить функцию атрибуции для источника.

Возвращает:
Функция атрибуции.

getAttributionsCollapsible(){boolean}

source/Source.js, строка 137
Возвращает:
Атрибуты можно сворачивать.

getKeys(){Array.<string>} унаследованный

Object.js, строка 148

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

Возвращает:
Список имён свойств.

getProjection(){Projection | null}

source/Source.js, строка 146

Получить проекцию источника.

Возвращает:
Проекция.

getProperties(){Object.<string, *>} унаследованный

Object.js, строка 157

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

Возвращает:
Объект.

getRevision(){number} унаследованный

Observable.js, строка 79

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

Возвращает:
Номер ревизии.

getState(){State}

source/Source.js, строка 170

Получить состояние источника, см. State для возможных состояний.

Возвращает:
Состояние.

on(type, listener){EventsKey | Array<EventsKey>} унаследованный

Observable.js, строка 152

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

Имя Тип Описание
type строка | Array.<string>

Тип события или массив типов событий.

listener функция

Функция слушателя.

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованный

Observable.js, строка 164

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

Имя Тип Описание
type строка | Array.<string>

Тип события или массив типов событий.

listener функция

Функция слушателя.

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

refresh()

source/Source.js, строка 192

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

set(key, value, silent) унаследованный

Object.js, строка 215

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

Имя Тип Описание
key string

Имя ключа.

value *

Значение.

silent boolean | undefined

Обновить без срабатывания события.

setAttributions(attributions)

source/Source.js, line 203

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

Имя Тип Описание
attributions AttributionLike | undefined

Атрибуты. Могут быть переданы как string, Array<string>, Attribution, или undefined.

setProperties(values, silent) унаследованный

Object.js, line 235

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

Имя Тип Описание
values Object.<string, *>

Значения.

silent boolean | undefined

Обновить без срабатывания события.

un(type, listener) унаследованный

Observable.js, line 173

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

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

unset(key, silent) унаследованный

Object.js, line 259

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

Имя Тип Описание
key string

Имя ключа.

silent boolean | undefined

Удалить без срабатывания события.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_source_Source-Source.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API