Spec-Zone.ru › OpenLayers

ol/layer/Base~BaseLayer 


import BaseLayer from 'ol/layer/Base.js';

Абстрактный базовый класс; обычно используется только для создания подклассов и не создаётся в приложениях. Обратите внимание: для BaseLayer и всех его подклассов любое свойство, заданное в параметрах, устанавливается как свойство BaseObject объекта слоя, поэтому за ним можно наблюдать, и для него доступны методы чтения и записи.

new BaseLayer(options)

layer/Base.js, строка 66
Имя Тип Описание
className string (по умолчанию 'ol-layer')

Имя класса CSS, задаваемое элементу слоя.
opacity number (по умолчанию 1)

Непрозрачность (0, 1).
visible boolean (по умолчанию true)

Видимость.
extent Extent | undefined

Ограничивающая область для отображения слоя. За пределами этой области слой отображаться не будет.
zIndex number | undefined

Z-индекс для отображения слоя. Во время отображения слои упорядочиваются сначала по Z-индексу, а затем по положению. Если задано undefined, для слоёв, добавленных в коллекцию layers карты, предполагается значение zIndex, равное 0, а также Infinity, если был использован метод setMap() слоя.
minResolution number | undefined

Минимальное разрешение (включительно), при котором этот слой будет виден.
maxResolution number | undefined

Максимальное разрешение (исключительно), ниже которого этот слой будет виден.
minZoom number | undefined

Минимальный уровень масштабирования вида (исключительно), выше которого этот слой будет виден.
maxZoom number | undefined

Максимальный уровень масштабирования вида (включительно), при котором этот слой будет виден.
background BackgroundColor | undefined

Цвет фона слоя. Если он не задан, фон отображаться не будет.
properties Properties | undefined

