Constructor

# new Icon(opts)

Initialization object

Parameters:

Name	Type	Attributes	Default	Description
`opts`	object			Options
`rotateWithView`	boolean	<optional>		If the image should get rotated with the view.
`rotation`	number	<optional>		Rotation.
`scale`	number	<optional>		Scale.
`displacement`	number	<optional>		Displacement.
`anchor`	Array.<number>	<optional>	[0.5, 0.5]	Anchor. Default value is the icon center.
`color`	string	<optional>		Color to tint the icon. If not specified, the icon will be left as is.
`offset`	Array.<number>	<optional>	[0, 0]	Offset, which, together with the size and the offset origin, define the sub-rectangle to use from the original icon image.
`displacement`	Array.<number>	<optional>	[0,0]	Displacement the icon
`offsetOrigin`	string	<optional>	'top-left'	Origin of the offset: `bottom-left`, `bottom-right`, `top-left` or `top-right`.
`opacity`	number	<optional>	1	Opacity of the icon.
`scale`	number	<optional>	1	Scale.
`rotateWithView`	boolean	<optional>	false	Whether to rotate the icon with the view.
`rotation`	number	<optional>	0	Rotation in radians (positive rotation clockwise).
`size`	number	<optional>		Icon size in pixel. Can be used together with `offset` to define the sub-rectangle to use from the origin (sprite) icon image.
`imgSize`	number	<optional>		Image size in pixels. Only required if `img` is set and `src` is not, and for SVG images in Internet Explorer 11. The provided `imgSize` needs to match the actual size of the image.
`src`	string	<optional>		Image source URI.

Tutorials:

Classes

Icon

Methods

# getAnchor() → {Array.<number>}

Get the anchor point in pixels. The anchor determines the center point for the symbolizer.

Returns:

Anchor.

Type: Array.<number>

# getDisplacement() → {Array.<number>}

Get the displacement of the shape

Returns:

Shape's center displacement

Type: Array.<number>

# getFill() → {Fill}

Get the fill style for the shape.

Returns:

Fill style.

Type: Fill

# getOpacity() → {number}

Get the symbolizer opacity.

Returns:

Opacity.

Type: number

# getRotateWithView() → {boolean}

Determine whether the symbolizer rotates with the map.

Returns:

Rotate with map.

Type: boolean

# getRotation() → {number}

Get the symoblizer rotation.

Returns:

Rotation.

Type: number

# getScale() → {number}

Get the symbolizer scale.

Returns:

Scale.

Type: number

# getSize() → {Array.<number>}

Get the size of the symbolizer (in pixels).

Returns:

Size.

Type: Array.<number>

# getSrc() → {string}

Get the image URL.

Returns:

Image src.

Type: string

# getStroke() → {Stroke}

Get the stroke style for the shape.

Returns:

Stroke style.

Type: Stroke

# setOpacity(opacity)

Set the opacity.

Parameters:

Name	Type	Description
`opacity`	number	Opacity.

# setRotateWithView(rotateWithView)

Set whether to rotate the style with the view.

Parameters:

Name	Type	Description
`rotateWithView`	boolean	Rotate with map.

# setRotation(rotation)

Set the rotation.

Parameters:

Name	Type	Description
`rotation`	number	Rotation.

# setScale(scale)

Set the scale.

Parameters:

Name	Type	Description
`scale`	number	Scale.