README.md

Control for OpenLayers to manage popups of features

FeaturePopups wraps the management of popups and SelectFeature control of OpenLayers.

Please, open a issue if you have questions or problems using this control.

Operation:

Assign templates to the layers is the only requirement to display popups.

Example:

    ...
    var myLayer = new OpenLayers.Layer.Vector("My layer", {...}); 
    ...
    var fpControl = new OpenLayers.Control.FeaturePopups();
    fpControl.addLayer(mylayer, {
        templates: {
            single: "<h2>${.name}</h2>${.description}"
            // .name is attributes.name on features, and so on.
        }
    });
    map.addControl(fpControl);
    ...

The control shows two types of selection popups: single feature or features list (with two or more features). Into a list of features can be seen each feature in a single popup.

It also supports hover popups (both kinds single feature and features list) simultaneously with the selection

Examples:

Using the control and templates to display popups:

• Multi layer, multi selection and uses Strategy.Cluster: feature-popups.html
• The lists of features are displayed outside the map div: feature-popups-external.html
• Mixed: some lists of features are displayed as standard (FramedCloud) another outside the map div: feature-popups-mixed.html

Grids to show feature attributes using FeaturePopups:

• grid-jqGrid-features.html (uses jqGrid to show features and highlight the selection)
• grid-jqGrid-selection.html (uses jqGrid to show the selection)
• grid-SlickGrid-features.html (uses SlickGrid to show features and highlight the selection)
• grid-SlickGrid-selection.html (uses SlickGrid to show the selection)

Adaptation of OpenLayers examples to use FeaturePopups:

• georss-flickr-FP.html (custom templates instead of onSelect function, code simpler)
• highlight-feature-FP.html (two controls in one!)
• strategy-cluster-FP.html (don't use "Jugl.js" and uses "popupdisplayed" event instead of "featureselected")
• sundials-FP.html (custom templates instead of onFeatureXxxxx functions, code simpler)

Adaptation of GeoExt examples to use FeaturePopups and GeoExt popups:

• popup-auto-position-FP.html (uses custom popups)

Features:

• Prepare the contents of the popup using templates.
  • Templates as strings or functions.
  • Allows internationalization of the labels in templates.
• Show popups by selection (click) or hover from multiple vector layers.
• Multiple selection using box and show list of features selected into an popup.
• Proper popups on clustered features (OpenLayers.Strategy.Cluster)
• Safe selection: Features remain selected even after zooming or moving the map (using Cluster and BBOX strategies)
• Safe selection also allows that clickout not fails after a zoom (using Cluster or BBOX strategies)
• Triggers appropriate events when changing the selection or a layer features (to prevent flickering or other nuisances, events are triggered only if there has been an effective change)
• By default:
  • Multi selection is enabled,
  • hover popups follows the cursor (to prevent flickering)
  • select popups are shown where the cursor is pressed.
• Ability to customize the operation of the control.
• Allow simultaneously display "list" and "itemList" popups without much overlap.

Documentation:

• API for users
• For developers all elements

Adjustments on OL popups for proper calculation of the autosize

Have been proposed to OpenLayers team a set of patches to fix some autosize issues. These patches are grouped all in a code to can use these patches also in releases 2.11 and 2.12, see: lib/patches_OL-popup-autosize.js

The problems were fixed:

• Remove extra padding: autoSize-padding-dev.html
• Narrow content when displaying scroll bar: popups-overflow-dev.html
• Adjust the insertion point using FramedCloud popup: popups-FramedCloud-insertion-point.html
• Avoid breaking the "OpenLayers.String.format" execution #OL-631

Patches to fix other problems not yet proposed to OL, but applied in this code:

• Chrome+ABP does not consider the size of images: popups-img-chrome-dev.html
• Consider the border on contentDisplayClass: autoSize-padding-dev.html
• Margin should be considered when padding on contentDisplayClass is zero: popups-margin-dev.html

Compatibility with OpenLayers releases:

The FeaturePopups v0.9.0 or higer works correctly with releases from 2.11 to 2.13.1 and whith development version. This also includes patches for OL grouped in lib/patches_OL-popup-autosize.js.