ArcGIS API for JavaScript ^3.26

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

(Currently in Mature Support) WidgetProxy is a class used to define an operations dashboard extension widget. WidgetProxy 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 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 widget is a user experience area in the host operation view. A widget is instantiated when the operation view is loaded and it is destroyed when the operation view is closed. Configuration properties for a widget can be captured when the publisher decides to publish a particular widget in the operation view. For an extension widget, configuration properties can be captured automatically by using manifest configuration properties and additional properties can be captured if a widget configuration user experience is provided.

Example 1: Used as a mixin in dijit class

define([
  "dojo/_base/declare",
  "dijit/_WidgetBase",
  "dijit/_TemplatedMixin",
  "esri/opsdashboard/WidgetProxy"
], function(declare, _WidgetBase, _TemplatedMixin, WidgetProxy){
  return declare("MyWidgetExtension", [_WidgetBase, _TemplatedMixin, WidgetProxy], {
    templateString: "<div>hello operation dashboard</div>",
    hostReady: function(){
    var configProperty = this.propertyIWantoSave;
    },
    dataSourceExpired: function(dataSourceProxy, dataSourceConfig){}
  });
});

Example 2: Used as plain proxy object

require([
  "esri/opsdashboard/WidgetProxy"
], function(WidgetProxy){
  var proxy = new WidgetProxy();
  proxy.on("host-ready", function(){
    var configProperty = this.propertyIWantoSave;
  });
  proxy.on("data-source-expired", function(dataSourceProxy, dataSourceConfig){});
});

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

esri/opsdashboard/ExtensionBase
|_esri/opsdashboard/WidgetProxy

{
  dataSourceProxy: <Object>
}

{
  dataSourceConfig: <Object>,
  dataSourceProxy: <DataSourceProxy>
}

{
  dataSourceId: <String>
}

{
  error: <Error>
}

{
  mapWidgetProxy: <MapWidgetProxy>
}

{
  mapWidgetId: <String>
}

{
  geometry: <Geometry>
}