ESM: import FocusAreas from "@arcgis/core/effects/FocusAreas.js";
CDN: const FocusAreas = await $arcgis.import("@arcgis/core/effects/FocusAreas.js");
Class: @arcgis/core/effects/FocusAreas
Since: ArcGIS Maps SDK for JavaScript 4.33
A collection of focus areas in a Map.
A focus area highlights a region of the map by de-emphasizing parts outside the area of interest. Two predefined styles, dark or bright are available, to choose a visualization with good contrast for scenes with different coloring. A focus area can have a colored outline, which is helpful to distinguish different focus areas in a map. Focus areas can be captured in slides and shared as part of a webscene.
Known Limitations
Example
// Adding a focus area to map.
const focusAreaPolygon = new Polygon({
spatialReference: { wkid: 102100 },
rings: [[
[1288603, 6130075],
[1288415, 6130021],
[1288459, 6130133],
[1288603, 6130075],
]],
});
const focusArea = new FocusArea({
outline: { color: [255, 128, 128, 0.55] },
geometries: new Collection([focusAreaPolygon]),
});
map.focusAreas.areas.add(focusArea);
map.focusAreas.style = "dark";
Constructors
new FocusAreas(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsA collection containing all focus areas.
Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className
.
The rendering style of the map, applied outside of all enabled focus areas.
This property can be either "bright" or "dark", with the default value set to "bright". When there is no enabled focus area on the map, the view renders normally.
Possible Values:"bright" |"dark"
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles
const handle = reactiveUtils.when(
() => !view.updating,
() => {
wkidSelect.disabled = false;
},
{ once: true }
);
this.addHandles(handle);
// Destroy the object
this.destroy();
Parameters
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
clone(){this}
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
Returns
Type Description this A deep clone of the class instance that invoked this method.Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
obj.removeHandles("watch-view-updates");
}
Inherited
Method removeHandles(groupKey)
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4