API Functions and Events

API Functions:

• Add WMS layer
  cgpv.api.getMapViewer('map1').layer.addGeoviewLayer(config)
• Remove GeoJSON layer
  cgpv.api.getMapViewer('map1').layer.removeLayerUsingPath('geojsonLYR1/base-group')
• Remove All layers
  cgpv.api.getMapViewer('map1').layer.removeAllGeoviewLayers()
• Toggle Top 100 visibility
  cgpv.api.getMapViewer('map1').layer.setOrToggleLayerVisibility('esriFeatureLYR5/0')
• Set all layers visible
  cgpv.api.getMapViewer('map1').layer.setAllLayersVisibility(true)
• Set all layers not visible
  cgpv.api.getMapViewer('map1').layer.setAllLayersVisibility(false)
• Rename Water Quantity layer
  cgpv.api.getMapViewer('map1').layer.setLayerName('uniqueValueId/1', 'Water Quantity')
• Place a marker on map
  cgpv.api.getMapViewer('map1').clickMarkerIconShow({lonlat: [-90, 60]})
• Zoom to an extent
  cgpv.api.getMapViewer('map1').zoomToLonLatExtentOrCoordinate([-87.77486341686723, 51.62285357468582, -84.57727128084842, 53.833354975551075])
• Zoom to a coordinate
  cgpv.api.getMapViewer('map1').zoomToLonLatExtentOrCoordinate([-90, 60])
• Convert an extent to a polygon (result in console)
  cgpv.api.utilities.geo.extentToPolygon([-87.77486341686723, 51.62285357468582, -84.57727128084842, 53.83335497555107])
• Convert a polygon to an extent (result in console)
  cgpv.api.utilities.geo.polygonToExtent(polygon)
• Redefine alias fields for polygons layer
  cgpv.api.getMapViewer('map1').layer.redefineFeatureFields('geojsonLYR1/base-group/polygons.json', 'Location Province,Date Created,Images', 'alias')
• Open details tab in footer
  cgpv.api.getMapViewer('map1').footerBarApi.selectTab('details')
• Open geolocator in app bar
  cgpv.api.getMapViewer('map1').appBarApi.selectAppBarTab('AppbarPanelButtonGeolocator', 'geolocator')
• Disable hover query for Top 100Enable hover query for Top 100
  cgpv.api.getMapViewer('map1').layer.hoverFeatureInfoLayerSet.disableHoverListener('esriFeatureLYR5/0')
  cgpv.api.getMapViewer('map1').layer.hoverFeatureInfoLayerSet.enableHoverListener('esriFeatureLYR5/0')
• Disable feature query for Top 100Enable feature query for Top 100
  cgpv.api.getMapViewer('map1').layer.featureInfoLayerSet.disableClickListener('esriFeatureLYR5/0')
  cgpv.api.getMapViewer('map1').layer.featureInfoLayerSet.enableClickListener('esriFeatureLYR5/0')
• Show collapsed legend state for Water Quantity
  cgpv.api.getMapViewer('map1').stateApi.getLegendCollapsedState('uniqueValueId/1');
• Toggle legend collapsed state for Water Quantity
  cgpv.api.getMapViewer('map1').stateApi.setLegendCollapsedState('uniqueValueId/1');
• Show layer info
  cgpv.api.getMapViewer('map1').getMapLayerOrderInfo()
• Change language to EnglishChange language to French
  cgpv.api.getMapViewer('map1').setLanguage('en')
  cgpv.api.getMapViewer('map1').setLanguage('fr')
• Change basemap
  const basemap = await cgpv.api.getMapViewer('map1').basemap.createCoreBasemap(basemapOptions = {basemapId: 'simple'})
  cgpv.api.getMapViewer('map1').basemap.setBasemap(basemap)
• Set selected layer in layers panel to Nonmetal mines
  cgpv.api.getMapViewer('map1').stateApi.setSelectedLayersTabLayer('nonmetalmines/5')
• Add Nonmetal mines to swiperRemove Nonmetal mines from swiper
  cgpv.api.getMapViewer('map1').plugins['swiper'].activateForLayer('nonmetalmines/5')
  cgpv.api.getMapViewer('map1').plugins['swiper'].deActivateForLayer('nonmetalmines/5')
• Calculate distance LCCWeb Mercator
  cgpv.api.utilities.geo.calculateDistance(coordinates[], 'EPSG:4326', outProj)
• Get config with current state (in console)
  cgpv.api.getMapViewer('map1').createMapConfigFromMapState()
• Reload map with current state
  cgpv.api.getMapViewer('map1').reloadWithCurrentState()
• Add markers to mapRemove markers from map
  cgpv.api.getMapViewer('map1').layer.featureHighlight.pointMarkers.addPointMarkers('group1', markers)
  cgpv.api.getMapViewer('map1').layer.featureHighlight.pointMarkers.removePointMarkersOrGroup('group1');
• Zoom to markers 1 and 3
  cgpv.api.getMapViewer('map1').layer.featureHighlight.pointMarkers.zoomToPointMarkers('group1', ['1', '3']);
• Zoom to marker group
  cgpv.api.getMapViewer('map1').layer.featureHighlight.pointMarkers.zoomToPointMarkerGroup('group1');
• Create a custom tab in footer
  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>'});

Events that will generate notifications:

• cgpv.api.onMapAddedToDiv
• 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