ArcGIS API for JavaScript ^3.26

require(["esri/opsdashboard/MapToolProxy"], function(MapToolProxy) { /* code goes here */ });

(Currently in Mature Support) MapToolProxy is a class used to define an operations dashboard extension map tool. MapToolProxy can be directly instantiated to communicate with the host operations dashboard application or used as a mixin in a Dojo or Dijit class, see declare. When the proxy is instantiated, it will automatically start an initialization process with the the host operations dashboard. If the initialization is successful, the event host-ready will be fired, or if using as a mixin, the function hostReady will be called. It's only when the initialization is finished that configuration properties, functions to communicate with the host will be available, and host's events will be fired. If an error occured during the initialization process, the event initialization-error is fired, or for mixin the function hostInitializationError is called, passing the error as argument.

A map tool has two parts a) a tool placed on a map widget default toolbar b) when activated a user experience on the map widget. The icon for a) can be defined in the extension manifest. MapToolProxy is used to define b). For optimization purpose, a map tool extension is loaded when the corresponding tool has been activated and unloaded when the tool is deactivated. If a state has to be preserved in between to activation/deactivation, an object containing state properties can be passed to the function deactivateMapTool. For an extension MapTool, configuration properties can be captured automatically by using manifest configuration properties and additional properties can be captured if a MapTool configuration user experience is provided.

Example 1: Used as a mixin in dijit class

require([
  "dojo/_base/declare",
  "dijit/_WidgetBase",
  "dijit/_TemplatedMixin",
  "esri/opsdashboard/MapToolProxy"
], function(declare, _WidgetBase, _TemplatedMixin, MapToolProxy){
  return declare("MyMapToolExtension", [_WidgetBase, _TemplatedMixin, MapToolProxy], {
    templateString: "<div>hello operation dashboard</div>",
    hostReady: function(){
      this.setDisplaySize({
        width: 200,
        height: 200
      });
      var configProperty = this.propertyIWantoSave;
    },
    onDeactivateButtonClick: function(){
      this.deactivateMapTool();
    }
  });
});

Example 2: Used as plain proxy object

require([
  "esri/opsdashboard/MapToolProxy"
], function(MapToolProxy){
  var proxy = new MapToolProxy();
  proxy.on("host-ready", function(){
    this.setDisplaySize({
      width: 200,
      height: 200
    });
    var configProperty = this.propertyIWantoSave;
  });
  closeButton.on("click", function(){
    proxy.deactivateMapTool();
  });
});

An extension is defined by the json manifest file. Some configuration properties could or could not be available based on the manifest properties. The same is applicable to functions and callbacks exposed by the mixin (see the manifest documentation).

See also

{
  size: <Object>
}

{
  geometry: <Geometry>
}