OpenLayers

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 module:ol/style/Icon~Icon, module:ol/style/Circle~CircleStyle and module:ol/style/RegularShape~RegularShape.

new ImageStyle(options)

style/Image.js, line 24
Name Type Description
options

Options.

Name Type Description
opacity number
rotateWithView boolean
rotation number
scale number

Subclasses

Methods

clone(){module:ol/style/Image~ImageStyle}

style/Image.js, line 61

Clones the style.

Returns:
The cloned style.

getOpacity(){number}

style/Image.js, line 75

Get the symbolizer opacity.

Returns:
Opacity.

getRotateWithView(){boolean}

style/Image.js, line 84

Determine whether the symbolizer rotates with the map.

Returns:
Rotate with map.

getRotation(){number}

style/Image.js, line 93

Get the symoblizer rotation.

Returns:
Rotation.

getScale(){number}

style/Image.js, line 102

Get the symbolizer scale.

Returns:
Scale.

getSnapToPixel(){boolean}

style/Image.js, line 112

This method is deprecated and always returns false.

Deprecated
  • Yes
Returns:
false.

setOpacity(opacity)

style/Image.js, line 193

Set the opacity.

Name Type Description
opacity number

Opacity.

setRotateWithView(rotateWithView)

style/Image.js, line 203

Set whether to rotate the style with the view.

Name Type Description
rotateWithView boolean

Rotate with map.

setRotation(rotation)

style/Image.js, line 213

Set the rotation.

Name Type Description
rotation number

Rotation.

setScale(scale)

style/Image.js, line 222

Set the scale.

Name Type Description
scale number

Scale.

setSnapToPixel(snapToPixel)

style/Image.js, line 232

This method is deprecated and does nothing.

Name Type Description
snapToPixel boolean

Snap to pixel?
Deprecated
  • Yes