Spec-Zone.ru › OpenLayers

ol/style/Icon~Icon


import Icon from 'ol/style/Icon.js';

Задаёт стиль значка для векторных объектов.

new Icon(options)

style/Icon.js, строка 83
Имя Тип Описание
anchor Array.<number> (по умолчанию [0.5, 0.5])

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

anchorOrigin IconOrigin (по умолчанию 'top-left')

Начало координат точки привязки: bottom-left, bottom-right, top-left или top-right.

anchorXUnits IconAnchorUnits (по умолчанию 'fraction')

Единицы измерения, в которых задаётся значение x точки привязки. Значение 'fraction' означает, что значение x — это доля размера значка. Значение 'pixels' означает, что значение x задаётся в пикселях.

anchorYUnits IconAnchorUnits (по умолчанию 'fraction')

Единицы измерения, в которых задаётся значение y точки привязки. Значение 'fraction' означает, что значение y — это доля размера значка. Значение 'pixels' означает, что значение y задаётся в пикселях.

color Color | string | undefined

Цвет для тонирования значка. Если не задан, значок остаётся без изменений.

crossOrigin null | string | undefined

Атрибут crossOrigin для загруженных изображений. Обратите внимание: если вы хотите получить доступ к данным пикселей с помощью Canvas-рендерера, необходимо указать значение crossOrigin. Подробнее см. на странице https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.

referrerPolicy ReferrerPolicy | undefined

Свойство referrerPolicy для загруженных изображений.

img HTMLImageElement | HTMLCanvasElement | OffscreenCanvas | ImageBitmap | undefined

Объект изображения для значка.

displacement Array.<number> (по умолчанию [0, 0])

Смещение значка в пикселях. Положительные значения сдвигают значок вправо и вверх.

opacity number (по умолчанию 1)

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

width number | undefined

Ширина значка в пикселях. Нельзя использовать вместе с scale.

height number | undefined

Высота значка в пикселях. Нельзя использовать вместе с scale.

scale number | Size (по умолчанию 1)

Масштаб.

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

Следует ли поворачивать значок вместе с видом.

rotation number (по умолчанию 0)

Угол поворота в радианах (положительное направление — по часовой стрелке).

offset Array.<number> (по умолчанию [0, 0])

Смещение, которое вместе с size и offsetOrigin задаёт подпрямоугольник исходного изображения (спрайта), используемый для отображения.

offsetOrigin IconOrigin (по умолчанию 'top-left')

Начало координат смещения: bottom-left, bottom-right, top-left или top-right.

size Size | undefined

Размер значка в пикселях. Используется вместе с offset для задания подпрямоугольника исходного изображения (спрайта), который будет отображаться.

src string | undefined

URI источника изображения.

declutterMode DeclutterMode | undefined

Режим устранения наложений.

Наследует от

  • ImageStyle

Методы

clone(){Icon}

style/Icon.js, строка 304

Создаёт копию стиля. Базовое изображение Image/HTMLCanvasElement не копируется.

Возвращает:
Копию стиля.

getAnchor(){Array.<number>}

style/Icon.js, строка 346

Возвращает точку привязки в пикселях. Точка привязки задаёт центральную точку символа.

Возвращает:
Точка привязки.

getColor(){Color}

style/Icon.js, строка 416

Возвращает цвет значка.

Возвращает:
Цвет.

getDeclutterMode(){DeclutterMode} унаследовано

style/Image.js, строка 148

Возвращает режим устранения наложений фигуры.

Возвращает:
Режим устранения наложений фигуры

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

style/Image.js, строка 139

Возвращает смещение фигуры.

Возвращает:
Смещение центра фигуры

getHeight(){number}

style/Icon.js, строка 600

Возвращает высоту значка (в пикселях). Если изображение значка ещё не загружено, возвращает undefined.

Возвращает:
Высота значка (в пикселях).

getImage(pixelRatio){HTMLImageElement | HTMLCanvasElement | OffscreenCanvas | ImageBitmap}

style/Icon.js, строка 467

Возвращает изображение значка.

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

Коэффициент плотности пикселей.

Возвращает:
Элемент Image или Canvas. Если для стиля Icon задан src или ещё не загруженный img, будет возвращён ImageBitmap.

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

style/Image.js, строка 95

Возвращает непрозрачность символа.

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

getOrigin(){Array.<number>}

style/Icon.js, строка 512

Возвращает начало координат символа.

Возвращает:
Начало координат.

getPixelRatio(pixelRatio){number}

style/Icon.js, строка 478

Возвращает коэффициент плотности пикселей.

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

Коэффициент плотности пикселей.

Возвращает:
Коэффициент плотности пикселей изображения.

getRotateWithView(){boolean} унаследовано

style/Image.js, строка 104

Определяет, поворачивается ли символ вместе с картой.

Возвращает:
Поворачивать вместе с картой.

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

style/Image.js, строка 113

Возвращает угол поворота символа.

Возвращает:
Угол поворота.

getScale(){number | Size} унаследовано

style/Image.js, строка 122

Возвращает масштаб символа.

Возвращает:
Масштаб.

getSize(){Size}

style/Icon.js, строка 575

Возвращает размер значка (в пикселях).

Возвращает:
Размер изображения.

getSrc(){string | undefined}

style/Icon.js, строка 547

Возвращает URL изображения.

Возвращает:
Источник изображения.

getWidth(){number}

style/Icon.js, строка 584

Возвращает ширину значка (в пикселях). Если изображение значка ещё не загружено, возвращает undefined.

Возвращает:
Ширина значка (в пикселях).

load()

style/Icon.js, строка 639

Загружает ещё не загруженный URI. При отображении объекта со стилем значка векторный рендерер автоматически вызывает этот метод. Однако вы можете вызвать его самостоятельно для предварительной загрузки или других целей.

setAnchor(anchor)

style/Icon.js, строка 406

Задаёт точку привязки. Точка привязки задаёт центральную точку символа.

Имя Тип Описание
anchor Array.<number>

Точка привязки.

setDisplacement(displacement) унаследовано

style/Image.js, строка 229

Задаёт смещение.

Имя Тип Описание
displacement Array.<number>

Смещение.

setOpacity(opacity) унаследовано

style/Image.js, строка 239

Задаёт непрозрачность.

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

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

setRotateWithView(rotateWithView) унаследовано

style/Image.js, строка 249

Задаёт, следует ли поворачивать стиль вместе с видом.

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

Поворачивать вместе с картой.

setRotation(rotation) унаследовано

style/Image.js, строка 259

Задаёт угол поворота.

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

Угол поворота.

setScale(scale)

style/Icon.js, строка 618

Задаёт масштаб.

Имя Тип Описание
scale number | Size

Масштаб.

setSrc(src)

style/Icon.js, строка 556

Задаёт URI изображения.

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

URI источника изображения.

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

Spec-Zone.ru

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