API Functions & Events - Canadian Geospatial Platform Viewer

Showing active filters for layer path:

Initial filter

Class filter

Data filter

Time filter

All filters

API Functions:

cgpv.api.getMapViewer('map1').layer.addGeoviewLayer(config)
cgpv.api.getMapViewer('map1').layer.removeLayerUsingPath('geojsonLYR1/base-group')
cgpv.api.getMapViewer('map1').layer.removeAllGeoviewLayers()
cgpv.api.getMapViewer('map1').layer.setOrToggleLayerVisibility('esriFeatureLYR5/0')
cgpv.api.getMapViewer('map1').layer.setAllLayersVisibility(true)
cgpv.api.getMapViewer('map1').layer.setAllLayersVisibility(false)
cgpv.api.getMapViewer('map1').layer.setLayerName('uniqueValueId/1', 'Water Quantity')
cgpv.api.getMapViewer('map1').clickMarkerIconShow({lonlat: [-90, 60]})
cgpv.api.getMapViewer('map1').zoomToLonLatExtentOrCoordinate([-87.77486341686723, 51.62285357468582, -84.57727128084842, 53.833354975551075])
cgpv.api.getMapViewer('map1').zoomToLonLatExtentOrCoordinate([-90, 60])
cgpv.api.utilities.geo.extentToPolygon([-87.77486341686723, 51.62285357468582, -84.57727128084842, 53.83335497555107])
cgpv.api.utilities.geo.polygonToExtent(polygon)
cgpv.api.getMapViewer('map1').layer.redefineFeatureFields('geojsonLYR1/base-group/polygons.json', 'Province,DateCreated,Images', 'alias')
cgpv.api.getMapViewer('map1').footerBarApi.selectTab('details')
cgpv.api.getMapViewer('map1').appBarApi.selectTab('geolocator')
cgpv.api.getMapViewer('map1').layer.setLayerHoverable('esriFeatureLYR5/0', false) cgpv.api.getMapViewer('map1').layer.setLayerHoverable('esriFeatureLYR5/0', true)
cgpv.api.getMapViewer('map1').layer.setLayerQueryable('esriFeatureLYR5/0', false) cgpv.api.getMapViewer('map1').layer.setLayerQueryable('esriFeatureLYR5/0', true)
cgpv.api.getMapViewer('map1').stateApi.getLegendCollapsedState('f4c51eaa-a6ca-48b9-a1fc-b0651da20509/base-group');
cgpv.api.getMapViewer('map1').stateApi.setLegendCollapsedState('f4c51eaa-a6ca-48b9-a1fc-b0651da20509/base-group', !cgpv.api.getMapViewer('map1').stateApi.getLegendCollapsedState('f4c51eaa-a6ca-48b9-a1fc-b0651da20509/base-group'));
cgpv.api.getMapViewer('map1').getMapLayerOrderInfo()
cgpv.api.getMapViewer('map1').setLanguage('en') cgpv.api.getMapViewer('map1').setLanguage('fr')
const basemap = await cgpv.api.getMapViewer('map1').basemap.createCoreBasemap(basemapOptions = {basemapId: 'simple'}) cgpv.api.getMapViewer('map1').basemap.setBasemap(basemap)
cgpv.api.getMapViewer('map1').stateApi.setSelectedLayersTabLayer('nonmetalmines/5')
cgpv.api.getMapViewer('map1').plugins['swiper'].activateForLayer('nonmetalmines/5') cgpv.api.getMapViewer('map1').plugins['swiper'].deActivateForLayer('nonmetalmines/5')
cgpv.api.utilities.geo.calculateDistance(coordinates[], 'EPSG:4326', outProj)
cgpv.api.getMapViewer('map1').createMapConfigFromMapState()
cgpv.api.reloadWithCurrentState('map1')
cgpv.api.getMapViewer('map1').layer.featureHighlight.pointMarkers.addPointMarkers('group1', markers) cgpv.api.getMapViewer('map1').layer.featureHighlight.pointMarkers.removePointMarkersOrGroup('group1');
cgpv.api.getMapViewer('map1').layer.featureHighlight.pointMarkers.zoomToPointMarkers('group1', ['1', '3']);
cgpv.api.getMapViewer('map1').layer.featureHighlight.pointMarkers.zoomToPointMarkerGroup('group1');
cgpv.api.getMapViewer('map1').footerBarApi.createTab({id: 'test', label: 'My Custom Tab', content: '<br><div><ul><li>How to export map coordinate data to: GeoJSON, or CSV.</li></ul></div>'});
cgpv.api.getMapViewer('map1').layer.getGeoviewLayer('geojsonLYR1/base-group/polygons.json').getLayerFilters().getAllFilters(); cgpv.api.getMapViewer('map1').layer.getGeoviewLayer('geojsonLYR1/base-group/polygons.json').getLayerFilters().getInitialFilter(); cgpv.api.getMapViewer('map1').layer.getGeoviewLayer('geojsonLYR1/base-group/polygons.json').getLayerFilters().getClassFilter(); cgpv.api.getMapViewer('map1').layer.getGeoviewLayer('geojsonLYR1/base-group/polygons.json').getLayerFilters().getDataFilter(); cgpv.api.getMapViewer('map1').layer.getGeoviewLayer('geojsonLYR1/base-group/polygons.json').getLayerFilters().getTimeFilter(); cgpv.api.getMapViewer('map1').layer.getGeoviewLayer('geojsonLYR1/base-group/polygons.json').getLayerFilters().getFilterEquation();

Events that will generate notifications:

mapViewer.onMapLanguageChanged
mapViewer.onMapMoveEnd
mapViewer.onMapZoomEnd
mapViewer.basemap.onBasemapChanged
mapViewer.layer.onLayerConfigAdded when a layer config has been added
mapViewer.layer.onLayerConfigRemoved when a layer config has been removed
mapViewer.layer.onLayerConfigError when a layer config has an error
mapViewer.layer.onLayerCreated when a gv layer has been created
mapViewer.layer.onLayerFirstLoaded one time per layer on their first load
mapViewer.layer.onLayerLoading when a gv layer is loading on the map (this happens on every render)
mapViewer.layer.onLayerLoaded when a gv layer is loaded on the map (this can happen on every render)
mapViewer.layer.onLayerError when a gv layer has an error on the map (this can happen on every render)
mapViewer.layer.onLayerAllLoaded each time all layers are loaded/error (done loading) on the map (this happens on every render)
mapViewer.layer.onLayerVisibilityToggled
mapViewer.layer.onLayerItemVisibilityToggled
mapViewer.stateApi.onLayersReordered
layerEntryConfig.onLayerStatusChanged for Water Quantity
layer.onLayerFirstLoaded one time for Airborne quality
layer.onLayerLoaded each time Airborne quality layer goes in loaded state
layer.onLayerError each time Airborne quality layer goes in error state
layer.onVisibleChanged for Nonmetal mines
layer.onVisibleChanged for Water Quantity
layer.onLayerOpacityChanged for Water Quantity
layer.onLayerFilterApplied for Water Quantity

API Functions and Events

API Functions:

Events that will generate notifications: