v5 v4

Class: Icon

cercalia.Icon

The cercalia.Marker can contain icons. This icons can be created using this class. This icon can include rotation, transparency.
If icon option is not included in the cercalia.Marker constructor, by default cercalia API use the icon.

new cercalia.Icon(options)

temp/jsdocinputdirs/cercalia.icon.js, line 30
Name Type Description
options
Name Type Description
anchor Array.<number> | undefined optional

Anchor. Default value [0.5, 0.5].
opacity number | undefined optional

Icon opacity. Default value 1.
rotation number | undefined optional

Icon rotation. Default value 0.
size Array.<number> | undefined optional

Icon dimensions. Default value: [23, 33].
src string

Image path URL. Default cercalia icon: marker.png
scale number | undefined optional

Icon image resizing factor. Default value 1.

Methods

staticcercalia.Icon.createDefault()

temp/jsdocinputdirs/cercalia.icon.js, line 225

Default icon

getAnchor(){number}

temp/jsdocinputdirs/cercalia.icon.js, line 216
Returns:
opacity Return icon anchor

getClass(){string}

temp/jsdocinputdirs/cercalia.icon.js, line 236
Returns:
object ClassName

getIconStyle(){ol.style.Icon}

temp/jsdocinputdirs/cercalia.icon.js, line 130

Returns {ol.style.Icon} OpenLayers3 style icon

getOpacity(){number}

temp/jsdocinputdirs/cercalia.icon.js, line 200
Returns:
opacity Image opacity.

getRotation(){number}

temp/jsdocinputdirs/cercalia.icon.js, line 149
Returns:
Icon rotation (degrees).

getSize(){Array.<number>}

temp/jsdocinputdirs/cercalia.icon.js, line 173
Returns:
size

getSrc(){string}

temp/jsdocinputdirs/cercalia.icon.js, line 166
Returns:
Image URL

setAnchor(opacity)

temp/jsdocinputdirs/cercalia.icon.js, line 208

Set icon anchor

Name Type Description
opacity number

Opacity.

setOpacity(opacity)

temp/jsdocinputdirs/cercalia.icon.js, line 190

Returns the icon image source

Name Type Description
opacity number

Opacity.

setRotation(rotation)

temp/jsdocinputdirs/cercalia.icon.js, line 138

Apply a rotation, degrees.

Name Type Description
rotation string

degrees rotation.

setSize(size)

temp/jsdocinputdirs/cercalia.icon.js, line 181
Name Type Description
size Array.<number>

Size image source.
Deprecated
  • Yes

setSrc(src)

temp/jsdocinputdirs/cercalia.icon.js, line 158

Assign the icon image source

Name Type Description
src string

Image URL.