Spec-Zone.ru › OpenLayers

ol/layer/Base~BaseLayer


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

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

new BaseLayer(options)

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

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

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

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

Граничный прямоугольник для отрисовки слоя. Слой не будет отрисовываться за пределами этого прямоугольника.
zIndex число | undefined

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

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

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

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

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

Цвет фона для слоя. Если не указан, фон не будет отрисован.
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

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

Имя Тип Устанавливаемое Тип события Описание
extent Extent | undefined да change:extent

Прямоугольник слоя.
maxResolution число да change:maxresolution

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

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

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

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

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

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

Индекс Z слоя.

Методы

changed() inherited

Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

Name Type Description
event BaseEvent | string

Объект события.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 135

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

Name Type Description
key string

Имя ключа.
Returns:
Value.

getExtent(){Extent | undefined}

layer/Base.js, line 207

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

Returns:
The layer extent.

getKeys(){Array.<string>} inherited

Object.js, line 148

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

Returns:
List of property names.

getMaxResolution(){number}

layer/Base.js, line 220

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

Returns:
The maximum resolution of the layer.

getMaxZoom(){number}

layer/Base.js, line 253

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

Returns:
The maximum zoom level of the layer.

getMinResolution(){number}

layer/Base.js, line 231

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

Returns:
The minimum resolution of the layer.

getMinZoom(){number}

layer/Base.js, line 242

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

Returns:
The minimum zoom level of the layer.

getOpacity(){number}

layer/Base.js, line 263

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

Returns:
The opacity of the layer.

getProperties(){Object.<string, *>} inherited

Object.js, line 157

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

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 79

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

Returns:
Revision.

getVisible(){boolean}

layer/Base.js, line 282

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

Returns:
The value of the visible property of the layer.

getZIndex(){number | undefined}

layer/Base.js, line 293

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

Returns:
The Z-index of the layer.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

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

Name Type Description
type string | Array.<string>

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

Функция прослушивателя.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

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

Name Type Description
type string | Array.<string>

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

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

set(key, value, silent) inherited

Object.js, line 215

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

Name Type Description
key string

Имя ключа.
value *

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

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

setExtent(extent)

layer/Base.js, line 313

Устанавливает область видимости слоя. Если undefined, слой будет видим при всех масштабах.

Name Type Description
extent Extent | undefined

Область видимости слоя.

setMaxResolution(maxResolution)

layer/Base.js, line 323

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

Name Type Description
maxResolution number

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

setMaxZoom(maxZoom)

layer/Base.js, line 345

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

Name Type Description
maxZoom number

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

setMinResolution(minResolution)

layer/Base.js, line 333

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

Name Type Description
minResolution number

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

setMinZoom(minZoom)

layer/Base.js, line 357

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

Name Type Description
minZoom number

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

setOpacity(opacity)

layer/Base.js, line 367

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

Name Type Description
opacity number

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

setProperties(values, silent) inherited

Object.js, line 235

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

Name Type Description
values Object.<string, *>

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

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

setVisible(visible)

layer/Base.js, line 378

Устанавливает видимость слоя (true или false).

Name Type Description
visible boolean

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

setZIndex(zindex)

layer/Base.js, line 389

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

Name Type Description
zindex number

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

un(type, listener) inherited

Observable.js, line 173

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

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

Тип события или массив типов событий.
listener функция

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

unset(ключ, немые) унаследованно

Object.js, строка 259

Сбросить свойство.

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

Имя ключа.
silent логическое | 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