Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Object: esri/dijit/util/busyIndicator
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/util/busyIndicator"], function(busyIndicator) { /* code goes here */ });
Description
(Added at v3.13)
This module provides the ability to create a busy indicator for a target.Samples
Search for samples that use this class.Methods
| Name | Return type | Summary |
|---|---|---|
| create(target, params?) | Object | Creates a busy indicator on a target. |
Method Details
Creates a busy indicator on a target. If specifying the
target, then the params Object is optional. If the target if not included, then the params Object is required, and the params target must be specified. See the Object Specifications table below for the structure of the returned object handle.Return type:
ObjectParameters:
< |
Required | The String (Node id, dijit/_WidgetBase id), HTMLElement reference (Node), or dijit/_WidgetBase. The target parameter is required unless specified in the params object. |
< |
Optional | (Optional) The params options can be used when needing more fine-grained control. See the Object Specifications table below for the structure of the params object. |
Object Specifications:
<
params>< |
Required | Hex color of the background. Default is #ffffff. |
< |
Required | Background opacity. Default is 0.75. |
< |
Required | Time, in milliseconds, that the fade in/out should take. Default is 200 milliseconds. |
< |
Required | URL of the image to center in the overlay. Default is "loading-throb.gif". |
< |
Required | See the target parameter description for details. |
< |
Required | S-index for the indicator's overlay. Default is "auto", which will try to place the overlay at the top-most level. |
<
Object>Sample:
require([
"esri/dijit/util/busyIndicator", ...
], function(busyIndicator, ... ) {
var handle = busyIndicator.create("targetNodeId");
var handle = busyIndicator.create(targetNode);
var handle = busyIndicator.create("targetWidgetId");
var handle = busyIndicator.create(targetWidget);
var handle = busyIndicator.create({
target: targetNode,
imageUrl: "path/to/some/image",
fadeDuration: 200
});
});
See also: esri/domUtils.getNode()