Class: GeognoSISOverlayGetter

Cadcorp.Util.GeognoSISOverlayGetter

Exhaustively searches for every GeognoSIS Overlay on an {OpenLayers.Map} object. Helps deal with the async nature of {Cadcorp.OpenLayers.Layer.GeognoSISRest} getLayers method.

Constructor

new GeognoSISOverlayGetter()

Create a new instance of GeognoSISLayerGetter.
Example

Initialise and getOverlays

var getter = new Cadcorp.Util.GeognoSISOverlayGetter({callback: function(overlays) { console.log("Here are all the overlays:"); console.log(overlays); }, failureCallback: function(error) { console.log(error); }});
var layers = Cadcorp.theMap.getLayersByClass('Cadcorp.OpenLayers.Layer.GeognoSISRest');
getter.getOverlays(layers);

Members

callback

Properties:
Name Type Attributes Default Description
callback Cadcorp.Util.GeognoSISOverlayGetter.GetOverlaysSuccessCallback <optional>
 null Optional callback.

failureCallback

Properties:
Type Description
Cadcorp.Util.GeognoSISOverlayGetter.GetOverlaysFailureCallback

geognosisLayers

Properties:
Name Type Description
Array Array.<Cadcorp.OpenLayers.Layer.GeognoSISRest> of GeognoSISRest layers to search for Overlays.

Methods

getOverlays()

Get all {Cadcorp.GeognoSIS.Overlay} on all {Cadcorp.OpenLayers.Layer.GeognoSISRest}.

Type Definitions

GetOverlaysSuccessCallback(All)

A success callback called when all GeognoSISRest Layers have been queried.
Parameters:
Name Type Description
All Array.<Cadcorp.GeognoSIS.Overlay> GeognoSIS Overlays on a given {OpenLayers.Map} object.

GetOverlaysFailureCallback()