OpenLayers.Control.FeaturePopups.Popup

Summary
OpenLayers.Control.FeaturePopups.Popup
Properties
events{<OpenLayers.Events>} Events instance for listeners and triggering specific events.
Constants
EVENT_TYPESOnly required to use OpenLayers.Control.FeaturePopups with 2.11 or less
Properties
eventListeners{Object} If set on options at construction, the eventListeners object will be registered with <OpenLayers.Events.on>.
type{String} Type of popup manager, read only.
popupClass{String|<OpenLayers.Popup>|Function} Type of popup to manage.
anchor{Object} Object to which we’ll anchor the popup.
minSize{<OpenLayers.Size>} Minimum size allowed for the popup’s contents.
maxSize{<OpenLayers.Size>} Maximum size allowed for the popup’s contents.
unselectFunction{Function} Closing a popup all features are unselected using this function (used only if is not null)
closeBox{Boolean} To display a close box inside the popup.
panMapIfOutOfView{Boolean} When drawn, pan map such that the entire popup is visible in the current viewport (if necessary).
Constructor
OpenLayers.Control.FeaturePopups.PopupThis class is a handler that is responsible for displaying and clear the one kind of popups managed by a OpenLayers.Control.FeaturePopups.
Functions
destroy
clearClear the popup and related popups.

Properties

events

{<OpenLayers.Events>} Events instance for listeners and triggering specific events.

Supported event types

beforepopupdisplayedTriggered before a popup is displayed.  To stop the popup from being displayed, a listener should return false.  Receives an event with: “selection” a selection object (except for the “list” popup is an array of selection objects), “html” the html of the popup content (alter the html is allowed) Selection objects have three keys, “layerObj” (the FeaturePopups.Layer manager of the layer), “layer” (the layer) and “features” or “feature” (the singular key “feature” is used only for popupType: “single”, “hover” or “listItem”)
popupdisplayedTriggered after a popup is displayed.  Receives an event with; “selection” (with the same structure described in the event “beforepopupdisplayed”), “div” the DOMElement used by the popup.
closedbyboxTriggered after close a popup using close box.  Receives an event with “popupType” see Constructor

Constants

EVENT_TYPES

Only required to use OpenLayers.Control.FeaturePopups with 2.11 or less

Properties

eventListeners

{Object} If set on options at construction, the eventListeners object will be registered with <OpenLayers.Events.on>.  Object structure must be a listeners object as shown in the example for the events.on method.

type

{String} Type of popup manager, read only.

popupClass

{String|<OpenLayers.Popup>|Function} Type of popup to manage.

anchor

{Object} Object to which we’ll anchor the popup.  Must expose a ‘size’ (<OpenLayers.Size>) and ‘offset’ (<OpenLayers.Pixel>).

minSize

{<OpenLayers.Size>} Minimum size allowed for the popup’s contents.

maxSize

{<OpenLayers.Size>} Maximum size allowed for the popup’s contents.

unselectFunction

{Function} Closing a popup all features are unselected using this function (used only if is not null)

closeBox

{Boolean} To display a close box inside the popup.

panMapIfOutOfView

{Boolean} When drawn, pan map such that the entire popup is visible in the current viewport (if necessary).  Default is true.

Constructor

OpenLayers.Control.FeaturePopups.Popup

This class is a handler that is responsible for displaying and clear the one kind of popups managed by a OpenLayers.Control.FeaturePopups.

The manager popup can handle three types of popups: a div a OpenLayers.Popup class or a custom popup, it depends on the type of “popupClass” argument.

Parameters

environments{OpenLayers.Control.FeaturePopups}|Array() The control that initialized this popup manager, if array first item must be the control.
popupType{String} Type of popup manager: “list”, “single”, “listItem” “hover” or “hoverList”
options{Object}

Valid ptions

eventListeners{Object} Listeners to register at object creation.
minSize{<OpenLayers.Size>} Minimum size allowed for the popup’s contents.
maxSize{<OpenLayers.Size>} Maximum size allowed for the popup’s contents.
popupClass{String|<OpenLayers.Popup>|Function} Type of popup to manage: string for a “id” of a DOMElement, OpenLayers.Popup and a function for a custom popup. anchor -{Object} Object to which we’ll anchor the popup.  Must expose a ‘size’ (<OpenLayers.Size>) and ‘offset’ (<OpenLayers.Pixel>).
followCursor{Boolean} If true, the popup will follow the cursor (useful for hover)
unselectFunction{Function} Closing a popup all features are unselected using this function (used only if is not null)
closeBox{Boolean} To display a close box inside the popup.
observeItems{Boolean} If true, will be activated observers of the DOMElement of the popup to trigger some events (mostly by list popups).
relatedToClearArray({String})|Array(Array({String})) Related <FeaturePopups.popupObjs> codes from <environments> to clear.
relatedSimultaneous{Object} Object with two keys: “axis” key is the axis on which to display the two popups (valid values are “h” or “v”) and “related” key is a code of <FeaturePopups.popupObjs> from <control> to show simultaneously without much overlap. panMapIfOutOfView -{Boolean} When drawn, pan map such that the entire popup is visible in the current viewport (if necessary), default is true.

Functions

destroy

destroy: function()

clear

clear: function()

Clear the popup and related popups.

Extend of FeaturePopups control
destroy: function()
clear: function()
Clear the popup and related popups.
Close