v5 v4

Class: Popup

cercalia.Popup

Let you create a window related to marker, where to paint information in HTML format.
Based on ol.Overlay class

temp/jsdocinputdirs/cercalia.popup.js, line 11
Name Type Description
options
Name Type Description
closeOnClick boolean | undefined optional

Close popup when click on it. Default value false.
content string

HTML Popup content
customPopup boolean | undefined optional

Boolean indicating whether you want to use a custom popup, where the user adjusts the CSS styles from the elements. Default value: false
maxWidth number | undefined optional

Popup maximum width, in pixels. Default value 200px
offset Array.<number> | undefined optional

Popup offset, in pixels, format [x, y]. For example [20, -5]. It's necessary to note the positioning option value. Only apply when option customPopup=true
positioning string | undefined optional

Popup position. Values: 'top-left', 'top-center', 'top-right', 'bottom-left', 'bottom-center', 'bottom-right'. Default: 'bottom-left'. Only apply when option customPopup=true
title string | undefined optional

Popup title. Default value: 'Info'
visible boolean | undefined optional

Boolean indicating if Popup is initially visible. Default value: false
zIndex number | undefined optional

zIndex popup value (css) . Default 1000

Methods

destroy()

temp/jsdocinputdirs/cercalia.popup.js, line 314

Destroy popup and clean the marker reference to this popup

getClass(){string}

temp/jsdocinputdirs/cercalia.popup.js, line 380
Returns:
ClassName. Value : cercalia.Popup.

getContent(){string}

temp/jsdocinputdirs/cercalia.popup.js, line 373

getMarker(){cercalia.Marker}

temp/jsdocinputdirs/cercalia.popup.js, line 250
Returns:
marker Obtain the marker related to this Popup, null if there's none assigned

getOffset(){Array.<number>}

temp/jsdocinputdirs/cercalia.popup.js, line 242
Returns:
Popup Offset

getOverlay(){ol.Overlay}

temp/jsdocinputdirs/cercalia.popup.js, line 211
Returns:
The popup object ol.Overlay

getPosition(){number}

temp/jsdocinputdirs/cercalia.popup.js, line 227
Returns:
Popup Position

getZIndex(){number|String}

temp/jsdocinputdirs/cercalia.popup.js, line 306
Returns:
ZIndex value

hide(fade)

temp/jsdocinputdirs/cercalia.popup.js, line 280

Hide the popup

Name Type Description
fade boolean

Indicates whether to apply the 'fadeOut' animation effect

isOpen(){boolean}

temp/jsdocinputdirs/cercalia.popup.js, line 258
Returns:
visible Returns if it's visible

setContent(htmlContent)

temp/jsdocinputdirs/cercalia.popup.js, line 347

Change the popup body using Cambia a string with the HTML content

Name Type Description
htmlContent string | Object

Body popup HTML content (string, jQuery Object or DOM element).

setOffset(offset)

temp/jsdocinputdirs/cercalia.popup.js, line 235

Sets the popup position

Name Type Description
offset Array.<number>

Couple of values ​​for the offset.

setPosition(lonLat, projectionCode)

temp/jsdocinputdirs/cercalia.popup.js, line 220

Sets the popup position

Name Type Description
lonLat cercalia.LonLat
projectionCode string

setTitle(htmlContent)

temp/jsdocinputdirs/cercalia.popup.js, line 339

Change the popup title using a string with the HTML content

Name Type Description
htmlContent string

Popup title HTML content

setZIndex(zIndex)

temp/jsdocinputdirs/cercalia.popup.js, line 295

Change the popup zIndex

Name Type Description
zIndex number | String

ZIndex value (numerical value or 'auto')

show(fade)

temp/jsdocinputdirs/cercalia.popup.js, line 266

Open the popup

Name Type Description
fade boolean

Indicates whether to apply 'fadeIn' animation effect