Developers Knowledge Base

WebGIS enables powerful geospatial web applications and services that securely share your organization’s rich geospatial data, and provides tools to deeply examine spatial data and create value added products, on demand.
Showing results for 
Search instead for 
Do you mean 

Consumer Portal API vs Geospatial Portal API

by Technical Evangelist on ‎09-08-2015 01:06 AM - edited on ‎04-11-2017 03:54 AM by Technical Evangelist (1,158 Views)


Consumer Portal API provides a subset of Geospatial Portal API. The classes and methods available in Consumer Portal API reflect the features currently available in the Consumer Portal layout.



The $ interface manages coordinate reference system. It provides methods to change operating CRS as well as transform coordinates between different coordinate systems. Consumer Portal does not provide the concept of registering coordinate systems as it operates directly on the CRS definitions provided. Currently it does not support code mappings.


As currently the Consumer Portal does not provide FeatureInfo operation support, there is no featureInfoRequested event available for handling custom feature info actions. $


As a result, there is no featureInfo method on $ Moreover, as the map concept in Consumer Portal includes working either in 2D or 3D mode, there is no possibilty to setMode on the $ The map settings specific for the Geospatial Portal are also not applicable on the Consumer Portal, so there is no $ exposed.


Consumer Portal use the flat legend approach. In Geospatial Portal layout the legend was grouped in the tree structure, with map layer concept for the grouping nodes and legend items for the leafs. The legend item is the actual representation of view service layer. Thus in Consumer Portal all the legend items are the actual layers. $GP.legend


In the Consumer Portal all the services are directly in use for the end user, which simplifies the user workflows. In comparison to Geospatial Portal layout, there is no list of defined and not added services. With that concept, there is no point in registering the view services, as there just added to the map, which can be achieved by $GP.legend.

The $ in Consumer Portal API allows to operate (add or/and find already defined) on Search Services. They can be used either in UI or API mode, which is set by the activeSearchHandle parameter.

Consumer Portal introduces the concept of activeSearchHandle. This allows adding the Search Services in specific mode (either in UI or API mode) and running the Search action in one of them.

The Service representation is thus named as the Service class (formerly MapService).


Consumer Portal API provides search access point and a shortcut for specific searches.

Currently supported search types involves:

Name Search - including (apart of the default Search Services) the new Search types: WMPS Search, Backend Search and Custom Search. APOLLO Search ({searchType: "ApolloCatalog"}) - APOLLO Catalog Search

They can be used either in UI or API mode, which is set by the activeSearchHandle parameter.

Please note that APOLLO Search mechanism provides only free text search ability.

Scope changes

Detailed differences may be explored through the $GP API Docs. $GP API