Class: MapPopupCls

MapPopupCls

map popup class

Constructor

new MapPopupCls()

map popup constructor
Source:

Extends

Members

_passThroughLayerFeatureArray :Array.<_FeatureLayerProperties>

Type:
Source:

_passThroughLayerFeatureArray :Array.<_FeatureLayerProperties>

Type:
Source:

initialized

get if is initialized
Inherited From:
Source:

map

get reference to the ol map object
Inherited From:
Source:

Methods

(protected) _checkInit()

Check the initialization status and throw exception if not valid yet
Inherited From:
Source:

addMapClickFunction(func)

Add a function to be called when the map is clicked but before any popups are implemented
Parameters:
Name Type Description
func function the map click function
Source:

addMapServicePopup(lyr, selectionStyleopt) → {object}

Parameters:
Name Type Attributes Default Description
lyr LayerEsriMapServer map server layer
selectionStyle object <optional>
{} the selection style configuration
Properties
Name Type Attributes Default Description
color string <optional>
rgba(255,170,0,0.5) the selection color
width number <optional>
10 the selection width for linear features
olStyle object | function <optional>
an openlayers style object or function
Source:
Returns:
a reference to the ol selection layer
Type
object

addMapServicePopupContent(feature, lyr, popupContent, esriName)

Parameters:
Name Type Description
feature ol.Feature the ol feature
lyr LayerEsriMapServer the map server layer
popupContent string popup content
esriName string esri layer name
Source:

addPopupChangedFunction(chgFunction)

Parameters:
Name Type Description
chgFunction popupChangedFunction popup change function
Source:

addVectorPopup(lyr, popupContentFunction, selectionStyleopt) → {object}

Add popup to the map
Parameters:
Name Type Attributes Default Description
lyr LayerBase | * The layer that the popup with act on
popupContentFunction popupCallback popup content function that makes popup info
selectionStyle object <optional>
{} the selection style configuration
Properties
Name Type Attributes Default Description
color string <optional>
rgba(255,170,0,0.5) the selection color
width number <optional>
10 the selection width for linear features
olStyle object | function <optional>
an openlayers style object or function
Source:
Returns:
a reference to the ol selection layer
Type
object

checkInit()

Check the initialization status and throw exception if not valid yet
Inherited From:
Source:

init(theMap)

map popup initialization
Parameters:
Name Type Description
theMap ol.Map the ol map
Overrides:
Source:

removeVectorPopup(lyr)

Parameters:
Name Type Description
lyr LayerBase layer
Source: