Class: ImageStyle

ol/style/Image~ImageStyle


import ImageStyle from 'ol/style/Image';

A base class used for creating subclasses and not instantiated in apps. Base class for Icon, CircleStyle and RegularShape.

new ImageStyle(options)

Name Type Description
opacity number

Opacity.

rotateWithView boolean

If the image should get rotated with the view.

rotation number

Rotation.

scale number | Size

Scale.

displacement Array.<number>

Displacement.

declutterMode "declutter" | "obstacle" | "none" | undefined

Declutter mode: declutter, obstacle, 'none

Subclasses

Methods

Clones the style.

Returns:
The cloned style.

getDeclutterMode(){"declutter" | "obstacle" | "none" | undefined}

Get the declutter mode of the shape

Returns:
Shape's declutter mode

getDisplacement(){Array.<number>}

Get the displacement of the shape

Returns:
Shape's center displacement

getOpacity(){number}

Get the symbolizer opacity.

Returns:
Opacity.

getRotateWithView(){boolean}

Determine whether the symbolizer rotates with the map.

Returns:
Rotate with map.

getRotation(){number}

Get the symoblizer rotation.

Returns:
Rotation.

getScale(){number | Size}

Get the symbolizer scale.

Returns:
Scale.

setDisplacement(displacement)

Set the displacement.

Name Type Description
displacement Array.<number>

Displacement.

setOpacity(opacity)

Set the opacity.

Name Type Description
opacity number

Opacity.

setRotateWithView(rotateWithView)

Set whether to rotate the style with the view.

Name Type Description
rotateWithView boolean

Rotate with map.

setRotation(rotation)

Set the rotation.

Name Type Description
rotation number

Rotation.

setScale(scale)

Set the scale.

Name Type Description
scale number | Size

Scale.