Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/opsdashboard
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: MapWidgetProxy
[ AMD Module Require | Legacy Module Require ]
require(["esri/opsdashboard/MapWidgetProxy"], function(MapWidgetProxy) { /* code goes here */ });
Description
(Added at v3.14)
(Currently in Mature Support) MapWidgetProxy is a proxy class that represents a operations dashboard map widget. Map widget instances cannot be directly instantiated. To get a particular data source, extension mixins functions getMapWidgetProxy or getMapWidgetProxies should be used.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| id | String | Read-only: The map id. |
| name | String | Read-only: The name of the map. |
| spatialReference | SpatialReference | Read-only: The spatial reference of the map. |
Methods
| Name | Return type | Summary |
|---|---|---|
| createGraphicsLayerProxy(options?) | Promise | Creates a graphics layer in the host map. |
| destroyGraphicsLayerProxy(graphicsLayerProxy) | None | Destroys in the host map a host graphics layer. |
| getMapExtent() | Promise | Gets the current host map extent. |
| panTo(mapPoint) | None | Pans the map to a new location. |
| setExtent(extent) | None | Sets an extent on the host map extent. |
| subscribeToMapEvents() | None | Subscribes to the host map events. |
| unsubscribeFromMapEvents() | None | Unsubscribes from the host map events. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| map-extent-change | {
extent: < | Event indicating that the host map extent has changed. |
Property Details
<String
StringRead-only: The map id.
<String
StringRead-only: The name of the map.
<SpatialReference
SpatialReferenceRead-only: The spatial reference of the map.
Method Details
Creates a graphics layer in the host map.
Return type:
PromiseParameters:
< |
Optional | The options for the new graphics layer |
Object Specifications:
<
graphicsLayerOptions>< |
Required | Maximum visible scale for the layer. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum visible scale. |
< |
Required | Minimum visible scale for the layer. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum visible scale. |
< |
Required | Opacity or transparency of layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency. |
< |
Required | The renderer for the host graphics layer. Since the Windows operations dashboard is built using ArcGIS Runtime SDK for WPF only renderers supported by the WPF should be used, such as SimpleRenderer, UniqueValueRenderer and ClassBreaksRenderer. |
< |
Required | Indicates if the graphics layer is visible or not. |
Destroys in the host map a host graphics layer.
Parameters:
< |
Required | The host graphics layer to destroy. |
Pans the map to a new location.
Parameters:
< |
Required | A new location with the same spatial reference as the host map. |
Sets an extent on the host map extent.
Parameters:
< |
Required | A new map extent. |
Subscribes to the host map events. For optimization purpose host map events are not automatically sent to extension map widgets. Currently only map extent changed is supported.
Unsubscribes from the host map events. For optimization purpose host map events are not automatically sent to extension map widgets. Currently only map extent changed is supported.
Event Details
[ On Style Events | Connect Style Event ]
Event indicating that the host map extent has changed.
Event Object Properties:
< |
The new map extent. |