Class: Icon

ol/style/Icon~Icon


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

为矢量要素设置图标样式。

new Icon(options)

Name Type Description
anchor Array.<number> (defaults to [0.5, 0.5])

锚点。默认值为图标中心。

anchorOrigin IconOrigin (defaults to 'top-left') 锚点原点:bottom-left、bottom-right、top-left 或 top-right。
anchorXUnits IconAnchorUnits (defaults to 'fraction')

锚点 x 值的指定单位。'fraction' 表示 x 值是图标的比例。'pixels' 表示 x 值以像素为单位。

anchorYUnits IconAnchorUnits (defaults to '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

图标的图像对象。

偏移量 Array.<number> (defaults to [0, 0])

图标的偏移量(像素)。正值将使图标向右和向上偏移。

opacity number (defaults to 1)

图标的不透明度。

width number | undefined

图标宽度(像素)。不能与 scale 一起使用。

height number | undefined

图标高度(像素)。不能与 scale 一起使用。

scale number | Size (defaults to 1)

比例。

rotateWithView boolean (defaults to false)

图标是否随视图旋转。

rotation number (defaults to 0)

旋转角度(弧度,正值为顺时针)。

offset Array.<number> (defaults to [0, 0])

偏移量,与 sizeoffsetOrigin 一起定义要从原始(精灵)图像中使用的子矩形。

offsetOrigin IconOrigin (defaults to 'top-left') 偏移原点:bottom-left、bottom-right、top-left 或 top-right。
size Size | undefined

图标尺寸(像素)。与 offset 一起使用,以定义要从原始(精灵)图像中使用的子矩形。

src string | undefined

图像源 URI。

declutterMode DeclutterMode | undefined

去重模式。

Extends

Methods

克隆样式。 The underlying Image/HTMLCanvasElement is not cloned.

返回值:
The cloned style.

getAnchor(){Array.<number>}

获取锚点(像素)。锚点决定符号化器的中心点。

返回值:
锚点。

获取icon color.

返回值:
颜色。

获取形状的去重叠模式

返回值:
Shape's declutter mode

getDisplacement(){Array.<number>} inherited

获取偏移量 of the shape

返回值:
Shape's center 偏移量

getHeight(){number}

获取图标高度(像素)。当图标图像尚未加载时返回 undefined。

返回值:
Icon height (in pixels).

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

获取image icon.

Name Type Description
pixelRatio number

像素比。

返回值:
Image or Canvas element. If the Icon style was configured with src or with a not let loaded img, an ImageBitmap will be returned.

getOpacity(){number} inherited

获取symbolizer opacity.

返回值:
不透明度。

getOrigin(){Array.<number>}

获取origin of the symbolizer.

返回值:
Origin.

getPixelRatio(pixelRatio){number}

获取pixel ratio.

Name Type Description
pixelRatio number

像素比。

返回值:
The pixel ratio of the image.

getRotateWithView(){boolean} inherited

判断符号化器是否随地图旋转。

返回值:
随地图旋转。

getRotation(){number} inherited

获取symoblizer rotation.

返回值:
旋转角度。

getScale(){number | Size} inherited

获取symbolizer scale.

返回值:
比例。

获取图标大小(像素)。

返回值:
Image size.

getSrc(){string | undefined}

获取image URL.

返回值:
Image src.

getWidth(){number}

获取图标宽度(像素)。当图标图像尚未加载时返回 undefined。

返回值:
Icon width (in pixels).

加载尚未加载的 URI。当使用图标样式渲染要素时,矢量渲染器将自动调用此方法。但是,您可能需要自行调用此方法进行预加载或其他目的。

setAnchor(anchor)

设置anchor point. The anchor determines the center point for the symbolizer.

Name Type Description
anchor Array.<number>

锚点。

setDisplacement(偏移量) inherited

设置偏移量.

Name Type Description
偏移量 Array.<number>

偏移量。

setOpacity(opacity) inherited

设置不透明度。

Name Type Description
opacity number

不透明度。

setRotateWithView(rotateWithView) inherited

设置样式是否随视图旋转。

Name Type Description
rotateWithView boolean

随地图旋转。

setRotation(rotation) inherited

设置旋转角度。

Name Type Description
rotation number

旋转角度。

setScale(scale)

设置比例。

Name Type Description
scale number | Size

比例。

setSrc(src)

设置image URI

Name Type Description
src string

图像源 URI