Произвольные наблюдаемые свойства. Доступ к ним можно получить с помощью #get() и #set().
События:
  • change (BaseEvent) — общее событие изменения. Вызывается при увеличении счётчика ревизии.
  • change:extent (ObjectEvent)
  • change:maxResolution (ObjectEvent)
  • change:maxZoom (ObjectEvent)
  • change:minResolution (ObjectEvent)
  • change:minZoom (ObjectEvent)
  • change:opacity (ObjectEvent)
  • change:visible (ObjectEvent)
  • change:zIndex (ObjectEvent)
  • error (BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки.
  • propertychange (ObjectEvent) — вызывается при изменении свойства.

Подклассы

  • LayerGroup
  • Layer

Расширяет

  • BaseObject

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

Имя Тип Можно задать тип ObjectEvent Описание
extent Extent | undefined да change:extent

Область слоя.
maxResolution number да change:maxresolution

Максимальное разрешение слоя.
maxZoom number да change:maxzoom

Максимальный уровень масштабирования слоя.
minResolution number да change:minresolution

Минимальное разрешение слоя.
minZoom number да change:minzoom

Минимальный уровень масштабирования слоя.
opacity number да change:opacity

Непрозрачность слоя.
visible boolean да change:visible

Значение свойства visible слоя.
zIndex number | undefined да change:zindex

Z-индекс слоя.

Методы

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

Observable.js, строка 68

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

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

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

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

Имя Тип Описание
event BaseEvent | string

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

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

Object.js, строка 136

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

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

Имя ключа.
Возвращает:
Значение.

getExtent(){Extent | undefined}

layer/Base.js, строка 210

Возвращает extent слоя или undefined, если слой будет виден независимо от экстента.

Возвращает:
Экстент слоя.

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

Object.js, строка 149

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

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

getMaxResolution(){number}

layer/Base.js, строка 223

Возвращает максимальное разрешение слоя. Возвращает Infinity, если для слоя не задано максимальное разрешение.

Возвращает:
Максимальное разрешение слоя.

getMaxZoom(){number}

layer/Base.js, строка 256

Возвращает максимальный уровень масштабирования слоя. Возвращает Infinity, если для слоя не задан максимальный уровень масштабирования.

Возвращает:
Максимальный уровень масштабирования слоя.

getMinResolution(){number}

layer/Base.js, строка 234

Возвращает минимальное разрешение слоя. Возвращает 0, если для слоя не задано минимальное разрешение.

Возвращает:
Минимальное разрешение слоя.

getMinZoom(){number}

layer/Base.js, строка 245

Возвращает минимальный уровень масштабирования слоя. Возвращает -Infinity, если для слоя не задан минимальный уровень масштабирования.

Возвращает:
Минимальный уровень масштабирования слоя.

getOpacity(){number}

layer/Base.js, строка 266

Возвращает непрозрачность слоя (от 0 до 1).

Возвращает:
Непрозрачность слоя.

getProperties(){NoInfer.<Properties>} унаследовано

Object.js, строка 158

Возвращает объект со всеми именами свойств и их значениями.

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

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

Observable.js, строка 79

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

Возвращает:
Ревизия.

getVisible(){boolean}

layer/Base.js, строка 285

Возвращает значение свойства visible этого слоя. Чтобы узнать, виден ли слой на карте, используйте вместо этого isVisible().

Возвращает:
Значение свойства visible слоя.

getZIndex(){number | undefined}

layer/Base.js, строка 296

Возвращает Z-индекс слоя, который используется для упорядочивания слоёв перед отрисовкой. Возвращает undefined, если слой не управляется.

Возвращает:
Z-индекс слоя.

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, строка 218

Задаёт значение.

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

Имя ключа.
value *

Значение.
silent boolean | undefined

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

setExtent(extent)

layer/Base.js, строка 316

Задаёт экстент, в пределах которого слой виден. Если undefined, слой будет виден при любом экстенте.

Имя Тип Описание
extent Extent | undefined

Экстент слоя.

setMaxResolution(maxResolution)

layer/Base.js, строка 326

Задаёт максимальное разрешение, при котором слой виден.

Имя Тип Описание
maxResolution number

Максимальное разрешение слоя.

setMaxZoom(maxZoom)

layer/Base.js, строка 348

Задаёт максимальный уровень масштабирования (не включая его), при котором слой виден. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования представления, который может отличаться от уровня масштабирования источника тайлов.

Имя Тип Описание
maxZoom number

Максимальный уровень масштабирования слоя.

setMinResolution(minResolution)

layer/Base.js, строка 336

Задаёт минимальное разрешение, при котором слой виден.

Имя Тип Описание
minResolution number

Минимальное разрешение слоя.

setMinZoom(minZoom)

layer/Base.js, строка 360

Задаёт минимальный уровень масштабирования (включая его), при котором слой виден. Обратите внимание, что уровни масштабирования для видимости слоя основаны на уровне масштабирования представления, который может отличаться от уровня масштабирования источника тайлов.

Имя Тип Описание
minZoom number

Минимальный уровень масштабирования слоя.

setOpacity(opacity)

layer/Base.js, строка 370

Задаёт непрозрачность слоя; допустимые значения находятся в диапазоне от 0 до 1.

Имя Тип Описание
opacity number

Непрозрачность слоя.

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

Object.js, строка 238

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

Имя Тип Описание
values Partial.<NoInfer.<Properties>>

Значения.
silent boolean | undefined

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

setVisible(visible)

layer/Base.js, строка 381

Задаёт видимость слоя (true или false).

Имя Тип Описание
visible boolean

Видимость слоя.

setZIndex(zindex)

layer/Base.js, строка 392

Задаёт Z-индекс слоя, который используется для упорядочивания слоёв перед отрисовкой. Z-индекс по умолчанию равен 0.

Имя Тип Описание
zindex number

Z-индекс слоя.

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

Observable.js, строка 173

Прекращает ожидание события определённого типа.

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

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

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

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

Object.js, строка 262

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

Имя Тип Описание
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_layer_Base-BaseLayer.html

Spec-Zone.ru

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