ol/style/Icon~Icon
import Icon from 'ol/style/Icon.js';
Задаёт стиль значка для векторных объектов.
-
new Icon(options)
-
Имя Тип Описание anchorArray.<number> (по умолчанию [0.5, 0.5]) Точка привязки. По умолчанию — центр значка.
anchorOriginIconOrigin (по умолчанию 'top-left') Начало координат точки привязки:
bottom-left,bottom-right,top-leftилиtop-right.anchorXUnitsIconAnchorUnits (по умолчанию 'fraction') Единицы измерения, в которых задаётся значение x точки привязки. Значение
'fraction'означает, что значение x — это доля размера значка. Значение'pixels'означает, что значение x задаётся в пикселях.anchorYUnitsIconAnchorUnits (по умолчанию 'fraction') Единицы измерения, в которых задаётся значение y точки привязки. Значение
'fraction'означает, что значение y — это доля размера значка. Значение'pixels'означает, что значение y задаётся в пикселях.colorColor | string | undefined Цвет для тонирования значка. Если не задан, значок остаётся без изменений.
crossOriginnull | string | undefined Атрибут
crossOriginдля загруженных изображений. Обратите внимание: если вы хотите получить доступ к данным пикселей с помощью Canvas-рендерера, необходимо указать значениеcrossOrigin. Подробнее см. на странице https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.referrerPolicyReferrerPolicy | undefined Свойство
referrerPolicyдля загруженных изображений.imgHTMLImageElement | HTMLCanvasElement | OffscreenCanvas | ImageBitmap | undefined Объект изображения для значка.
displacementArray.<number> (по умолчанию [0, 0]) Смещение значка в пикселях. Положительные значения сдвигают значок вправо и вверх.
opacitynumber (по умолчанию 1) Непрозрачность значка.
widthnumber | undefined Ширина значка в пикселях. Нельзя использовать вместе с
scale.heightnumber | undefined Высота значка в пикселях. Нельзя использовать вместе с
scale.scalenumber | Size (по умолчанию 1) Масштаб.
rotateWithViewboolean (по умолчанию false) Следует ли поворачивать значок вместе с видом.
rotationnumber (по умолчанию 0) Угол поворота в радианах (положительное направление — по часовой стрелке).
offsetArray.<number> (по умолчанию [0, 0]) Смещение, которое вместе с
sizeиoffsetOriginзадаёт подпрямоугольник исходного изображения (спрайта), используемый для отображения.offsetOriginIconOrigin (по умолчанию 'top-left') Начало координат смещения:
bottom-left,bottom-right,top-leftилиtop-right.sizeSize | undefined Размер значка в пикселях. Используется вместе с
offsetдля задания подпрямоугольника исходного изображения (спрайта), который будет отображаться.srcstring | undefined URI источника изображения.
declutterModeDeclutterMode | undefined Режим устранения наложений.
Наследует от
Методы
-
clone(){Icon}
-
Создаёт копию стиля. Базовое изображение Image/HTMLCanvasElement не копируется.
Возвращает:
Копию стиля.
-
getAnchor(){Array.<number>}
-
Возвращает точку привязки в пикселях. Точка привязки задаёт центральную точку символа.
Возвращает:
Точка привязки.
-
getColor(){Color}
-
Возвращает цвет значка.
Возвращает:
Цвет.
-
getDeclutterMode(){DeclutterMode} унаследовано
-
Возвращает режим устранения наложений фигуры.
Возвращает:
Режим устранения наложений фигуры
-
getDisplacement(){Array.<number>} унаследовано
-
Возвращает смещение фигуры.
Возвращает:
Смещение центра фигуры
-
getHeight(){number}
-
Возвращает высоту значка (в пикселях). Если изображение значка ещё не загружено, возвращает undefined.
Возвращает:
Высота значка (в пикселях).
-
getImage(pixelRatio){HTMLImageElement | HTMLCanvasElement | OffscreenCanvas | ImageBitmap}
-
Возвращает изображение значка.
Имя Тип Описание pixelRationumber Коэффициент плотности пикселей.
Возвращает:
Элемент Image или Canvas. Если для стиля Icon заданsrcили ещё не загруженныйimg, будет возвращёнImageBitmap.
-
getOpacity(){number} унаследовано
-
Возвращает непрозрачность символа.
Возвращает:
Непрозрачность.
-
getOrigin(){Array.<number>}
-
Возвращает начало координат символа.
Возвращает:
Начало координат.
-
getPixelRatio(pixelRatio){number}
-
Возвращает коэффициент плотности пикселей.
Имя Тип Описание pixelRationumber Коэффициент плотности пикселей.
Возвращает:
Коэффициент плотности пикселей изображения.
-
getRotateWithView(){boolean} унаследовано
-
Определяет, поворачивается ли символ вместе с картой.
Возвращает:
Поворачивать вместе с картой.
-
getRotation(){number} унаследовано
-
Возвращает угол поворота символа.
Возвращает:
Угол поворота.
-
getScale(){number | Size} унаследовано
-
Возвращает масштаб символа.
Возвращает:
Масштаб.
-
getSize(){Size}
-
Возвращает размер значка (в пикселях).
Возвращает:
Размер изображения.
-
getSrc(){string | undefined}
-
Возвращает URL изображения.
Возвращает:
Источник изображения.
-
getWidth(){number}
-
Возвращает ширину значка (в пикселях). Если изображение значка ещё не загружено, возвращает undefined.
Возвращает:
Ширина значка (в пикселях).
-
load()
-
Загружает ещё не загруженный URI. При отображении объекта со стилем значка векторный рендерер автоматически вызывает этот метод. Однако вы можете вызвать его самостоятельно для предварительной загрузки или других целей.
-
setAnchor(anchor)
-
Задаёт точку привязки. Точка привязки задаёт центральную точку символа.
Имя Тип Описание anchorArray.<number> Точка привязки.
-
setDisplacement(displacement) унаследовано
-
Задаёт смещение.
Имя Тип Описание displacementArray.<number> Смещение.
-
setOpacity(opacity) унаследовано
-
Задаёт непрозрачность.
Имя Тип Описание opacitynumber Непрозрачность.
-
setRotateWithView(rotateWithView) унаследовано
-
Задаёт, следует ли поворачивать стиль вместе с видом.
Имя Тип Описание rotateWithViewboolean Поворачивать вместе с картой.
-
setRotation(rotation) унаследовано
-
Задаёт угол поворота.
Имя Тип Описание rotationnumber Угол поворота.
-
setScale(scale)
-
Задаёт масштаб.
Имя Тип Описание scalenumber | Size Масштаб.
-
setSrc(src)
-
Задаёт URI изображения.
Имя Тип Описание srcstring 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