The Zoom widget allows users to zoom in/out within a view.
An instance of the Zoom widget is available in every MapView and SceneView by default. See DefaultUI for details on how to place the Zoom widget in other parts of the view.
var view = new MapView({
container: "viewDiv",
map: map
});
var zoom = new Zoom({
view: view
});
Constructors
new Zoom(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
Name | Type | Summary | |
---|---|---|---|
String | HTMLElement | The ID or node representing the DOM element containing the widget. more details | more details | |
String | The name of the class. more details | more details | |
Boolean | When | more details | |
String | The unique ID assigned to the widget when the widget is created. more details | more details | |
MapView | SceneView | A reference to the MapView or SceneView. more details | more details | |
ZoomViewModel | The view model for this widget. more details | more details |
Property Details
containerString|HTMLElement
The ID or node representing the DOM element containing the widget. This property can only be set once.
declaredClassStringreadonly
The name of the class. The declared class name is formatted as
esri.folder.className
.destroyedBoolean
When
true
, this property indicates whether the widget has been destroyed.idString
The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.
viewModel autocast
The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the ZoomViewModel class to access all properties and methods on the widget.
Method Overview
Name | Return Type | Summary | |
---|---|---|---|
Destroys the widget instance. more details | more details | ||
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | more details | |
Object | Registers an event handler on the instance. more details | more details | |
Widget teardown helper. more details | more details | ||
This method is primarily used by developers when implementing custom widgets. more details | more details | ||
Object | This method is primarily used by developers when implementing custom widgets. more details | more details | |
Renders widget to the DOM immediately. more details | more details | ||
This method is primarily used by developers when implementing custom widgets. more details | more details | ||
Finalizes the creation of the widget. more details | more details | ||
Zooms the view in by an LOD factor of 0.5. more details | more details | ||
Zooms the view out by an LOD factor of 2. more details | more details |
Method Details
destroy()inherited
Destroys the widget instance.
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameter:type StringThe name of the event.
Returns:Type Description Boolean Returns true if the class supports the input event. Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.
Parameters:type StringThe name of event to listen for.
listener FunctionThe function to call when the event is fired.
Returns:Type Description Object Returns an event handler with a remove()
method that can be called to stop listening for the event.Property Type Description remove Function When called, removes the listener from the event. - See also:
Example:view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
own(handles)inherited
Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.
Parameter:handles Handle[]@type - handles to remove when destroyed
postInitialize()inherited
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
Returns:Type Description Object The rendered virtual node. renderNow()inherited
Renders widget to the DOM immediately.
scheduleRender()inherited
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.
- Deprecated
startup()inherited
- since version 4.2.
Finalizes the creation of the widget.
zoomIn()
Zooms the view in by an LOD factor of 0.5.
zoomOut()
Zooms the view out by an LOD factor of 2.